shpaq/sct-overseerr
1
0
Fork 0
mirror of https://github.com/sct/overseerr.git synced 2025-12-24 15:57:20 +01:00
Code Issues Packages Projects Releases Wiki Activity
Page: Installation
Pages
Asking for Support Frequently Asked Questions Home Installation Reverse Proxy Examples
Clone
8
Installation
samwiseg0 edited this page 2020-12-19 14:56:47 -05:00
Table of Contents

🚨 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! 🚨

After running Overseerr for the first time, configure it by visiting the web UI at http://[address]:5055 and completing the setup steps.

Operating Systems:

Docker

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

Unraid

  1. Ensure you have the Community Applications plugin installed.
  2. Inside the Communtiy 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

Docker for windows must be installed and WSL2 must be enabled to be able to run the command below.

Please refer to the docker for windows documentation for installation.

Warning: 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.

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

Detail: 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.

ArchLinux (Third party)

Built from tag: https://aur.archlinux.org/packages/overseerr/

Built from latest git: https://aur.archlinux.org/packages/overseerr-git/

To install these just use your favorite AUR package manager:

yay -S overseer

Home