From adfd8eca955bd0f9b307ab77ffb079b1965f2bc8 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 28 Apr 2020 21:54:05 -0400 Subject: [PATCH] Bot Updating Documentation --- images/docker-sickgear.md | 65 +++++++++++++++++++++++++++------------ 1 file changed, 45 insertions(+), 20 deletions(-) diff --git a/images/docker-sickgear.md b/images/docker-sickgear.md index 369b5b7087..82a79a2f8c 100644 --- a/images/docker-sickgear.md +++ b/images/docker-sickgear.md @@ -1,10 +1,20 @@ -# linuxserver/sickgear +# [linuxserver/sickgear](https://github.com/linuxserver/docker-sickgear) -[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-sickgear.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-sickgear) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-sickgear.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-sickgear/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-sickgear/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-sickgear/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/sickgear) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/sickgear.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/sickgear) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickgear.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/sickgear) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickgear.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/sickgear) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-sickgear/job/master/badge/icon?style=flat-square)](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) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-sickgear.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-sickgear) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-sickgear.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-sickgear/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-sickgear/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-sickgear/container_registry) +[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/sickgear) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/sickgear.svg?style=flat-square&color=E68523)](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?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/sickgear) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickgear.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/sickgear) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-sickgear/job/master/badge/icon?style=flat-square)](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 @@ -15,18 +25,19 @@ Simply pulling `linuxserver/sickgear` should retrieve the correct image for your 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 +50,7 @@ docker create \ linuxserver/sickgear ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -64,38 +76,42 @@ 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,23 +127,33 @@ 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 + ## Docker Mods +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27sickgear%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=sickgear "view available mods for this container.") -[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27sickgear%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=sickgear) +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 @@ -148,4 +174,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * **22.02.19:** - Rebasing to alpine 3.9. * **07.11.18:** - Pipeline prep * **07.07.18:** - Initial draft release -