develop
Getting Started
Using Overseerr
Extending Overseerr
Installation
Overseerr is currently in BETA. If you would like to help test the bleeding edge, please use the image
sctx/overseerr:develop!After running Overseerr for the first time, configure it by visiting the web UI at
http://[address]:5055 and completing the setup steps.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).Docker CLI
Docker Compose
Installation:
1
docker run -d \
2
--name overseerr \
3
-e LOG_LEVEL=debug \
4
-e TZ=Asia/Tokyo \
5
-p 5055:5055 \
6
-v /path/to/appdata/config:/app/config \
7
--restart unless-stopped \
8
sctx/overseerr
Copied!
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:
1
docker stop overseerr && docker rm overseerr
Copied!
Pull the latest image:
1
docker pull sctx/overseerr
Copied!
Finally, run the container with the same parameters originally used to create the container:
1
docker run -d ...
Copied!
You may alternatively use a third-party updating mechanism, such as Watchtower or Ouroboros, to keep Overseerr up-to-date automatically.
Installation:
Define the
overseerr service in your docker-compose.yml as follows:1
---
2
version: '3'
3
​
4
services:
5
overseerr:
6
image: sctx/overseerr:latest
7
container_name: overseerr
8
environment:
9
- LOG_LEVEL=debug
10
- TZ=Asia/Tokyo
11
ports:
12
- 5055:5055
13
volumes:
14
- /path/to/appdata/config:/app/config
15
restart: unless-stopped
Copied!
Then, start all services defined in the your Compose file:
1
docker-compose up -d
Copied!
Updating:
Pull the latest image:
1
docker-compose pull overseerr
Copied!
Then, restart all services defined in the Compose file:
1
docker-compose up -d
Copied!
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 1(Appdata) 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.
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:
1
docker volume create overseerr-data
Copied!
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:
1
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
Copied!
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.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.
Linux
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.Installation:
1
sudo snap install overseerr
Copied!
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.
1
sudo snap refresh
Copied!
Third-Party
Gentoo
Swizzin
This is now included in the list of Gentoo repositories, so can be easily enabled with
eselect repositoryEfforts 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:1
eselect repository enable overseerr-overlay
Copied!
To install: Once complete, you can just run:
1
emerge www-apps/overseerr
Copied!
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:1
emerge --autounmask --autounmask-write "=www-apps/overseerr-9999"
Copied!
Once installed, you will not be notified of updates, so you can update with:
1
emerge @live-rebuild
Copied!
or use
app-portage/smart-live-rebuildThis version can break any moment. Be prepared to troubleshoot any issues that arise!
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.
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:
1
box install overseerr
Copied!
To upgrade, run the following:
1
box upgrade overseerr
Copied!
Last modified 1mo ago
Copy link
Edit on GitHub