mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

pull/9/head
LinuxServer-CI 2019-10-06 02:33:44 -04:00
rodzic feb9f8222a
commit ea7ad2f17b
1 zmienionych plików z 28 dodań i 15 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

41
images/docker-sickchill.md
Wyświetl plik

@ -1,9 +1,16 @@
# linuxserver/sickchill # [linuxserver/sickchill](https://github.com/linuxserver/docker-sickchill)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-sickchill.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-sickchill/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/sickchill.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/sickchill) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/sickchill.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/sickchill) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickchill.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/sickchill) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickchill.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/sickchill) [![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) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-sickchill.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-sickchill/releases)
[![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")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/sickchill.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/sickchill "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickchill.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/sickchill)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickchill.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/sickchill)
[![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. [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.
## Supported Architectures ## 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](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/). 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/).
@ -13,18 +20,19 @@ Simply pulling `linuxserver/sickchill` should retrieve the correct image for you
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=sickchill \ --name=sickchill \
-e PUID=1000 \ -e PUID=1000 \
@ -38,6 +46,7 @@ docker create \
linuxserver/sickchill linuxserver/sickchill
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -64,39 +73,42 @@ 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 |
| `TZ=Europe/London` | specify your TimeZone e.g. Europe/London | | `TZ=Europe/London` | specify your TimeZone e.g. Europe/London |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | this will store config on the docker host | | `/config` | this will store config on the docker host |
| `/downloads` | this will store any downloaded data 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 | | `/tv` | this will allow sickchill to view what you already have |
## 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)
``` ```
@ -105,6 +117,8 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to match docker mappings via the webui. Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to match docker mappings via the webui.
## Support Info ## Support Info
* Shell access whilst the container is running: * Shell access whilst the container is running:
@ -122,4 +136,3 @@ Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to matc
* **17.04.19:** - Adding Nodejs dependancy. * **17.04.19:** - Adding Nodejs dependancy.
* **31.03.19:** - Switching to new Base images, shift to arm32v7 tag. * **31.03.19:** - Switching to new Base images, shift to arm32v7 tag.
* **10.10.18:** - Initial Release. * **10.10.18:** - Initial Release.