docker-documentation/images/docker-sickchill.md

142 wiersze
6.0 KiB
Markdown
Czysty Zwykły widok Historia

2019-10-06 06:33:44 +00:00
# [linuxserver/sickchill](https://github.com/linuxserver/docker-sickchill)
2019-03-04 17:45:18 +00:00
2019-11-03 07:32:55 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-sickchill.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-sickchill)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-sickchill.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-sickchill/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-sickchill/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-sickchill/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/sickchill)
2019-10-06 06:33:44 +00:00
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/sickchill.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/sickchill "Get your own version badge on microbadger.com")
2019-11-03 07:32:55 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickchill.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/sickchill)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickchill.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/sickchill)
2019-10-06 06:33:44 +00:00
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-sickchill/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickchill/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickchill/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickchill/latest/index.html)
[Sickchill](https://github.com/SickChill/SickChill) is an Automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
2019-03-04 17:45:18 +00:00
## Supported Architectures
2019-09-01 06:33:02 +00:00
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](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-03-04 17:45:18 +00:00
Simply pulling `linuxserver/sickchill` 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 |
2019-10-06 06:33:44 +00:00
| :----: | --- |
2019-03-04 17:45:18 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-31 16:38:55 +00:00
| armhf | arm32v7-latest |
2019-03-04 17:45:18 +00:00
2019-10-06 06:33:44 +00:00
2019-03-04 17:45:18 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-10-06 06:33:44 +00:00
```
2019-03-04 17:45:18 +00:00
docker create \
--name=sickchill \
-e PUID=1000 \
-e PGID=1000 \
2019-08-13 22:15:22 +00:00
-e TZ=Europe/London \
2019-03-04 17:45:18 +00:00
-p 8081:8081 \
2019-08-13 22:15:22 +00:00
-v /path/to/data:/config \
-v /path/to/data:/downloads \
-v /path/to/data:/tv \
2019-03-04 17:45:18 +00:00
--restart unless-stopped \
linuxserver/sickchill
```
2019-10-06 06:33:44 +00:00
2019-03-04 17:45:18 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
sickchill:
image: linuxserver/sickchill
container_name: sickchill
environment:
- PUID=1000
- PGID=1000
2019-08-13 22:15:22 +00:00
- TZ=Europe/London
2019-03-04 17:45:18 +00:00
volumes:
2019-08-13 22:15:22 +00:00
- /path/to/data:/config
- /path/to/data:/downloads
- /path/to/data:/tv
2019-03-04 17:45:18 +00:00
ports:
- 8081:8081
restart: unless-stopped
```
## Parameters
2019-10-06 06:33:44 +00:00
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.
2019-03-04 17:45:18 +00:00
2019-10-06 06:33:44 +00:00
### Ports (`-p`)
2019-03-04 17:45:18 +00:00
| Parameter | Function |
2019-10-06 06:33:44 +00:00
| :----: | --- |
2019-03-04 17:45:18 +00:00
| `8081` | will map the container's port 8081 to port 8081 on the host |
2019-10-06 06:33:44 +00:00
### Environment Variables (`-e`)
2019-03-04 17:45:18 +00:00
| Env | Function |
2019-10-06 06:33:44 +00:00
| :----: | --- |
2019-03-04 17:45:18 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-08-13 22:15:22 +00:00
| `TZ=Europe/London` | specify your TimeZone e.g. Europe/London |
2019-03-04 17:45:18 +00:00
2019-10-06 06:33:44 +00:00
### Volume Mappings (`-v`)
2019-03-04 17:45:18 +00:00
| Volume | Function |
2019-10-06 06:33:44 +00:00
| :----: | --- |
2019-03-04 17:45:18 +00:00
| `/config` | this will store config on the docker host |
| `/downloads` | this will store any downloaded data on the docker host |
| `/tv` | this will allow sickchill to view what you already have |
2019-10-06 06:33:44 +00:00
2019-03-04 17:45:18 +00:00
## User / Group Identifiers
2019-10-06 06:33:44 +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-03-04 17:45:18 +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.
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-10-06 06:33:44 +00:00
```
2019-03-04 17:45:18 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Application Setup
Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to match docker mappings via the webui.
2019-10-06 06:33:44 +00:00
2019-03-04 17:45:18 +00:00
## Support Info
2019-09-01 06:33:02 +00:00
* Shell access whilst the container is running:
2019-03-04 17:45:18 +00:00
* `docker exec -it sickchill /bin/bash`
2019-09-01 06:33:02 +00:00
* To monitor the logs of the container in realtime:
2019-03-04 17:45:18 +00:00
* `docker logs -f sickchill`
2019-09-01 06:33:02 +00:00
* Container version number
2019-03-04 17:45:18 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' sickchill`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sickchill`
## Versions
2019-07-05 18:59:50 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-04-18 03:54:12 +00:00
* **17.04.19:** - Adding Nodejs dependancy.
2019-03-31 16:38:55 +00:00
* **31.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-03-04 17:45:18 +00:00
* **10.10.18:** - Initial Release.