From cd5ec951189d72772c175149662688d44947cd6b Mon Sep 17 00:00:00 2001 From: IronicBadger Date: Thu, 4 Feb 2016 09:07:00 +0000 Subject: [PATCH 1/8] Completely redone readme --- README.md | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 744ee9c..5b7d6cb 100644 --- a/README.md +++ b/README.md @@ -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 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 @@ -12,7 +15,7 @@ The [LinuxServer.io](https://linuxserver.io) team brings you another quality con ``` docker create \ - --name=plex \ + --name=plex \ --net=host \ -e VERSION=plexpass \ -e PUID= -e PGID= \ @@ -29,20 +32,33 @@ docker create \ * `-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 /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 PGID` for for GroupID - see below for explanation -* `-e PUID` for for UserID - see below for explanation +* `-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 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 -**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" TM. -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 -* Upgrade to the latest version of Plex simply `docker restart plex`. -* Monitor the logs of the container in realtime `docker logs -f plex`. +* Shell access whilst the container is running: `docker exec -it plex /bin/bash` +* Upgrade to the latest version: `docker restart plex` +* To monitor the logs of the container in realtime: `docker logs -f plex` ## Changelog From 4d810379d17ab76331c243b8e039684810423ac4 Mon Sep 17 00:00:00 2001 From: IronicBadger Date: Thu, 4 Feb 2016 09:10:49 +0000 Subject: [PATCH 2/8] fixed tabs --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5b7d6cb..26f67a6 100644 --- a/README.md +++ b/README.md @@ -38,12 +38,12 @@ docker create \ *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 + -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 @@ -51,8 +51,8 @@ Sometimes when using data volumes (`-v` flags) permissions issues can arise betw 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) + $ id dockeruser + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ## Updates / Monitoring From e0a2f3a9a0f968c0214807b80d9de61b3f0550d4 Mon Sep 17 00:00:00 2001 From: IronicBadger Date: Thu, 4 Feb 2016 09:12:44 +0000 Subject: [PATCH 3/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 26f67a6..6025366 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The [LinuxServer.io](https://linuxserver.io) team brings you another container r [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) +![](http://i2.wp.com/moonbooks.net/wp-content/uploads/2014/12/plex-logo-dark-small-77202045f47146129647bee8b1cac77c.png?resize=770%2C250) ## Usage From bbaee2a6c5e7aa6af150c94106fca2b27d507d97 Mon Sep 17 00:00:00 2001 From: IronicBadger Date: Thu, 4 Feb 2016 09:13:23 +0000 Subject: [PATCH 4/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6025366..6025287 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The [LinuxServer.io](https://linuxserver.io) team brings you another container r [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. -![](http://i2.wp.com/moonbooks.net/wp-content/uploads/2014/12/plex-logo-dark-small-77202045f47146129647bee8b1cac77c.png?resize=770%2C250) +![https://plex.tv](https://press.plex.tv/wp-content/themes/plex-press/img/assets/plex-pms-icon.png) ## Usage From e6bed648e8ff4fba15b9ae19e0e33bf4e75bdbea Mon Sep 17 00:00:00 2001 From: IronicBadger Date: Thu, 4 Feb 2016 09:14:00 +0000 Subject: [PATCH 5/8] Changed logo to a smaller one --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6025287..dc525f7 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The [LinuxServer.io](https://linuxserver.io) team brings you another container r [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://plex.tv](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 From 9acc8c1c79a82d1a9ed149fc87b904c03e13e343 Mon Sep 17 00:00:00 2001 From: IronicBadger Date: Thu, 4 Feb 2016 09:14:48 +0000 Subject: [PATCH 6/8] fixed github markdown strangeness --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index dc525f7..5c799bf 100644 --- a/README.md +++ b/README.md @@ -38,12 +38,14 @@ docker create \ *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 @@ -51,8 +53,10 @@ Sometimes when using data volumes (`-v` flags) permissions issues can arise betw 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 From 61f7647160e0c1ea7e755e1b5d16097b8bfee72a Mon Sep 17 00:00:00 2001 From: sparklyballs Date: Thu, 4 Feb 2016 09:20:49 +0000 Subject: [PATCH 7/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c799bf..7069ffe 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Sometimes when using data volumes (`-v` flags) permissions issues can arise betw In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: ``` - $ id dockeruser + $ `id ` uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` From de5fe15d2339773f87c603788fa568ce2cb4ce5c Mon Sep 17 00:00:00 2001 From: sparklyballs Date: Thu, 4 Feb 2016 09:21:28 +0000 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7069ffe..bcdba3d 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Sometimes when using data volumes (`-v` flags) permissions issues can arise betw In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: ``` - $ `id ` + $ id uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ```