Installation
Overseerr is currently in BETA. If you would like to help test the bleeding edge, please use the image sctx/overseerr:develop
!
Docker
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!
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 \
-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 ...
Unraid
Ensure you have the Community Applications plugin installed.
Inside the Community 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 1(Appdata) as needed.
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.
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!
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:
Open the Docker Desktop app
Head to the Volumes tab
Click on the "New Volume" button near the top right
Enter a name for the volume (example:
overseerr-data
) and hit "Create"
Then, create and start the Overseerr container:
docker run -d -e LOG_LEVEL=debug -e TZ=Asia/Tokyo -p 5055:5055 -v "overseerr-data:/app/config" --restart unless-stopped sctx/overseerr
If using a named volume like above, you can safely ignore the warning about the /app/config
folder being incorrectly mounted on the setup page.
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.
Linux
Installation:
sudo snap install overseerr
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!
Updating:
Snap will keep Overseerr up-to-date automatically. You can force a refresh by using the following command.
sudo snap refresh
Third-Party
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
This version can break any moment. Be prepared to troubleshoot any issues that arise!
Last updated
Was this helpful?