The LinuxServer.io team brings you another container release featuring:
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at:
- Blog - all the things you can do with our containers including How-To guides, opinions and much more!
- Discord - realtime support / chat with the community and the team.
- Discourse - post on our community forum.
- Fleet - an online web interface which displays all of our maintained images.
- GitHub - view the source for all of our repositories.
- Open Collective - please consider helping us by either donating or contributing to our budget
Ombi allows you to host your own Plex Request and user management system. If you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface! Manage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something. Allow your users to post issues against their requests so you know there is a problem with the audio etc. Even automatically send them weekly newsletters of new content that has been added to your Plex server!
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/ombi: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:
Architecture | Available | Tag |
---|---|---|
x86-64 | âś… | amd64-<version tag> |
arm64 | âś… | arm64v8-<version tag> |
armhf | ❌ |
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag | Available | Description |
---|---|---|
latest | âś… | Stable Ombi releases |
development | âś… | Releases from the develop branch of Ombi |
Access the webui at <your-ip>:3579
. Follow the setup wizard on initial install. Then configure the required services.
This image can be run with a read-only container filesystem. For details please read the docs.
BASE_URL
cannot be changed from/
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
Note
Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.
docker-compose (recommended, click here for more info)
---
services:
ombi:
image: lscr.io/linuxserver/ombi:latest
container_name: ombi
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- BASE_URL=/ #optional
volumes:
- /path/to/ombi/config:/config
ports:
- 3579:3579
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=ombi \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e BASE_URL=/ `#optional` \
-p 3579:3579 \
-v /path/to/ombi/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/ombi:latest
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.
Parameter | Function |
---|---|
-p 3579:3579 |
web gui |
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Etc/UTC |
specify a timezone to use, see this list. |
-e BASE_URL=/ |
Subfolder can optionally be defined as an env variable for reverse proxies. Keep in mind that once this value is defined, the gui setting for base url no longer works. To use the gui setting, remove this env variable. |
-v /config |
Contains all relevant configuration files. |
--read-only=true |
Run container with a read-only filesystem. Please read the docs. |
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.
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.
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)
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.
-
Shell access whilst the container is running:
docker exec -it ombi /bin/bash
-
To monitor the logs of the container in realtime:
docker logs -f ombi
-
Container version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' ombi
-
Image version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ombi:latest
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:
-
Update images:
-
All images:
docker-compose pull
-
Single image:
docker-compose pull ombi
-
-
Update containers:
-
All containers:
docker-compose up -d
-
Single container:
docker-compose up -d ombi
-
-
You can also remove the old dangling images:
docker image prune
-
Update the image:
docker pull lscr.io/linuxserver/ombi:latest
-
Stop the running container:
docker stop ombi
-
Delete the container:
docker rm ombi
-
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
Tip
We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
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-ombi.git
cd docker-ombi
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/ombi:latest .
The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64
.
- 08.07.24: - Rebase to Ubuntu Noble.
- 01.07.23: - Deprecate armhf. As announced here
- 11.09.22: - Migrate to s6v3.
- 01.05.22: - Rebase to Jammy.
- 26.04.21: - Update tarball name, allow for v4 builds in stable.
- 18.01.21: - Update upstream repo. Deprecate
v4-preview
tag, which is merged todevelopment
tag upstream. - 14.04.20: - Add Ombi donate links.
- 10.05.19: - Added an optional env variable for base url setting.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Clarify info on tags and development builds.
- 25.01.19: - Add info on tags and development builds.
- 09.01.19: - Switch to multi-arch builds and add aarch64 image.
- 11.03.18: - Add HOME env to Dockerfile.
- 05.03.18: - Switch to Ombi v3 stable based on .net core.
- 26.01.18: - Fix continuation lines.
- 16.04.17: - Switch to using inhouse mono baseimage.
- 17.02.17: - Initial Release.