From e451f1749874e53451626d8163570b772c0d3667 Mon Sep 17 00:00:00 2001 From: Alex Kretzschmar Date: Tue, 16 Jun 2015 10:53:19 +0100 Subject: [PATCH] Added PGID and PUID explanations to docs --- README.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index de476ab..fef62fb 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,15 @@ The [LinuxServer.io](http://linuxserver.io) team brings you another quality cont ## Usage ``` -docker create --name=plex --net=host -e PLEXPASS=1 -e PUID= -e PGID= -v :/config -v :/data/tvshows -v :/data/movies linuxserver/plex +docker create + --name=plex \ + --net=host \ + -e PLEXPASS=1 \ + -e PUID= -e PGID= \ + -v :/config \ + -v :/data/tvshows \ + -v :/data/movies \ + linuxserver/plex ``` **Parameters** @@ -20,8 +28,21 @@ docker create --name=plex --net=host -e PLEXPASS=1 -e PUID= -e PGID= - * `-v` /config - Plex library location. *This can grow very large, 50gb+ is likely for a large collection.* * `-v` /data/xyz - Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. * `-e` PLEXPASS=1 - Set to 1 if you have a Plex Pass, if not don't specify it. -* `-e` PGID for for GroupID -* `-e` PUID for for UserID +* `-e` PGID for for GroupID - see below for explanation +* `-e` PUID for for UserID - see below for explanation + +### User / Group Identifiers + +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. + +In summary 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). + +#### unRAID notes + +If you wish to run this container on unRAID use the following values: + +* `-e PUID=99` (nobody) +* `-e PGID=100` (users) ## Updates @@ -32,4 +53,6 @@ docker create --name=plex --net=host -e PLEXPASS=1 -e PUID= -e PGID= - **Credits** * lonix -* IronicBadger \ No newline at end of file +* IronicBadger + +Auto-updating Ubuntu (phusion) based Plex Media Server container, brought to you by LinuxServer.io \ No newline at end of file