From 58507063adb4b54ca230be204afa30e245efc6d7 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 22 Apr 2021 06:41:48 +0100 Subject: [PATCH] Bot Updating Documentation --- images/docker-sickchill.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/images/docker-sickchill.md b/images/docker-sickchill.md index fa9b65c0a..9edbcfad7 100644 --- a/images/docker-sickchill.md +++ b/images/docker-sickchill.md @@ -1,6 +1,9 @@ --- title: sickchill --- + + + # [linuxserver/sickchill](https://github.com/linuxserver/docker-sickchill) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-sickchill.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-sickchill) @@ -13,8 +16,7 @@ title: sickchill [![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-sickchill%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickchill/job/master/) [![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%2Fsickchill%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/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 @@ -30,6 +32,9 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## Application Setup + +Web interface is at `:8081` , set paths for downloads, tv-shows to match docker mappings via the webui. ## Usage @@ -61,7 +66,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=sickchill \ -e PUID=1000 \ @@ -75,7 +80,6 @@ docker run -d \ ghcr.io/linuxserver/sickchill ``` - ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. @@ -86,7 +90,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `8081` | will map the container's port 8081 to port 8081 on the host | - ### Environment Variables (`-e`) | Env | Function | @@ -103,15 +106,13 @@ Docker images are configured using parameters passed at runtime (such as those a | `/downloads` | this will store any downloaded data on the docker host | | `/tv` | this will allow sickchill to view what you already have | - - ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. As an example: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -122,7 +123,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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. - ## 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`. @@ -131,22 +131,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -## Application Setup - -Web interface is at `:8081` , set paths for downloads, tv-shows to match docker mappings via the webui. - - ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=sickchill&query=%24.mods%5B%27sickchill%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=sickchill "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.") 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. - ## Support Info * Shell access whilst the container is running: