Bot Updating Templated Files

pull/9/head
LinuxServer-CI 2019-10-02 21:46:53 -04:00
rodzic 7eacd8d280
commit d4abceb0bf
1 zmienionych plików z 40 dodań i 18 usunięć

Wyświetl plik

@ -1,10 +1,17 @@
# linuxserver/sickgear # [linuxserver/sickgear](https://github.com/linuxserver/docker-sickgear)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-sickgear.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-sickgear/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/sickgear.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/sickgear) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/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)](https://hub.docker.com/r/linuxserver/sickgear) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickgear.svg?style=flat-square&color=E68523)](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 Release](https://img.shields.io/github/release/linuxserver/docker-sickgear.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-sickgear/releases)
[![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")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/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)](https://hub.docker.com/r/linuxserver/sickgear)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickgear.svg?style=flat-square&color=E68523)](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 ## Supported Architectures
@ -15,18 +22,19 @@ Simply pulling `linuxserver/sickgear` should retrieve the correct image for your
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 |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
### docker ### docker
```text ```
docker create \ docker create \
--name=sickgear \ --name=sickgear \
-e PUID=1000 \ -e PUID=1000 \
@ -39,6 +47,7 @@ docker create \
linuxserver/sickgear linuxserver/sickgear
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -64,38 +73,41 @@ 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 |
| :---: | :--- | | :----: | --- |
| `8081` | will map the container's port 8081 to port 8081 on the host | | `8081` | will map the container's port 8081 to port 8081 on the host |
### 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 |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | this will store any uploaded data on the docker host | | `/config` | this will store any uploaded data on the docker host |
| `/tv` | where you store your tv shows | | `/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 ## 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)
``` ```
@ -111,18 +123,29 @@ Access the webui at `<your-ip>: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 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 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 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 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: 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 * 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 * 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 * stop both containers
* notice the configuration difference and migrate copies of the old settings into the new app * notice the configuration difference and migrate copies of the old settings into the new app
* start the new container and test * start the new container and test
## Support Info ## Support Info
* Shell access whilst the container is running: * Shell access whilst the container is running:
@ -141,4 +164,3 @@ It is recommended that a clean install be completed, rather than a migration, ho
* **22.02.19:** - Rebasing to alpine 3.9. * **22.02.19:** - Rebasing to alpine 3.9.
* **07.11.18:** - Pipeline prep * **07.11.18:** - Pipeline prep
* **07.07.18:** - Initial draft release * **07.07.18:** - Initial draft release