docker-documentation/docs/images/docker-sickgear.md

341 wiersze
14 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-14 09:28:19 +00:00
---
title: sickgear
---
2023-10-07 12:37:04 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-sickgear/blob/master/.github/CONTRIBUTING.md -->
2020-07-02 01:45:45 +00:00
# [linuxserver/sickgear](https://github.com/linuxserver/docker-sickgear)
2019-02-07 02:46:10 +00:00
2021-12-19 09:23:42 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fsickgear?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fsickgear)
2020-07-02 01:45:45 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-sickgear.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-sickgear)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-sickgear.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-sickgear/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-sickgear/packages)
2020-12-16 21:25:03 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-sickgear/container_registry)
2021-10-03 09:20:22 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/sickgear)
2020-07-02 01:45:45 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickgear.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/sickgear)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickgear.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/sickgear)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-sickgear%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickgear/job/master/)
2020-11-02 05:00:50 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fsickgear%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/sickgear/latest/index.html)
2019-02-07 02:46:10 +00:00
2021-01-29 16:05:03 +00:00
[SickGear](https://github.com/sickgear/sickgear) provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more..
2020-07-02 01:45:45 +00:00
For more information on SickGear visit their website and check it out: https://github.com/SickGear/SickGear
2019-02-07 02:46:10 +00:00
2023-10-07 12:37:04 +00:00
[![sickgear](https://raw.githubusercontent.com/wiki/SickGear/SickGear.Wiki/images/SickGearLogo.png)](https://github.com/sickgear/sickgear)
2019-02-07 02:46:10 +00:00
## Supported Architectures
2022-05-01 09:23:59 +00:00
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/).
2019-02-07 02:46:10 +00:00
2022-05-01 09:23:59 +00:00
Simply pulling `lscr.io/linuxserver/sickgear:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-09 16:38:43 +00:00
2019-02-07 02:46:10 +00:00
The architectures supported by this image are:
2022-05-01 09:23:59 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-02-10 21:17:57 +00:00
| armhf | ✅ | arm32v7-\<version tag\> |
2019-02-07 02:46:10 +00:00
2021-04-18 09:33:04 +00:00
## Application Setup
## Setting up the application
Access the webui at `<your-ip>:8081`, for more information check out [SickGear](https://github.com/sickgear/sickgear).
## Migration
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.
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
2020-07-02 01:45:45 +00:00
2019-02-07 02:46:10 +00:00
## Usage
2021-07-04 09:23:08 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-02-07 02:46:10 +00:00
2021-07-04 09:23:08 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-02-07 02:46:10 +00:00
```yaml
---
2020-04-09 01:46:04 +00:00
version: "2.1"
2019-02-07 02:46:10 +00:00
services:
sickgear:
2022-05-01 09:23:59 +00:00
image: lscr.io/linuxserver/sickgear:latest
2019-02-07 02:46:10 +00:00
container_name: sickgear
environment:
2019-03-07 02:45:56 +00:00
- PUID=1000
- PGID=1000
2023-02-10 21:17:57 +00:00
- TZ=Etc/UTC
2019-02-07 02:46:10 +00:00
volumes:
2020-06-05 14:53:27 +00:00
- /path/to/data:/config
- /path/to/data:/tv
- /path/to/data:/downloads
2019-02-07 02:46:10 +00:00
ports:
- 8081:8081
restart: unless-stopped
```
2021-07-04 09:23:08 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-08 01:46:38 +00:00
2021-04-18 09:33:04 +00:00
```bash
2020-10-08 01:46:38 +00:00
docker run -d \
--name=sickgear \
-e PUID=1000 \
-e PGID=1000 \
2023-02-10 21:17:57 +00:00
-e TZ=Etc/UTC \
2020-10-08 01:46:38 +00:00
-p 8081:8081 \
-v /path/to/data:/config \
-v /path/to/data:/tv \
-v /path/to/data:/downloads \
--restart unless-stopped \
2022-05-01 09:23:59 +00:00
lscr.io/linuxserver/sickgear:latest
2020-10-08 01:46:38 +00:00
```
2019-02-07 02:46:10 +00:00
## Parameters
2023-10-07 12:37:04 +00:00
Containers 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.
2019-02-07 02:46:10 +00:00
2020-07-02 01:45:45 +00:00
### Ports (`-p`)
2019-02-07 02:46:10 +00:00
| Parameter | Function |
2020-07-02 01:45:45 +00:00
| :----: | --- |
2019-02-07 02:46:10 +00:00
| `8081` | will map the container's port 8081 to port 8081 on the host |
2020-07-02 01:45:45 +00:00
### Environment Variables (`-e`)
2019-02-07 02:46:10 +00:00
| Env | Function |
2020-07-02 01:45:45 +00:00
| :----: | --- |
2019-03-07 02:45:56 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2023-02-10 21:17:57 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2019-02-07 02:46:10 +00:00
2020-07-02 01:45:45 +00:00
### Volume Mappings (`-v`)
2019-02-07 02:46:10 +00:00
| Volume | Function |
2020-07-02 01:45:45 +00:00
| :----: | --- |
2019-02-07 02:46:10 +00:00
| `/config` | this will store any uploaded data on the docker host |
| `/tv` | where you store your tv shows |
2020-07-02 01:45:45 +00:00
| `/downloads` | your downloads folder for post processing (must not be download in progress) |
2020-04-29 01:54:05 +00:00
2021-10-03 09:20:22 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-07-02 01:45:45 +00:00
## Environment variables from files (Docker secrets)
2020-06-04 01:45:50 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-18 09:33:04 +00:00
```bash
2023-10-07 12:37:04 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2020-06-04 01:45:50 +00:00
```
2023-10-07 12:37:04 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2020-06-04 01:45:50 +00:00
## Umask for running applications
2020-07-02 01:45:45 +00:00
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.
2019-02-07 02:46:10 +00:00
## User / Group Identifiers
2020-07-02 01:45:45 +00:00
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`.
2019-02-07 02:46:10 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-07 12:37:04 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2019-02-07 02:46:10 +00:00
2021-04-18 09:33:04 +00:00
```bash
2023-10-07 12:37:04 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2019-02-07 02:46:10 +00:00
```
2020-04-09 01:46:04 +00:00
## Docker Mods
2021-04-18 09:33:04 +00:00
2020-10-08 01:46:38 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=sickgear&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 Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-09 01:46:04 +00:00
2020-10-08 01:46:38 +00:00
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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-04-09 01:46:04 +00:00
2019-02-07 02:46:10 +00:00
## Support Info
2019-09-05 01:45:58 +00:00
* Shell access whilst the container is running:
2023-10-07 12:37:04 +00:00
```bash
docker exec -it sickgear /bin/bash
```
2019-09-05 01:45:58 +00:00
* To monitor the logs of the container in realtime:
2023-10-07 12:37:04 +00:00
```bash
docker logs -f sickgear
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' sickgear
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sickgear:latest
```
## Updating Info
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
Below are the instructions for updating containers:
### Via Docker Compose
* Update images:
* All images:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull sickgear
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d sickgear
```
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Docker Run
* Update the image:
```bash
docker pull lscr.io/linuxserver/sickgear:latest
```
* Stop the running container:
```bash
docker stop sickgear
```
* Delete the container:
```bash
docker rm sickgear
```
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
* Pull the latest image at its tag and replace it with the same env variables in one run:
```bash
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once sickgear
```
* You can also remove the old dangling images: `docker image prune`
!!! warning
We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
### Image Update Notifications - Diun (Docker Image Update Notifier)
!!! tip
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
## Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
```bash
git clone https://github.com/linuxserver/docker-sickgear.git
cd docker-sickgear
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/sickgear:latest .
```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
2019-02-07 02:46:10 +00:00
## Versions
2023-10-10 03:31:18 +00:00
* **08.10.23:** - Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar).
2023-08-10 21:06:40 +00:00
* **10.08.23:** - Bump unrar to 6.2.10.
2023-05-28 02:31:19 +00:00
* **27.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
2023-03-07 13:42:51 +00:00
* **05.03.23:** - Rebase to Alpine 3.17.
2022-11-18 14:13:21 +00:00
* **18.11.22:** - Update service file from legacy SickBeard.py to sickgear.py.
2022-10-12 14:25:25 +00:00
* **10.10.22:** - Rebase to Alpine 3.16, migrate to s6v3.
2022-09-19 21:40:30 +00:00
* **19.09.22:** - Rebase to alpine 3.15. Build unrar from source.
2021-01-31 14:44:14 +00:00
* **31.01.21:** - Add unrar.
2021-01-29 16:05:03 +00:00
* **29.01.21:** - Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information.
2021-01-29 15:08:56 +00:00
* **23.01.21:** - Rebasing to alpine 3.13.
2020-06-05 14:53:27 +00:00
* **03.06.20:** - Rebasing to alpine 3.12, switch to python3.
2019-12-27 10:57:48 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-06-30 19:28:13 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 19:49:12 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 04:50:23 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-07 02:46:10 +00:00
* **07.11.18:** - Pipeline prep
* **07.07.18:** - Initial draft release