Updated README for lsio

2015-06-26 13:28:58 +01:00
parent 8b685c1289
commit 255d1ea5d3
1 changed files with 36 additions and 17 deletions
@@ -1,27 +1,46 @@
-# lonix/nzbdrone
+![http://linuxserver.io](http://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)

+The [LinuxServer.io](http://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](http://forum.linuxserver.io) or for real-time support our [IRC](http://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`.
+
+# linuxserver/sonarr
+
+![](https://sonarr.tv/img/logo.png)
+
+[Sonarr](https://sonarr.tv/) (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
+
+![](https://sonarr.tv/img/slider/qualityprofile.png)
+
+## Usage

-**sample create command:**
 ```
-docker create --name=<name> -v /etc/localtime:/etc/localtime:ro -v <path to data>:/config -v <path to tv>:/tv -v <path to downloads>:/downloads -e PGID=<gid> -e PUID=<uid>  -p 80:80 lonix/nzbdrone:2.0
+docker create \
+	--name sonarr \
+	-p 8989:8989 \
+	-e PUID=<UID> -e PGID=<GID> \
+	-v </path/to/appdata>:/config \
+	-v <path/to/tvseries>:/tv \
+	linuxserver/sonarr
 ```

-**You need to map**
-* PORT: 8989 for Webui
-* MOUNT: /downloads for downloads
-* MOUNT: /etc/localhost for timesync (Not required)
-* MOUNT: /config for Configuration storage
-* MOUNT: /tv for tv-collection
-* VARIABLE: PGID for for GroupID
-* VARIABLE: PUID for for UserID
+**Parameters**

-It is based on phusion-baseimage with ssh removed. (use docker exec).
+* `-p 8989` - the port quassel-core listens for connections on
+* `-v /tv` - database and quassel-core configuration storage
+* `-e PGID` for for GroupID - see below for explanation
+* `-e PUID` for for UserID - see below for explanation

+### 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).
+
+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.  
+
+## Updates / Monitoring
+
+* Upgrade to the latest version of Plex simply `docker restart sonarr`.
+* Monitor the logs of the container in realtime `docker logs -f sonarr`.

 **Credits**
-lonix <lonixx@gmail.com>
-
-**Versions**
-2.0 gid/uid fix. and code cleanup.
-1.0: Inital release

+* lonix <lonixx@gmail.com>
+* IronicBadger <ironicbadger@linuxserver.io>