linuxserver/sickgear
1M+
The LinuxServer.io team brings you another container release featuring:
Find us at:
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
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
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.
The architectures supported by this image are:
Architecture | Available | Tag |
---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ❌ |
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
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 environmental 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 between old and new. Ideally they should match but at a minimum the old version 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
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
[!NOTE] Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.
---
services:
sickgear:
image: lscr.io/linuxserver/sickgear:latest
container_name: sickgear
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/sickgear/data:/config
- /path/to/tv:/tv
- /path/to/downloads:/downloads
ports:
- 8081:8081
restart: unless-stopped
docker run -d \
--name=sickgear \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 8081:8081 \
-v /path/to/sickgear/data:/config \
-v /path/to/tv:/tv \
-v /path/to/downloads:/downloads \
--restart unless-stopped \
lscr.io/linuxserver/sickgear:latest
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.
Parameter | Function |
---|---|
-p 8081:8081 | will map the container's port 8081 to port 8081 on the host |
-e PUID=1000 | for UserID - see below for explanation |
-e PGID=1000 | for GroupID - see below for explanation |
-e TZ=Etc/UTC | specify a timezone to use, see this list. |
-v /config | Persistent configuration files. |
-v /tv | where you store your tv shows |
-v /downloads | your downloads folder for post processing (must not be download in progress) |
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable
Will set the environment variable MYVAR
based on the contents of the /run/secrets/mysecretvariable
file.
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 before asking for support.
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 your_user
as below:
id your_user
Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
We publish various 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.
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" }}' lscr.io/linuxserver/sickgear:latest
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Update images:
All images:
docker-compose pull
Single image:
docker-compose pull sickgear
Update containers:
All containers:
docker-compose up -d
Single container:
docker-compose up -d sickgear
You can also remove the old dangling images:
docker image prune
Update the image:
docker pull lscr.io/linuxserver/sickgear:latest
Stop the running container:
docker stop sickgear
Delete the container:
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:
docker image prune
[!TIP] We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
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 and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64
.
UMASK_SET
in favor of UMASK in baseimage, see above for more information.docker pull linuxserver/sickgear