Files
docker-sonarr/README.md
T

82 lines
4.1 KiB
Markdown
Raw Permalink Normal View History

2016-09-09 20:56:56 +01:00
[linuxserverurl]: https://linuxserver.io
[forumurl]: https://forum.linuxserver.io
2016-10-07 10:33:02 +01:00
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
2015-05-10 15:11:50 +02:00
2016-10-05 12:16:54 +01:00
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
2016-09-09 20:56:56 +01:00
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!
2015-06-26 13:28:58 +01:00
# linuxserver/sonarr
2016-10-20 23:47:02 +01:00
[![](https://images.microbadger.com/badges/image/linuxserver/sonarr.svg)](http://microbadger.com/images/linuxserver/sonarr "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sonarr.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sonarr.svg)][hub][![Build Status](http://jenkins.linuxserver.io:8080/buildStatus/icon?job=Dockers/LinuxServer.io-hub-built/linuxserver-sonarr)](http://jenkins.linuxserver.io:8080/job/Dockers/job/LinuxServer.io-hub-built/job/linuxserver-sonarr/)
2016-08-27 20:41:57 +01:00
[hub]: https://hub.docker.com/r/linuxserver/sonarr/
2015-06-26 13:28:58 +01:00
[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.
2016-08-27 20:46:21 +01:00
[![sonarr](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sonarr-banner.png)][sonarrurl]
[sonarrurl]: https://sonarr.tv/
2016-08-27 20:43:44 +01:00
2015-06-26 13:28:58 +01:00
## Usage
2015-05-10 15:11:50 +02:00
```
2015-06-26 13:28:58 +01:00
docker create \
--name sonarr \
-p 8989:8989 \
-e PUID=<UID> -e PGID=<GID> \
2015-08-28 16:57:36 +12:00
-v /dev/rtc:/dev/rtc:ro \
2015-06-26 13:28:58 +01:00
-v </path/to/appdata>:/config \
-v <path/to/tvseries>:/tv \
2016-07-20 19:54:42 +01:00
-v <path/to/downloadclient-downloads>:/downloads \
2015-06-26 13:28:58 +01:00
linuxserver/sonarr
2015-05-10 15:11:50 +02:00
```
2016-10-17 23:54:31 +01:00
## 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.`
2015-05-10 15:11:50 +02:00
* `-p 8989` - the port sonarr webinterface
2016-07-20 19:57:30 +01:00
* `-v /dev/rtc:/dev/rtc:ro` - map hwclock as ReadOnly (mono throws exceptions otherwise)
2015-06-26 13:33:16 +01:00
* `-v /config` - database and sonarr configs
2015-06-26 13:30:24 +01:00
* `-v /tv` - location of TV library on disk
2015-06-26 13:28:58 +01:00
* `-e PGID` for for GroupID - see below for explanation
* `-e PUID` for for UserID - see below for explanation
2015-05-10 15:11:50 +02:00
2016-07-20 19:56:31 +01:00
It is based on ubuntu xenial with S6 overlay, for shell access whilst the container is running do `docker exec -it sonarr /bin/bash`.
2016-07-20 19:54:42 +01:00
2015-06-26 13:28:58 +01:00
### User / Group Identifiers
2015-05-10 15:11:50 +02:00
2016-07-20 19:54:42 +01:00
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" <sup>TM</sup>.
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
2015-06-26 13:28:58 +01:00
2016-07-20 19:54:42 +01:00
```
$ id <dockeruser>
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
2015-06-26 13:28:58 +01:00
2016-09-09 20:56:56 +01:00
## Setting up the application
Access the webui at `<your-ip>:8989`, for more information check out [Sonarr](https://sonarr.tv/).
2016-07-20 19:48:58 +01:00
## Info
2015-05-10 15:11:50 +02:00
2015-06-26 13:28:58 +01:00
* Monitor the logs of the container in realtime `docker logs -f sonarr`.
2015-08-31 10:41:00 +02:00
## Changelog
2015-05-10 15:11:50 +02:00
2016-09-30 20:27:51 +01:00
+ **30.09.16:** Fix umask
2016-09-23 05:01:34 +01:00
+ **23.09.16:** Add cd to /opt fixes redirects with althub (issue #25)
, make XDG config environment variable
2016-09-15 23:56:10 +01:00
+ **15.09.16:** Add libcurl3 package.
2016-09-09 20:56:56 +01:00
+ **09.09.16:** Add layer badges to README.
2016-08-27 20:49:41 +01:00
+ **27.08.16:** Add badges to README.
2016-07-20 19:48:58 +01:00
+ **20.07.16:** Rebase to xenial.
+ **31.08.15:** Cleanup, changed sources to fetch binarys from. also a new baseimage.