overseerr/docs/getting-started/installation.md

Installation

{% hint style="danger" %} Overseerr is currently in BETA. If you would like to help test the bleeding edge, please use the image sctx/overseerr:develop! {% endhint %}

{% hint style="info" %} After running Overseerr for the first time, configure it by visiting the web UI at http://[address]:5055 and completing the setup steps. {% endhint %}

Docker

{% tabs %} {% tab title="Basic" %}

docker run -d \
  --name overseerr \
  -e LOG_LEVEL=info \
  -e TZ=Asia/Tokyo \
  -p 5055:5055 \
  -v /path/to/appdata/config:/app/config \
  --restart unless-stopped \
  sctx/overseerr

{% endtab %}

{% tab title="Compose" %}

docker-compose.yml:

---
version: '3'

services:
  overseerr:
    image: sctx/overseerr:latest
    container_name: overseerr
    environment:
      - LOG_LEVEL=info
      - TZ=Asia/Tokyo
    ports:
      - 5055:5055
    volumes:
      - /path/to/appdata/config:/app/config
    restart: unless-stopped

{% endtab %}

{% tab title="UID/GID" %}

docker run -d \
  --name overseerr \
  --user=[ user | user:group | uid | uid:gid | user:gid | uid:group ] \
  -e LOG_LEVEL=info \
  -e TZ=Asia/Tokyo \
  -p 5055:5055 \
  -v /path/to/appdata/config:/app/config \
  --restart unless-stopped \
   sctx/overseerr

{% endtab %}

{% tab title="Manual Update" %}

# Stop the Overseerr container
docker stop overseerr

# Remove the Overseerr container
docker rm overseerr

# Pull the latest update
docker pull sctx/overseerr

# Run the Overseerr container with the same parameters as before
docker run -d ...

{% endtab %} {% endtabs %}

{% hint style="info" %} Use a 3rd party updating mechanism such as Watchtower or Ouroboros to keep Overseerr up-to-date automatically. {% endhint %}

Unraid

1. Ensure you have the Community Applications plugin installed.
2. Inside the Community Applications app store, search for Overseerr.
3. Click the Install Button.
4. On the following Add Container screen, make changes to the Host Port and Host Path 1Appdata as needed.
5. Click apply and access "Overseerr" at your <ServerIP:HostPort> in a web browser.

Windows

Please refer to the Docker Desktop for Windows user manual for details on how to install Docker on Windows.

{% hint style="danger" %} WSL2 will need to be installed to prevent DB corruption! Please see the Docker Desktop WSL 2 backend documentation for instructions on how to enable WSL2. The command below will only work with WSL2 installed! {% endhint %}

docker run -d -e LOG_LEVEL=info -e TZ=Asia/Tokyo -p 5055:5055 -v "/your/path/here:/app/config" --restart unless-stopped sctx/overseerr

{% hint style="info" %} Docker on Windows works differently than it does on Linux; it runs Docker inside of a stripped-down Linux VM. Volume mounts are exposed to Docker inside this VM via SMB mounts. While this is fine for media, it is unacceptable for the /app/config directory because SMB does not support file locking. This will eventually corrupt your database, which can lead to slow behavior and crashes.

If you must run Docker on Windows, you should put the /app/config directory mount inside the VM and not on the Windows host. (This also applies to other containers with SQLite databases.) {% endhint %}

Linux

{% hint style="info" %} The Overseerr snap is the only officially supported Linux install method aside from Docker.

Currently, the listening port cannot be changed, so port 5055 will need to be available on your host. To install snapd, please refer to the Snapcraft documentation. {% endhint %}

To install:

sudo snap install overseerr

Updating: Snap will keep Overseerr up-to-date automatically. You can force a refresh by using the following command.

sudo snap refresh

To install the development build:

sudo snap install overseerr --edge

{% hint style="danger" %} This version can break any moment. Be prepared to troubleshoot any issues that arise! {% endhint %}

Third-Party

{% tabs %}

{% tab title="Gentoo" %} Portage overlay GitHub Repository.

This is now included in the list of Gentoo repositories, so can be easily enabled with eselect repository

Efforts will be made to keep up-to-date with the latest releases; however, this cannot be guaranteed.

To enable: To enable using eselect repository, run:

eselect repository enable overseerr-overlay

To install: Once complete, you can just run:

emerge www-apps/overseerr

To install the development build: A live ebuild (=www-apps/overseerr-9999) is also available. To use this, you will need to modify accept_keywords for this package:

emerge --autounmask --autounmask-write "=www-apps/overseerr-9999"

Once installed, you will not be notified of updates, so you can update with:

emerge @live-rebuild

or use app-portage/smart-live-rebuild

{% hint style="danger" %} This version can break any moment. Be prepared to troubleshoot any issues that arise! {% endhint %}

{% endtab %}

{% tab title="Swizzin" %}

{% hint style="danger" %} This implementation is not yet merged to master due to missing functionality. You can beta test the limited implementation or follow the status on the pull request. {% endhint %}

The installation is not implemented via Docker, but barebones. The latest release version of Overseerr will be used. Please see the swizzin documentation for more information.

To install, run the following:

box install overseerr

To upgrade, run the following:

box upgrade overseerr

{% endtab %}

{% endtabs %}