diff --git a/images/docker-sickrage.md b/images/docker-sickrage.md index cce3047e2..d63069553 100755 --- a/images/docker-sickrage.md +++ b/images/docker-sickrage.md @@ -1,100 +1,149 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: https://sick-rage.github.io/ -[hub]: https://hub.docker.com/r/linuxserver/sickrage/ +# [linuxserver/sickrage](https://github.com/linuxserver/docker-sickrage) -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/sickrage.svg)](https://microbadger.com/images/linuxserver/sickrage "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/sickrage.svg)](https://microbadger.com/images/linuxserver/sickrage "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickrage.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickrage.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-sickrage/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickrage/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickrage/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickrage/latest/index.html) -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [forum.linuxserver.io][forumurl] -* [IRC][ircurl] on freenode at `#linuxserver.io` -* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! +[Sickrage](https://sick-rage.github.io/) 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. -# linuxserver/sickrage -[![](https://images.microbadger.com/badges/version/linuxserver/sickrage.svg)](https://microbadger.com/images/linuxserver/sickrage "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/sickrage.svg)](https://microbadger.com/images/linuxserver/sickrage "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickrage.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickrage.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-sickrage)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-sickrage/) +## Supported Architectures -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. [Sickrage](https://sickrage.github.io/) +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). -[![sickrage](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sickrage-banner.png)][appurl] +Simply pulling `linuxserver/sickrage` 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=sickrage \ --v :/config \ --v :/downloads \ --v :/tv \ --e PGID= -e PUID= \ --e TZ= \ --p 8081:8081 \ -linuxserver/sickrage +docker create \ + --name=sickrage \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ + -p 8081:8081 \ + -v :/config \ + -v :/downloads \ + -v :/tv \ + --restart unless-stopped \ + linuxserver/sickrage +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2" +services: + sickrage: + image: linuxserver/sickrage + container_name: sickrage + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + volumes: + - :/config + - :/downloads + - :/tv + ports: + - 8081:8081 + mem_limit: 4096m + restart: unless-stopped ``` ## Parameters -`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. -For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. -So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 -http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` +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. + +### Ports (`-p`) + +| Parameter | Function | +| :----: | --- | +| `8081` | Application WebUI | -* `-p 8081` - the port(s) -* `-v /config` - where sickrage should store config files. -* `-v /downloads` - your downloads folder -* `-v /tv` - your tv-shows folder -* `-e PGID` for GroupID - see below for explanation -* `-e PUID` for UserID - see below for explanation -* `-e TZ` for timezone information, eg Europe/London +### Environment Variables (`-e`) -It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it sickrage /bin/bash`. +| Env | Function | +| :----: | --- | +| `PUID=1001` | for UserID - see below for explanation | +| `PGID=1001` | for GroupID - see below for explanation | +| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | -### User / Group Identifiers +### Volume Mappings (`-v`) -Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. +| Volume | Function | +| :----: | --- | +| `/config` | Configuration files. | +| `/downloads` | ISOs. | +| `/tv` | TV library directory. | -In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: + + +## 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 + $ id username uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -## Setting up the application +## Application Setup Web interface is at `:8081` , set paths for downloads, tv-shows to match docker mappings via the webui. -## Info - -* To monitor the logs of the container in realtime `docker logs -f sickrage`. - -* container version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' sickrage` - -* image version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sickrage` +## Support Info +* Shell access whilst the container is running: + * `docker exec -it sickrage /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f sickrage` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' sickrage` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sickrage` ## Versions -+ **16.01.19:** Add pipeline logic and multi arch. -+ **09.08.18:** Change repository to Sick-Rage -+ **17.08.18:** Rebase to alpine 3.8. -+ **20.03.18:** In lieu of a definite fix from SR, add nodejs package for use with torrentz and other sources. -+ **12.12.17:** Rebase to alpine 3.7. -+ **06.08.17:** Internal git pull instead of at runtime. -+ **25.05.17:** Rebase to alpine 3.6. -+ **07.02.17:** Rebase to alpine 3.5. -+ **14.10.16:** Add version layer information. -+ **30.09.16:** Fix umask. -+ **09.09.16:** Add layer badges to README. -+ **28.08.16:** Add badges to README. -+ **08.08.16:** Rebase to alpine linux. -+ **30.12.15:** Build later version of unrar from source, removed uneeded mako package. -+ **20.11.15:** Updated to new repo, by SickRage Team. -+ **15.10.15:** Initial Release. +* **16.01.19:** - Add pipeline logic and multi arch. +* **09.08.18:** - Change repository to Sick-Rage +* **17.08.18:** - Rebase to alpine 3.8. +* **20.03.18:** - In lieu of a definite fix from SR, add nodejs package for use with torrentz and other sources. +* **12.12.17:** - Rebase to alpine 3.7. +* **06.08.17:** - Internal git pull instead of at runtime. +* **25.05.17:** - Rebase to alpine 3.6. +* **07.02.17:** - Rebase to alpine 3.5. +* **14.10.16:** - Add version layer information. +* **30.09.16:** - Fix umask. +* **09.09.16:** - Add layer badges to README. +* **28.08.16:** - Add badges to README. +* **08.08.16:** - Rebase to alpine linux. +* **30.12.15:** - Build later version of unrar from source, removed uneeded mako package. +* **20.11.15:** - Updated to new repo, by SickRage Team. +* **15.10.15:** - Initial Release.