<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="The official Invidious documentation">
<meta name="author" content="The Invidious project.">
<link rel="canonical" href="https://docs.invidious.io/Installation/">
<link rel="icon" href="../images/favicon.ico">
<meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.2.5">
<title>Installation - Invidious Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.2d9f7617.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
<meta name="theme-color" content="#000000">
<script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="black" data-md-color-accent="">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#installation" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Invidious Documentation" class="md-header__button md-logo" aria-label="Invidious Documentation" data-md-component="logo">
<img src="../images/invidious.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Invidious Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Installation
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Invidious Documentation" class="md-nav__button md-logo" aria-label="Invidious Documentation" data-md-component="logo">
<img src="../images/invidious.png" alt="logo">
</a>
Invidious Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
HOME
</a>
</li>
<li class="md-nav__item">
<a href="../API/" class="md-nav__link">
API
</a>
</li>
<li class="md-nav__item">
<a href="../Always-use-%22local%22-to-proxy-video-through-the-server-without-creating-an-account/" class="md-nav__link">
Always-use-"local"-to-proxy-video-through-the-server-without-creating-an-account
</a>
</li>
<li class="md-nav__item">
<a href="../Apache2-Reverse-Proxy/" class="md-nav__link">
Apache2-Reverse-Proxy
</a>
</li>
<li class="md-nav__item">
<a href="../Apache2-reverse-proxy/" class="md-nav__link">
Apache2-reverse-proxy
</a>
</li>
<li class="md-nav__item">
<a href="../Authenticated-Endpoints/" class="md-nav__link">
Authenticated-Endpoints
</a>
</li>
<li class="md-nav__item">
<a href="../Configuration/" class="md-nav__link">
Configuration
</a>
</li>
<li class="md-nav__item">
<a href="../Database-Information-and-Maintenance/" class="md-nav__link">
Database-Information-and-Maintenance
</a>
</li>
<li class="md-nav__item">
<a href="../Export-YouTube-subscriptions/" class="md-nav__link">
Export-YouTube-subscriptions
</a>
</li>
<li class="md-nav__item">
<a href="../Extensions/" class="md-nav__link">
Extensions
</a>
</li>
<li class="md-nav__item">
<a href="../FAQ/" class="md-nav__link">
Frequently Asked Questions
</a>
</li>
<li class="md-nav__item">
<a href="../Geoblocking%2C-available-video-quality-and-DASH/" class="md-nav__link">
Geoblocking,-available-video-quality-and-DASH
</a>
</li>
<li class="md-nav__item">
<a href="../How-to-deal-with-uMatrix/" class="md-nav__link">
How-to-deal-with-uMatrix
</a>
</li>
<li class="md-nav__item">
<a href="../How-to-setup-Anti-Captcha/" class="md-nav__link">
How-to-setup-Anti-Captcha
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Installation
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Installation
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#automated-installation" class="md-nav__link">
Automated Installation
</a>
</li>
<li class="md-nav__item">
<a href="#docker" class="md-nav__link">
Docker
</a>
<nav class="md-nav" aria-label="Docker">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docker-compose-method-production" class="md-nav__link">
Docker-compose method (production)
</a>
</li>
<li class="md-nav__item">
<a href="#docker-compose-method-development" class="md-nav__link">
Docker-compose method (development)
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#manual-installation" class="md-nav__link">
Manual Installation
</a>
<nav class="md-nav" aria-label="Manual Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#linux" class="md-nav__link">
Linux
</a>
<nav class="md-nav" aria-label="Linux">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#install-crystal" class="md-nav__link">
Install Crystal
</a>
</li>
<li class="md-nav__item">
<a href="#install-the-dependencies" class="md-nav__link">
Install the dependencies
</a>
</li>
<li class="md-nav__item">
<a href="#add-an-invidious-user-and-clone-the-repository" class="md-nav__link">
Add an Invidious user and clone the repository
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-postgressql" class="md-nav__link">
Set up PostgresSQL
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-invidious" class="md-nav__link">
Set up Invidious
</a>
</li>
<li class="md-nav__item">
<a href="#systemd-service" class="md-nav__link">
Systemd service
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#macos" class="md-nav__link">
MacOS
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-install-configuration" class="md-nav__link">
Post-install configuration:
</a>
</li>
<li class="md-nav__item">
<a href="#update-invidious" class="md-nav__link">
Update Invidious
</a>
<nav class="md-nav" aria-label="Update Invidious">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#updating-a-docker-install" class="md-nav__link">
Updating a Docker install
</a>
</li>
<li class="md-nav__item">
<a href="#update-a-manual-install" class="md-nav__link">
Update a manual install
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
Usage:
</a>
<nav class="md-nav" aria-label="Usage:">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#logrotate-configuration" class="md-nav__link">
Logrotate configuration
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../Invidious-Instances/" class="md-nav__link">
Invidious-Instances
</a>
</li>
<li class="md-nav__item">
<a href="../Issues-with-CAPTCHA-on-Debian-and-Ubuntu/" class="md-nav__link">
Issues-with-CAPTCHA-on-Debian-and-Ubuntu
</a>
</li>
<li class="md-nav__item">
<a href="../Known-Exception-in-log/" class="md-nav__link">
Known-Exception-in-log
</a>
</li>
<li class="md-nav__item">
<a href="../List-of-URL-parameters/" class="md-nav__link">
List-of-URL-parameters
</a>
</li>
<li class="md-nav__item">
<a href="../NGINX-Reverse-Proxy/" class="md-nav__link">
NGINX-Reverse-Proxy
</a>
</li>
<li class="md-nav__item">
<a href="../Preferences/" class="md-nav__link">
Preferences
</a>
</li>
<li class="md-nav__item">
<a href="../Search-operators/" class="md-nav__link">
Search-operators
</a>
</li>
<li class="md-nav__item">
<a href="../Takedowns/" class="md-nav__link">
DMCA
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#automated-installation" class="md-nav__link">
Automated Installation
</a>
</li>
<li class="md-nav__item">
<a href="#docker" class="md-nav__link">
Docker
</a>
<nav class="md-nav" aria-label="Docker">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docker-compose-method-production" class="md-nav__link">
Docker-compose method (production)
</a>
</li>
<li class="md-nav__item">
<a href="#docker-compose-method-development" class="md-nav__link">
Docker-compose method (development)
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#manual-installation" class="md-nav__link">
Manual Installation
</a>
<nav class="md-nav" aria-label="Manual Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#linux" class="md-nav__link">
Linux
</a>
<nav class="md-nav" aria-label="Linux">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#install-crystal" class="md-nav__link">
Install Crystal
</a>
</li>
<li class="md-nav__item">
<a href="#install-the-dependencies" class="md-nav__link">
Install the dependencies
</a>
</li>
<li class="md-nav__item">
<a href="#add-an-invidious-user-and-clone-the-repository" class="md-nav__link">
Add an Invidious user and clone the repository
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-postgressql" class="md-nav__link">
Set up PostgresSQL
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-invidious" class="md-nav__link">
Set up Invidious
</a>
</li>
<li class="md-nav__item">
<a href="#systemd-service" class="md-nav__link">
Systemd service
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#macos" class="md-nav__link">
MacOS
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-install-configuration" class="md-nav__link">
Post-install configuration:
</a>
</li>
<li class="md-nav__item">
<a href="#update-invidious" class="md-nav__link">
Update Invidious
</a>
<nav class="md-nav" aria-label="Update Invidious">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#updating-a-docker-install" class="md-nav__link">
Updating a Docker install
</a>
</li>
<li class="md-nav__item">
<a href="#update-a-manual-install" class="md-nav__link">
Update a manual install
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
Usage:
</a>
<nav class="md-nav" aria-label="Usage:">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#logrotate-configuration" class="md-nav__link">
Logrotate configuration
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="installation">Installation</h1>
<p>Compiling Invidious requires at least 2GB of free RAM (We recommend to have at least 3GB installed).
If you have less (e.g on a cheap VPS) you can setup a SWAP file or partition, so the combined amount is >= 3GB.</p>
<p>After installation take a look at the <a href="#post-install-configuration">Post-install steps</a>.</p>
<p>Note: Any <a href="https://en.wikipedia.org/wiki/Platform_as_a_service">PaaS</a> or <a href="https://en.wikipedia.org/wiki/Software_as_a_service">SaaS</a> provider/software (Heroku, YunoHost, Repli...) are unsupported. Use them at your own risk. They <strong>WILL</strong> cause problems with Invidious and might even suspend your account for "abuse" since Invidious is heavy, bandwidth intensive and technically a proxy (and most providers don't like them). If you use one and want to report an issue, please mention which one you use.</p>
<h2 id="automated-installation">Automated Installation</h2>
<p><a href="https://github.com/tmiland/Invidious-Updater">Invidious-Updater</a> is a self-contained script that can automatically install and update Invidious.</p>
<h2 id="docker">Docker</h2>
<blockquote>
<p>The Invidious docker image is only <a href="https://quay.io/repository/invidious/invidious">available on Quay</a> because, unlike Docker Hub, <a href="https://github.com/quay/quay/blob/master/LICENSE">Quay is Free and Open Source Software</a>. This is reflected in the <code>docker-compose.yml</code> file used in this walk-through.{.is-warning}</p>
</blockquote>
<p>Ensure <a href="https://docs.docker.com/engine/install">Docker Engine</a> and <a href="https://docs.docker.com/compose/install">Docker Compose</a> are installed before beginning.</p>
<h3 id="docker-compose-method-production">Docker-compose method (production)</h3>
<p><strong>This method uses the pre-built Docker image from quay</strong></p>
<p>Note: Currently the repository has to be cloned, this is because the <code>init-invidious-db.sh</code> file and the <code>config/sql</code> directory have to be mounted to the postgres container (See the volumes section in the docker-compose file below). This "problem" will be solved in the future.</p>
<pre><code class="language-bash">git clone https://github.com/iv-org/invidious.git
cd invidious
</code></pre>
<p>Edit the docker-compose.yml with this content:</p>
<pre><code class="language-docker">version: "3"
services:
invidious:
image: quay.io/invidious/invidious:latest
# image: quay.io/invidious/invidious:latest-arm64 # ARM64/AArch64 devices
restart: unless-stopped
ports:
- "127.0.0.1:3000:3000"
environment:
# Please read the following file for a comprehensive list of all available
# configuration options and their associated syntax:
# https://github.com/iv-org/invidious/blob/master/config/config.example.yml
INVIDIOUS_CONFIG: |
db:
dbname: invidious
user: kemal
password: kemal
host: invidious-db
port: 5432
check_tables: true
# external_port:
# domain:
# https_only: false
# statistics_enabled: false
healthcheck:
test: wget -nv --tries=1 --spider http://127.0.0.1:3000/api/v1/comments/jNQXAC9IVRw || exit 1
interval: 30s
timeout: 5s
retries: 2
depends_on:
- invidious-db
invidious-db:
image: docker.io/library/postgres:14
restart: unless-stopped
volumes:
- postgresdata:/var/lib/postgresql/data
- ./config/sql:/config/sql
- ./docker/init-invidious-db.sh:/docker-entrypoint-initdb.d/init-invidious-db.sh
environment:
POSTGRES_DB: invidious
POSTGRES_USER: kemal
POSTGRES_PASSWORD: kemal
healthcheck:
test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
volumes:
postgresdata:
</code></pre>
<p>Note: This compose is made for a true "production" setup, where Invidious is behind a reverse proxy. If you prefer to directly access Invidious, replace <code>127.0.0.1:3000:3000</code> with <code>3000:3000</code> under the <code>ports:</code> section.</p>
<blockquote>
<p>The environment variable <code>POSTGRES_USER</code> cannot be changed. The SQL config files that run the initial database migrations are hard-coded with the username <code>kemal</code>.
{.is-warning}</p>
</blockquote>
<h3 id="docker-compose-method-development">Docker-compose method (development)</h3>
<p><strong>This method builds a Docker image from source</strong></p>
<pre><code class="language-bash">git clone https://github.com/iv-org/invidious.git
cd invidious
docker-compose up
</code></pre>
<h2 id="manual-installation">Manual Installation</h2>
<h3 id="linux">Linux</h3>
<h4 id="install-crystal">Install Crystal</h4>
<p>Follow the instructions for your distribution here: <a href="https://crystal-lang.org/install/">https://crystal-lang.org/install/</a></p>
<h4 id="install-the-dependencies">Install the dependencies</h4>
<p>Arch Linux</p>
<pre><code class="language-bash">sudo pacman -S base-devel librsvg postgresql
</code></pre>
<p>Debian/Ubuntu</p>
<pre><code class="language-bash">sudo apt install libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev postgresql librsvg2-bin libsqlite3-dev zlib1g-dev libpcre3-dev libevent-dev
</code></pre>
<p>RHEL based and RHEL-like systems (RHEL, Fedora, AlmaLinux, RockyLinux...)</p>
<pre><code class="language-bash">sudo dnf install -y openssl-devel libevent-devel libxml2-devel libyaml-devel gmp-devel readline-devel postgresql librsvg2-devel sqlite-devel zlib-devel gcc
</code></pre>
<h4 id="add-an-invidious-user-and-clone-the-repository">Add an Invidious user and clone the repository</h4>
<pre><code class="language-bash">useradd -m invidious
su - invidious
git clone https://github.com/iv-org/invidious
exit
</code></pre>
<h4 id="set-up-postgressql">Set up PostgresSQL</h4>
<pre><code class="language-bash">systemctl enable --now postgresql
sudo -i -u postgres
psql -c "CREATE USER kemal WITH PASSWORD 'kemal';" # Change 'kemal' here to a stronger password, and update `password` in config/config.yml
createdb -O kemal invidious
psql invidious kemal < /home/invidious/invidious/config/sql/channels.sql
psql invidious kemal < /home/invidious/invidious/config/sql/videos.sql
psql invidious kemal < /home/invidious/invidious/config/sql/channel_videos.sql
psql invidious kemal < /home/invidious/invidious/config/sql/users.sql
psql invidious kemal < /home/invidious/invidious/config/sql/session_ids.sql
psql invidious kemal < /home/invidious/invidious/config/sql/nonces.sql
psql invidious kemal < /home/invidious/invidious/config/sql/annotations.sql
psql invidious kemal < /home/invidious/invidious/config/sql/playlists.sql
psql invidious kemal < /home/invidious/invidious/config/sql/playlist_videos.sql
exit
</code></pre>
<h4 id="set-up-invidious">Set up Invidious</h4>
<pre><code class="language-bash">su - invidious
cd invidious
shards install --production
crystal build src/invidious.cr --release
exit
</code></pre>
<h4 id="systemd-service">Systemd service</h4>
<pre><code class="language-bash">cp /home/invidious/invidious/invidious.service /etc/systemd/system/invidious.service
systemctl enable --now invidious.service
</code></pre>
<h3 id="macos">MacOS</h3>
<pre><code class="language-bash"># Install dependencies
brew update
brew install shards crystal postgres imagemagick librsvg
# Clone the repository and set up a PostgreSQL database
git clone https://github.com/iv-org/invidious
cd invidious
brew services start postgresql
psql -c "CREATE ROLE kemal WITH PASSWORD 'kemal';" # Change 'kemal' here to a stronger password, and update `password` in config/config.yml
createdb -O kemal invidious
psql invidious kemal < config/sql/channels.sql
psql invidious kemal < config/sql/videos.sql
psql invidious kemal < config/sql/channel_videos.sql
psql invidious kemal < config/sql/users.sql
psql invidious kemal < config/sql/session_ids.sql
psql invidious kemal < config/sql/nonces.sql
psql invidious kemal < config/sql/annotations.sql
psql invidious kemal < config/sql/privacy.sql
psql invidious kemal < config/sql/playlists.sql
psql invidious kemal < config/sql/playlist_videos.sql
# Set up Invidious
shards update && shards install && crystal build src/invidious.cr --release
</code></pre>
<h2 id="post-install-configuration">Post-install configuration:</h2>
<p>Detailed configuration available in the <a href="../Configuration/">configuration guide</a>.</p>
<p>Because of various issues Invidious <strong>must</strong> be restarted often, at least once a day, ideally every hour.</p>
<p>If you use a reverse proxy, you <strong>must</strong> configure invidious to properly serve request through it:</p>
<p><code>https_only: true</code> : if you are serving your instance via https, set it to true</p>
<p><code>domain: domain.ext</code>: if you are serving your instance via a domain name, set it here</p>
<p><code>external_port: 443</code>: if you are serving your instance via https, set it to 443</p>
<h2 id="update-invidious">Update Invidious</h2>
<h4 id="updating-a-docker-install">Updating a Docker install</h4>
<pre><code class="language-bash">docker-compose pull && docker-compose up && docker image prune -f
</code></pre>
<h4 id="update-a-manual-install">Update a manual install</h4>
<pre><code class="language-bash">sudo - invidious
cd invidious
shards update && shards install && crystal build src/invidious.cr --release
exit
systemctl restart invidious.service
</code></pre>
<h2 id="usage">Usage:</h2>
<pre><code class="language-bash">./invidious
</code></pre>
<h4 id="logrotate-configuration">Logrotate configuration</h4>
<pre><code class="language-bash">echo "/home/invidious/invidious/invidious.log {
rotate 4
weekly
notifempty
missingok
compress
minsize 1048576
}" | tee /etc/logrotate.d/invidious.logrotate
chmod 0644 /etc/logrotate.d/invidious.logrotate
</code></pre>
</article>
</div>
</div>
<a href="#" class="md-top md-icon" data-md-component="top" data-md-state="hidden">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg>
Back to top
</a>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href="../How-to-setup-Anti-Captcha/" class="md-footer__link md-footer__link--prev" aria-label="Previous: How-to-setup-Anti-Captcha" rel="prev">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
How-to-setup-Anti-Captcha
</div>
</div>
</a>
<a href="../Invidious-Instances/" class="md-footer__link md-footer__link--next" aria-label="Next: Invidious-Instances" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Invidious-Instances
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://github.com/iv-org/documentation" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tracking", "navigation.expand", "navigation.top"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.bd0b6b67.min.js"}</script>
<script src="../assets/javascripts/bundle.467223ff.min.js"></script>
</body>
</html>