Search…
Images
Powered By GitBook
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

Our images support multiple architectures such as x86-64, arm64 and armhf. 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 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
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Version Tags

This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
Tag
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.
1
---
2
version: "2.1"
3
services:
4
ombi:
5
image: lscr.io/linuxserver/ombi
6
container_name: ombi
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=Europe/London
11
- BASE_URL=/ombi #optional
12
volumes:
13
- /path/to/appdata/config:/config
14
ports:
15
- 3579:3579
16
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=ombi \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=Europe/London \
6
-e BASE_URL=/ombi `#optional` \
7
-p 3579:3579 \
8
-v /path/to/appdata/config:/config \
9
--restart unless-stopped \
10
lscr.io/linuxserver/ombi
Copied!

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=Europe/London
Specify a timezone to use EG Europe/London
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:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
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:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

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

Versions

    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 to development 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.
Last modified 22d ago