kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
0639cbbf5d
commit
ad3e2c931e
|
|
@ -1,10 +1,19 @@
|
||||||
# linuxserver/sickgear
|
# [linuxserver/sickgear](https://github.com/linuxserver/docker-sickgear)
|
||||||
|
|
||||||
[](https://github.com/linuxserver/docker-sickgear) [](https://github.com/linuxserver/docker-sickgear/releases) [](https://github.com/linuxserver/docker-sickgear/packages) [](https://gitlab.com/Linuxserver.io/docker-sickgear/container_registry) [](https://microbadger.com/images/linuxserver/sickgear) [](https://hub.docker.com/r/linuxserver/sickgear) [](https://hub.docker.com/r/linuxserver/sickgear) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickgear/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickgear/latest/index.html)
|
[](https://github.com/linuxserver/docker-sickgear)
|
||||||
|
[](https://github.com/linuxserver/docker-sickgear/releases)
|
||||||
|
[](https://github.com/linuxserver/docker-sickgear/packages)
|
||||||
|
[](https://gitlab.com/Linuxserver.io/docker-sickgear/container_registry)
|
||||||
|
[](https://microbadger.com/images/linuxserver/sickgear "Get your own version badge on microbadger.com")
|
||||||
|
[](https://hub.docker.com/r/linuxserver/sickgear)
|
||||||
|
[](https://hub.docker.com/r/linuxserver/sickgear)
|
||||||
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickgear/job/master/)
|
||||||
|
[](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 +24,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 +49,7 @@ docker create \
|
||||||
linuxserver/sickgear
|
linuxserver/sickgear
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### docker-compose
|
### docker-compose
|
||||||
|
|
||||||
Compatible with docker-compose v2 schemas.
|
Compatible with docker-compose v2 schemas.
|
||||||
|
|
@ -64,36 +75,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 |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `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 download in progress\) |
|
| `/downloads` | your downloads folder for post processing (must not be download in progress) |
|
||||||
|
|
||||||
## 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
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -101,17 +115,19 @@ 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)
|
||||||
```
|
```
|
||||||
|
|
@ -127,23 +143,33 @@ 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
|
||||||
|
|
||||||
|
|
||||||
## Docker Mods
|
## Docker Mods
|
||||||
|
[](https://mods.linuxserver.io/?mod=sickgear "view available mods for this container.")
|
||||||
|
|
||||||
[](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
|
## Support Info
|
||||||
|
|
||||||
|
|
@ -165,4 +191,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||||
* **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
|
||||||
|
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue