6.3 KiB
Executable File
linuxserver/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
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.
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 | arm32v6-latest |
Usage
Here are some example snippets to help you get started creating a container from this image.
docker
docker create \
--name=sickgear \
-e PUID=1001 \
-e PGID=1001 \
-p 8081:8081 \
-v <path to data>:/config \
-v <path to data>:/tv \
-v <path to data>:/downloads \
--restart unless-stopped \
linuxserver/sickgear
docker-compose
Compatible with docker-compose v2 schemas.
---
version: "2"
services:
sickgear:
image: linuxserver/sickgear
container_name: sickgear
environment:
- PUID=1001
- PGID=1001
volumes:
- <path to data>:/config
- <path to data>:/tv
- <path to data>:/downloads
ports:
- 8081:8081
mem_limit: 4096m
restart: unless-stopped
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.
Ports (-p
)
Parameter | Function |
---|---|
8081 |
will map the container's port 8081 to port 8081 on the host |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1001 |
for UserID - see below for explanation |
PGID=1001 |
for GroupID - see below for explanation |
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) |
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
.
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=1001
and PGID=1001
, to find yours use id user
as below:
$ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
Application Setup
Setting up the application
Access the webui at <your-ip>:8081
, for more information check out 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 beincoming
in other versions. -
The permissions environmental variables which are defined as
PGID
andPUID
within this container may have beenAPP_UID
andAPP_UID
in other versions. -
The configuration file directory which is volume mounted as
config
within this container may be set as the environmetal variableAPP_DATA
in other versions. -
The cache directory which is set in
config.ini
may be configured as a fixed pathcache_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 tocache_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:
docker exec -it sickgear /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f sickgear
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sickgear
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sickgear
Versions
- 07.11.18: - Pipeline prep
- 07.07.18: - Initial draft release