From 3625b0aefc400fed9bebc304281bdd1f9f04b4e4 Mon Sep 17 00:00:00 2001 From: sparklyballs Date: Mon, 14 Mar 2016 13:35:15 +0000 Subject: [PATCH] Update README.md --- README.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ca9c36a..bdbb3c5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ ![https://linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png) -The [LinuxServer.io](https://www.linuxserver.io/) team brings you another quality container release featuring auto-update on startup, easy user mapping and community support. Be sure to checkout our [forums](https://forum.linuxserver.io/index.php) or for real-time support our [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`. +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring auto-update on startup, easy user mapping and community support. Find us for support at: +* [forum.linuxserver.io](https://forum.linuxserver.io) +* [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io` +* [Podcast](https://www.linuxserver.io/index.php/category/podcast/) covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! # linuxserver/sabnzbd +![](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sabnzbd-banner.png) SABnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction. This container includes par2 multicore. http://sabnzbd.org/ @@ -10,27 +14,36 @@ This container includes par2 multicore. http://sabnzbd.org/ ## Usage ``` -docker create --name=sabnzbd -v /etc/localtime:/etc/localtime:ro -v :/config -v :/downloads -v :/incomplete-downloads -e PGID= -e PUID= -p 8080:8080 -p 9090:9090 linuxserver/sabnzbd +docker create --name=sabnzbd \ +-v :/config \ +-v :/downloads \ +-v :/incomplete-downloads \ +-v /etc/localtime:/etc/localtime:ro \ +-e PGID= -e PUID= \ +-p 8080:8080 -p 9090:9090 linuxserver/sabnzbd ``` **Parameters** * `-p 8080` - http port for the webui * `-p 9090` - https port for the webui *see note below* -* `-v /etc/localhost` for timesync - *optional* * `-v /config` - local path for sabnzbd config files * `-v /downloads` local path for finished downloads * `-v /incomplete-downloads` local path for incomplete-downloads - *optional* +* `-v /etc/localhost` for timesync - *optional* * `-e PGID` for GroupID - see below for explanation * `-e PUID` for UserID - see below for explanation -It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it sabnzbd /bin/bash`. - ### User / Group Identifiers -**TL;DR** - The `PGID` and `PUID` values set the user / group you'd like your container to 'run as' to the host OS. This can be a user you've created or even root (not recommended). +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" ™. -Part of what makes our containers work so well is by allowing you to specify your own `PUID` and `PGID`. This avoids nasty permissions errors with relation to data volumes (`-v` flags). When an application is installed on the host OS it is normally added to the common group called users, Docker apps due to the nature of the technology can't be added to this group. So we added this feature to let you easily choose when running your containers. +In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: + +``` + $ id + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` ## Setting up the application Initial setup is done from the htpp port. @@ -40,14 +53,16 @@ See here for info on some of the switch settings for sabnzbd http://wiki.sabnzbd ## Updates -* Upgrade to the latest version simply `docker restart sabnzbd`. -* To monitor the logs of the container in realtime `docker logs -f sabnzbd`. +* Shell access whilst the container is running: `docker exec -it sabnzbd /bin/bash` +* Upgrade to the latest version: `docker restart sabnzbd` +* To monitor the logs of the container in realtime: `docker logs -f sabnzbd` ## Credits https://github.com/jcfp/debpkg-par2tbb for the par2 multicore used in this container. ## Versions ++ **14.03.2016:** Refresh image to pick up latest RC + **23.01.2015:** Refresh image. + **14.12.2015:** Refresh image to pick up latest beta + **21.08.2015:** Intial Release.