kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
11dfbe6412
commit
f9ea700238
|
|
@ -1,8 +1,20 @@
|
||||||
# linuxserver/ombi
|
# [linuxserver/ombi](https://github.com/linuxserver/docker-ombi)
|
||||||
|
|
||||||
[](https://github.com/linuxserver/docker-ombi) [](https://github.com/linuxserver/docker-ombi/releases) [](https://github.com/linuxserver/docker-ombi/packages) [](https://gitlab.com/Linuxserver.io/docker-ombi/container_registry) [](https://microbadger.com/images/linuxserver/ombi) [](https://hub.docker.com/r/linuxserver/ombi) [](https://hub.docker.com/r/linuxserver/ombi) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ombi/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ombi/latest/index.html)
|
[](https://github.com/linuxserver/docker-ombi)
|
||||||
|
[](https://github.com/linuxserver/docker-ombi/releases)
|
||||||
|
[](https://github.com/linuxserver/docker-ombi/packages)
|
||||||
|
[](https://gitlab.com/Linuxserver.io/docker-ombi/container_registry)
|
||||||
|
[](https://microbadger.com/images/linuxserver/ombi "Get your own version badge on microbadger.com")
|
||||||
|
[](https://hub.docker.com/r/linuxserver/ombi)
|
||||||
|
[](https://hub.docker.com/r/linuxserver/ombi)
|
||||||
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ombi/job/master/)
|
||||||
|
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ombi/latest/index.html)
|
||||||
|
|
||||||
[Ombi](https://ombi.io) 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!
|
[Ombi](https://ombi.io) 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
|
## Supported Architectures
|
||||||
|
|
||||||
|
|
@ -13,7 +25,7 @@ Simply pulling `linuxserver/ombi` should retrieve the correct image for your arc
|
||||||
The architectures supported by this image are:
|
The architectures supported by this image are:
|
||||||
|
|
||||||
| Architecture | Tag |
|
| Architecture | Tag |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| x86-64 | amd64-latest |
|
| x86-64 | amd64-latest |
|
||||||
| arm64 | arm64v8-latest |
|
| arm64 | arm64v8-latest |
|
||||||
| armhf | arm32v7-latest |
|
| armhf | arm32v7-latest |
|
||||||
|
|
@ -23,7 +35,7 @@ The architectures supported by this image are:
|
||||||
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.
|
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 |
|
| Tag | Description |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| latest | Stable Ombi releases |
|
| latest | Stable Ombi releases |
|
||||||
| development | Releases from the `develop` branch of Ombi |
|
| development | Releases from the `develop` branch of Ombi |
|
||||||
|
|
||||||
|
|
@ -33,7 +45,7 @@ Here are some example snippets to help you get started creating a container from
|
||||||
|
|
||||||
### docker
|
### docker
|
||||||
|
|
||||||
```text
|
```
|
||||||
docker create \
|
docker create \
|
||||||
--name=ombi \
|
--name=ombi \
|
||||||
-e PUID=1000 \
|
-e PUID=1000 \
|
||||||
|
|
@ -46,6 +58,7 @@ docker create \
|
||||||
linuxserver/ombi
|
linuxserver/ombi
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### docker-compose
|
### docker-compose
|
||||||
|
|
||||||
Compatible with docker-compose v2 schemas.
|
Compatible with docker-compose v2 schemas.
|
||||||
|
|
@ -71,36 +84,39 @@ services:
|
||||||
|
|
||||||
## Parameters
|
## 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.
|
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`\)
|
### Ports (`-p`)
|
||||||
|
|
||||||
| Parameter | Function |
|
| Parameter | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `3579` | web gui |
|
| `3579` | web gui |
|
||||||
|
|
||||||
### Environment Variables \(`-e`\)
|
|
||||||
|
### Environment Variables (`-e`)
|
||||||
|
|
||||||
| Env | Function |
|
| Env | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `PUID=1000` | for UserID - see below for explanation |
|
| `PUID=1000` | for UserID - see below for explanation |
|
||||||
| `PGID=1000` | for GroupID - see below for explanation |
|
| `PGID=1000` | for GroupID - see below for explanation |
|
||||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
| `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. |
|
| `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 Mappings (`-v`)
|
||||||
|
|
||||||
| Volume | Function |
|
| Volume | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `/config` | Contains all relevant configuration files. |
|
| `/config` | Contains all relevant configuration files. |
|
||||||
|
|
||||||
## Environment variables from files \(Docker secrets\)
|
|
||||||
|
|
||||||
|
## Environment variables from files (Docker secrets)
|
||||||
|
|
||||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||||
|
|
||||||
As an example:
|
As an example:
|
||||||
|
|
||||||
```text
|
```
|
||||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -108,30 +124,33 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
||||||
|
|
||||||
## Umask for running applications
|
## 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](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
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](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||||
|
|
||||||
|
|
||||||
## User / Group Identifiers
|
## 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`.
|
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.
|
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:
|
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||||
|
|
||||||
```text
|
```
|
||||||
$ id username
|
$ id username
|
||||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Application Setup
|
## Application Setup
|
||||||
|
|
||||||
Access the webui at `<your-ip>:3579`. Follow the setup wizard on initial install. Then configure the required services.
|
Access the webui at `<your-ip>:3579`. Follow the setup wizard on initial install. Then configure the required services.
|
||||||
|
|
||||||
|
|
||||||
## Docker Mods
|
## Docker Mods
|
||||||
|
[](https://mods.linuxserver.io/?mod=ombi "view available mods for this container.")
|
||||||
|
|
||||||
[](https://mods.linuxserver.io/?mod=ombi)
|
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
||||||
|
|
||||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
|
|
||||||
|
|
||||||
## Support Info
|
## Support Info
|
||||||
|
|
||||||
|
|
@ -157,4 +176,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||||
* **26.01.18:** - Fix continuation lines.
|
* **26.01.18:** - Fix continuation lines.
|
||||||
* **16.04.17:** - Switch to using inhouse mono baseimage.
|
* **16.04.17:** - Switch to using inhouse mono baseimage.
|
||||||
* **17.02.17:** - Initial Release.
|
* **17.02.17:** - Initial Release.
|
||||||
|
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue