From cf81fe7ea3c00754667e8827f78e98d075021220 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 7 Feb 2019 07:46:20 +0000 Subject: [PATCH] Bot Updating Templated Files --- images/docker-ombi.md | 141 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 141 insertions(+) create mode 100755 images/docker-ombi.md diff --git a/images/docker-ombi.md b/images/docker-ombi.md new file mode 100755 index 0000000000..e87217c5c3 --- /dev/null +++ b/images/docker-ombi.md @@ -0,0 +1,141 @@ +# [linuxserver/ombi](https://github.com/linuxserver/docker-ombi) + +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/ombi.svg)](https://microbadger.com/images/linuxserver/ombi "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/ombi.svg)](https://microbadger.com/images/linuxserver/ombi "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/ombi.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/ombi.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-ombi/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ombi/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ombi/latest/badge.svg)](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 sent 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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list). + +The architectures supported by this image are: + +| Architecture | Tag | +| :----: | --- | +| x86-64 | amd64-latest | +| arm64 | arm64v8-latest | +| armhf | arm32v6-latest | + + +## Usage + +Here are some example snippets to help you get started creating a container from this image. + +### docker + +``` +docker create \ + --name=ombi \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ + -p 3579:3579 \ + -v :/config \ + --restart unless-stopped \ + linuxserver/ombi +``` + +Using tags, you can choose between various versions of ombi. No tag is required to remain on the latest stable release. +Add one of the tags, if required, to the `linuxserver/ombi` line of the run/create command in the following format, `linuxserver/ombi:development` +The development tag will be the latest commit in the `develop` branch of ombi. +HOWEVER, USE THE DEVELOPMENT BRANCH AT YOUR OWN PERIL !!!!!!!!! + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2" +services: + ombi: + image: linuxserver/ombi + container_name: ombi + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + volumes: + - :/config + ports: + - 3579:3579 + mem_limit: 4096m + restart: unless-stopped +``` + +## Parameters + +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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=1001` | for UserID - see below for explanation | +| `PGID=1001` | for GroupID - see below for explanation | +| `TZ=Europe/London` | Specify a timezone to use EG Europe/London | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/config` | Contains all relevant configuration files. | + + +## 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=1001` and `PGID=1001`, to find yours use `id user` as below: + +``` + $ id username + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` + +## Application Setup + +Access the webui at `:3579`. Follow the setup wizard on initial install. Then configure the required services. + + + +## 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" }}' linuxserver/ombi` + +## Versions + +* **25.01.19:** - Add info on tags and development builds. +* **17.12.18:** - 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.