From f1b448cae84603122682bfc350478c553633edaa Mon Sep 17 00:00:00 2001 From: Alex Kretzschmar Date: Tue, 16 Jun 2015 09:52:39 +0100 Subject: [PATCH] Documentation update --- README.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 1df300d..de476ab 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,35 @@ +![http://linuxserver.io](http://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png) + +The [LinuxServer.io](http://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](http://forum.linuxserver.io) or for real-time support our [IRC](http://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`. + # linuxserver/plex -##Description: -This Continer is self-contained [Plex](https://plex.tv/) Container. +[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/assets/img/everywhere-img-en-2023ecb8d6373416cf9e7dc247d83951.jpg) -####[Plex](https://plex.tv/) -Plex organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. It is a media player system and software suite consisting of many player applications for 10-foot user interfaces and an associated media server that organizes personal media stored on local devices. It is available for Windows, Linux, OS X and FreeBSD.[1] Integrated Plex Channels provide users with access to a growing number of online content providers such as YouTube, Vimeo, TEDTalks, and CNN among others. Plex also provides integration for cloud services[2] including Dropbox, Box, Google Drive, Copy and Bitcasa.[3] +## Usage +``` +docker create --name=plex --net=host -e PLEXPASS=1 -e PUID= -e PGID= -v :/config -v :/data/tvshows -v :/data/movies linuxserver/plex +``` -##Ports and mappings: +**Parameters** -- **--net=host** Must be set for this container to work -- **/config** Will store your plex library\plugins and related files -- **/data/*** Map as many as you need for your media library -- **PUID** What UID it will run under. -- **PGID** What GID it wil run under. -- **PLEXPASS** Set to 1 if you have a plexpass subscription. otherwise blank (non-exsistent) +* `--net=host` - Shares host networking with container, **required**. +* `-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 +## Updates -## Sample create command: +* Upgrade to the latest version simply `docker restart plex`. +* To monitor the logs of the container in realtime `docker logs -f plex`. -``` -docker create --name= --net=host -e PUID= -e PGID= -v :/config -v :/data/tvshows -v :/data/film linuxserver/plex -``` -## Support at: +**Credits** -- [linuxserver.io](http://linuxserver.io) -- #linuxserver.io@freenode \ No newline at end of file +* lonix +* IronicBadger \ No newline at end of file