From 760f8262b19d1730ae30dcb91c7fabb5cfc7837d Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 4 Apr 2019 02:45:44 +0100 Subject: [PATCH] Bot Updating Templated Files --- images/docker-sickgear.md | 60 ++++++++++++++++++++++++++------------- 1 file changed, 41 insertions(+), 19 deletions(-) diff --git a/images/docker-sickgear.md b/images/docker-sickgear.md index ef17d792a..764734ceb 100644 --- a/images/docker-sickgear.md +++ b/images/docker-sickgear.md @@ -1,32 +1,40 @@ -# linuxserver/sickgear +# [linuxserver/sickgear](https://github.com/linuxserver/docker-sickgear) -[![](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/sickgear.svg)](https://microbadger.com/images/linuxserver/sickgear) [![](https://images.microbadger.com/badges/image/linuxserver/sickgear.svg)](https://microbadger.com/images/linuxserver/sickgear) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickgear.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickgear.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-sickgear/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickgear/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickgear/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickgear/latest/index.html) +[![](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/sickgear.svg)](https://microbadger.com/images/linuxserver/sickgear "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/sickgear.svg)](https://microbadger.com/images/linuxserver/sickgear "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickgear.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickgear.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-sickgear/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickgear/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickgear/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickgear/latest/index.html) -[SickGear](https://github.com/sickgear/sickgear) provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more.. +[SickGear](https://github.com/sickgear/sickgear) provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more.. + +For more information on SickGear visit their website and check it out: https://github.com/SickGear/SickGear -For more information on SickGear visit their website and check it out: [https://github.com/SickGear/SickGear](https://github.com/SickGear/SickGear) ## 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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). +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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). Simply pulling `linuxserver/sickgear` 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 | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=sickgear \ -e PUID=1000 \ @@ -39,6 +47,7 @@ docker create \ linuxserver/sickgear ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -64,38 +73,41 @@ services: ## 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. +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`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `8081` | will map the container's port 8081 to port 8081 on the host | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | this will store any uploaded data on the docker host | | `/tv` | where you store your tv shows | -| `/downloads` | your downloads folder for post processing \(must not be donwload in progress\) | +| `/downloads` | your downloads folder for post processing (must not be donwload in progress) | + + ## 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. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -111,18 +123,29 @@ Access the webui at `:8081`, for more information check out [SickGear]( Non linuxserver.io containers are known to have the following configuration differences and may need SickGear or docker changes to migrate an existing setup * The post processing directory which is volume mounted as `downloads` within this container may be `incoming` in other versions. + * The permissions environmental variables which are defined as `PGID` and `PUID` within this container may have been `APP_UID` and `APP_UID` in other versions. + * The configuration file directory which is volume mounted as `config` within this container may be set as the environmetal variable `APP_DATA` in other versions. -* The cache directory which is set in `config.ini` may be configured as a fixed path `cache_dir = /data/cache`. Symptoms of this issue include port usage problems and a failure to start the web server log entries. Whilst the container is stopped alter this directive to `cache_dir = cache` which will allow SickGear to look for the folder relative to the volume mounted `/config` directory. + +* The cache directory which is set in `config.ini` may be configured as a fixed path `cache_dir = /data/cache`. +Symptoms of this issue include port usage problems and a failure to start the web server log entries. +Whilst the container is stopped alter this directive to `cache_dir = cache` which will allow SickGear to look for the folder relative to the volume mounted `/config` directory. It is recommended that a clean install be completed, rather than a migration, however if migration is necessary: * start a new instance of this image + * compare and align SickGear version numbers bewteen old and new. Ideally they should match but at a minumum the old vesion should be a lower version number to allow SickGear itself to try and migrate + * stop both containers + * notice the configuration difference and migrate copies of the old settings into the new app + * start the new container and test + + ## Support Info * Shell access whilst the container is running: @@ -140,4 +163,3 @@ It is recommended that a clean install be completed, rather than a migration, ho * **22.02.19:** - Rebasing to alpine 3.9. * **07.11.18:** - Pipeline prep * **07.07.18:** - Initial draft release -