bring README into this century, lol

This commit is contained in:
sparklyballs 2016-07-20 19:54:42 +01:00
parent 6b76c06ea4
commit e2c5c51a26

View File

@ -1,6 +1,9 @@
![https://linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
The [LinuxServer.io](https://linuxserver.io) team brings you another quality container release featuring easy user mapping and community support. Be sure to checkout our [forums](https://forum.linuxserver.io) 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 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/sonarr
@ -18,7 +21,7 @@ docker create \
-v /dev/rtc:/dev/rtc:ro \
-v </path/to/appdata>:/config \
-v <path/to/tvseries>:/tv \
-v <path/to/downloadclient-downloads>:/downloads \
-v <path/to/downloadclient-downloads>:/downloads \
linuxserver/sonarr
```
@ -31,11 +34,18 @@ docker create \
* `-e PGID` for for GroupID - see below for explanation
* `-e PUID` for for UserID - see below for explanation
It is based on ubuntu xenial with S6 overlay, for shell access whilst the container is running do `docker exec -it musicbrainz /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" <sup>TM</sup>.
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 <dockeruser>
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
## Info