Skip to content

Commit cf11595

Browse files
committed
Merge pull request #23 from linuxserver/update_readme
Completely redone readme
2 parents 64169dd + de5fe15 commit cf11595

1 file changed

Lines changed: 30 additions & 10 deletions

File tree

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
![https://linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
22

3-
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`.
3+
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:
4+
* [forum.linuxserver.io](https://forum.linuxserver.io)
5+
* [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`
6+
* [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!
47

58
# linuxserver/plex
69

710
[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.
811

9-
![](https://press.plex.tv/wp-content/themes/plex-press/img/assets/plex-pms-icon.png)
12+
![https://plex.tv](http://i2.wp.com/moonbooks.net/wp-content/uploads/2014/12/plex-logo-dark-small-77202045f47146129647bee8b1cac77c.png?resize=770%2C250)
1013

1114
## Usage
1215

1316
```
1417
docker create \
15-
--name=plex \
18+
--name=plex \
1619
--net=host \
1720
-e VERSION=plexpass \
1821
-e PUID=<UID> -e PGID=<GID> \
@@ -29,20 +32,37 @@ docker create \
2932
* `-v /config` - Plex library location. *This can grow very large, 50gb+ is likely for a large collection.*
3033
* `-v /transcode` *(optional)* - Transcode directory to offload heavy writes in a docker container.
3134
* `-v /data/xyz` - Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc.
32-
* `-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`
33-
* `-e PGID` for for GroupID - see below for explanation
34-
* `-e PUID` for for UserID - see below for explanation
35+
* `-e VERSION=` - *(optional)* - Permits specific version selection e.g. `0.9.12.4.1192-9a47d21`, also supports `plexpass` or `latest`
36+
* `-e PGID=` for for GroupID - see below for explanation
37+
* `-e PUID=` for for UserID - see below for explanation
38+
39+
*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:
40+
41+
```
42+
-p 32400:32400 \
43+
-p 32400:32400/udp \
44+
-p 32469:32469 \
45+
-p 32469:32469/udp \
46+
-p 5353:5353/udp \
47+
-p 1900:1900/udp
48+
```
3549

3650
### User / Group Identifiers
3751

38-
**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).
52+
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>.
3953

40-
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.
54+
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
55+
56+
```
57+
$ id <dockeruser>
58+
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
59+
```
4160

4261
## Updates / Monitoring
4362

44-
* Upgrade to the latest version of Plex simply `docker restart plex`.
45-
* Monitor the logs of the container in realtime `docker logs -f plex`.
63+
* Shell access whilst the container is running: `docker exec -it plex /bin/bash`
64+
* Upgrade to the latest version: `docker restart plex`
65+
* To monitor the logs of the container in realtime: `docker logs -f plex`
4666

4767
## Changelog
4868

0 commit comments

Comments
 (0)