Merge pull request #23 from linuxserver/update_readme

Completely redone readme
pull/24/head
sparklyballs 9 years ago
commit cf11595e73

@ -1,18 +1,21 @@
![https://linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png) ![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 auto-update on startup, 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 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/plex # linuxserver/plex
[Plex](https://plex.tv/) organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server. [Plex](https://plex.tv/) organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server.
![](https://press.plex.tv/wp-content/themes/plex-press/img/assets/plex-pms-icon.png) ![https://plex.tv](http://i2.wp.com/moonbooks.net/wp-content/uploads/2014/12/plex-logo-dark-small-77202045f47146129647bee8b1cac77c.png?resize=770%2C250)
## Usage ## Usage
``` ```
docker create \ docker create \
--name=plex \ --name=plex \
--net=host \ --net=host \
-e VERSION=plexpass \ -e VERSION=plexpass \
-e PUID=<UID> -e PGID=<GID> \ -e PUID=<UID> -e PGID=<GID> \
@ -29,20 +32,37 @@ docker create \
* `-v /config` - Plex library location. *This can grow very large, 50gb+ is likely for a large collection.* * `-v /config` - Plex library location. *This can grow very large, 50gb+ is likely for a large collection.*
* `-v /transcode` *(optional)* - Transcode directory to offload heavy writes in a docker container. * `-v /transcode` *(optional)* - Transcode directory to offload heavy writes in a docker container.
* `-v /data/xyz` - Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. * `-v /data/xyz` - Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc.
* `-e VERSION=` - Set this to a full version number if you want to use a specific version e.g. `0.9.12.4.1192-9a47d21`, or set it to `plexpass` or `latest` * `-e VERSION=` - *(optional)* - Permits specific version selection e.g. `0.9.12.4.1192-9a47d21`, also supports `plexpass` or `latest`
* `-e PGID` for for GroupID - see below for explanation * `-e PGID=` for for GroupID - see below for explanation
* `-e PUID` for for UserID - see below for explanation * `-e PUID=` for for UserID - see below for explanation
*Special note* - If you'd like to run Plex without requiring `--net=host` then you will need the following ports in your `docker create` command:
```
-p 32400:32400 \
-p 32400:32400/udp \
-p 32469:32469 \
-p 32469:32469/udp \
-p 5353:5353/udp \
-p 1900:1900/udp
```
### User / Group Identifiers ### 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)
```
## Updates / Monitoring ## Updates / Monitoring
* Upgrade to the latest version of Plex simply `docker restart plex`. * Shell access whilst the container is running: `docker exec -it plex /bin/bash`
* Monitor the logs of the container in realtime `docker logs -f plex`. * Upgrade to the latest version: `docker restart plex`
* To monitor the logs of the container in realtime: `docker logs -f plex`
## Changelog ## Changelog

Loading…
Cancel
Save