9.9 KiB
title |
---|
ombi |
linuxserver/ombi
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!
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/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 | ✅ | arm32v7-<version tag> |
Version Tags
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 |
Application Setup
Access the webui at <your-ip>:3579
. Follow the setup wizard on initial install. Then configure the required services.
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)
---
version: "2.1"
services:
ombi:
image: lscr.io/linuxserver/ombi:latest
container_name: ombi
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- BASE_URL=/ombi #optional
volumes:
- /path/to/appdata/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=/ombi `#optional` \
-p 3579:3579 \
-v /path/to/appdata/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/ombi:latest
Parameters
Docker images 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
)
Parameter | Function |
---|---|
3579 |
web gui |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
TZ=Etc/UTC |
specify a timezone to use, see this list. |
BASE_URL=/ombi |
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. |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
Contains all relevant configuration files. |
Miscellaneous Options
Parameter | Function |
---|
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__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD
based on the contents of the /run/secrets/mysecretpassword
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 user
as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
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 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
Versions
- 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.