4.7 KiB

Raw Blame History

Installation

{% hint style="danger" %} Overseerr is currently under very heavy, rapid development and things are likely to break often. We need all the help we can get to find bugs and get them fixed to hit a more stable release. If you would like to help test the bleeding edge, please use the image sctx/overseerr:develop instead! {% 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 \
  -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="UID/GID" %}

docker run -d \
  --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 %}

Native Linux

{% hint style="info" %} These instructions are provided by the community and are not necessarily currently supported. Please make sure you know what you're doing if you're willing to go down this path. {% endhint %}

Please note, these instructions are targetted at apt-based systems, but modify these instructions to fit your own

sudo su                                   # You REALLY need to know what you're doing
# Install nodejs your OWN way https://nodejs.org/en/download/package-manager/
curl -sL https://deb.nodesource.com/setup_12.x | -E bash -
apt install -y nodejs
apt install sqlite3 libsqlite3-dev        # This might be necessary if you're failing to install due to sqlite3
cd /opt
git clone https://github.com/sct/overseerr.git
cd overseerr
npm config set python "$(which python3)"  # Only needed if your sqlite build is failing due to bad python declaration
npm install yarn
yarn build
yarn install
yarn start

You might want to create your own service file or a reverse proxy.

Upgrading

In order to upgrade, you will need to re-build overseer.

cd /opt/overseerr
git pull
yarn build
yarn install
yarn start

Unraid

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

Windows

Please refer to the docker for windows documentation for installation.

{% hint style="danger" %} WSL2 will need to be installed to prevent DB corruption! Please see Docker Desktop WSL 2 backend on how to enable WSL2. The command below will only work with WSL2 installed! Details below. {% 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 uses a VM to run a stripped-down Linux and then runs docker within that. The volume mounts are exposed to the docker in 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 in docker on Windows, you should put the /app/config directory mount inside the VM and not on the Windows host. It's worth noting that this warning also extends to other containers which use SQLite databases. {% endhint %}

ArchLinux `Third party`

Built from tag master: https://aur.archlinux.org/packages/overseerr/
Built from latest develop: aur.archlinux.org/packages/overseerr-git
To install these just use your favorite AUR package manager:

yay -S overseer

4.7 KiB Raw Blame History