overseerr - LinuxServer.io (2024)

Overseerr is a request management and media discovery tool built to work with your existing Plex ecosystem.

Supported Architectures¶

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/overseerr:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Application Setup¶

Access the webui at <your-ip>:5055, for more information check out Overseerr.

Usage¶

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)¶

---services: overseerr: image: lscr.io/linuxserver/overseerr:latest container_name: overseerr environment: - PUID=1000 - PGID=1000 - TZ=Etc/UTC volumes: - /path/to/overseerr/config:/config ports: - 5055:5055 restart: unless-stopped

docker cli (click here for more info)¶

docker run -d \ --name=overseerr \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ -p 5055:5055 \ -v /path/to/overseerr/config:/config \ --restart unless-stopped \ lscr.io/linuxserver/overseerr:latest

Parameters¶

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)¶

Environment Variables (-e)¶

Volume Mappings (-v)¶

Miscellaneous Options¶

Environment variables from files (Docker secrets)¶

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications¶

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers¶

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods¶

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info¶

• Shell access whilst the container is running:

  docker exec -it overseerr /bin/bash

• To monitor the logs of the container in realtime:

  docker logs -f overseerr

• Container version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' overseerr

• Image version number:

  See Also

  Raspberry Pi Plex Server, Einrichten mit Docker und Portainer - BerryBase Blog

  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/overseerr:latest

Updating Info¶

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose¶

• Update images:

  • All images:

    docker-compose pull

  • Single image:

    docker-compose pull overseerr

• Update containers:

  • All containers:

    docker-compose up -d

  • Single container:

    docker-compose up -d overseerr

• You can also remove the old dangling images:

  docker image prune

Via Docker Run¶

• Update the image:

  docker pull lscr.io/linuxserver/overseerr:latest

• Stop the running container:

  docker stop overseerr

• Delete the container:

  docker rm overseerr

• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

• You can also remove the old dangling images:

  docker image prune

Image Update Notifications - Diun (Docker Image Update Notifier)¶

Building locally¶

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-overseerr.gitcd docker-overseerrdocker build \ --no-cache \ --pull \ -t lscr.io/linuxserver/overseerr:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions¶

• 31.05.24: - Rebase to Alpine 3.20.
• 23.12.23: - Rebase to Alpine 3.19.
• 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
• 18.12.22: - Rebase main to 3.17.
• 27.10.22: - Rebase main to 3.16, migrate to s6v3.
• 20.08.22: - Don't install cypress.
• 01.04.22: - Rebase main branch to Alpine 3.15.
• 27.01.22: - Rebase develop branch to Alpine 3.15.
• 04.01.22: - Remove cached files.
• 10.10.21: - Add additional post-build cleanup.
• 19.09.21: - Rebase to alpine 3.14. Update code formatting. Increase js mem limit.
• 05.04.21: - Initial Release.