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

{% hint style="warning" %} Be sure to replace /path/to/appdata/config in the below examples with a valid host directory path. If this volume mount is not configured correctly, your Overseerr settings/data will not be persisted when the container is recreated (e.g., when updating the image or rebooting your machine).

The TZ environment variable value should also be set to the TZ database name of your time zone! {% endhint %}

{% tabs %} {% tab title="Docker CLI" %}

For details on the Docker CLI, please review the official docker run documentation.

Installation:

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

To run the container as a specific user/group, you may optionally add --user=[ user | user:group | uid | uid:gid | user:gid | uid:group ] to the above command.

Updating:

Stop and remove the existing container:

docker stop overseerr && docker rm overseerr

Pull the latest image:

docker pull sctx/overseerr

Finally, run the container with the same parameters originally used to create the container:

docker run -d ...

{% hint style="info" %} You may alternatively use a third-party updating mechanism, such as Watchtower or Ouroboros, to keep Overseerr up-to-date automatically. {% endhint %}

{% endtab %}

{% tab title="Docker Compose" %}

For details on how to use Docker Compose, please review the official Compose documentation.

Installation:

Define the overseerr service in your docker-compose.yml as follows:

---
version: '3'

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

Then, start all services defined in the Compose file:

docker-compose up -d

Updating:

Pull the latest image:

docker-compose pull overseerr

Then, restart all services defined in the Compose file:

docker-compose up -d

{% endtab %} {% endtabs %}

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. There is no need to install a Linux distro if using named volumes like in the example below.

{% 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 commands below will only work with WSL2 installed! {% endhint %}

First, create a volume to store the configuration data for Overseerr using using either the Docker CLI:

docker volume create overseerr-data

or the Docker Desktop app:

1. Open the Docker Desktop app
2. Head to the Volumes tab
3. Click on the "New Volume" button near the top right
4. Enter a name for the volume (example: overseerr-data) and hit "Create"

Then, create and start the Overseerr container:

docker run -d --name overseerr -e LOG_LEVEL=debug -e TZ=Asia/Tokyo -p 5055:5055 -v "overseerr-data:/app/config" --restart unless-stopped sctx/overseerr:latest

To access the files inside the volume created above, navigate to \\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\overseerr-data\_data using File Explorer.

{% 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.)

Named volumes, like in the example commands above, are automatically mounted inside the VM. Therefore the warning on the setup about the /app/config folder being incorrectly mounted page should be ignored. {% 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 %}

Installation:

sudo snap install overseerr

{% hint style="danger" %} To install the development build, add the --edge argument to the above command (i.e., sudo snap install overseerr --edge). However, note that this version can break any moment. Be prepared to troubleshoot any issues that arise! {% endhint %}

Updating:

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

sudo snap refresh

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 %}