mirror of
https://github.com/spritsail/plex-media-server.git
synced 2024-11-05 09:26:22 +00:00
83 lines
4.9 KiB
Markdown
83 lines
4.9 KiB
Markdown
[hub]: https://hub.docker.com/r/spritsail/plex-media-server
|
|
[git]: https://github.com/spritsail/plex-media-server/tree/pass
|
|
[drone]: https://drone.spritsail.io/spritsail/plex-media-server
|
|
|
|
# [spritsail/plex-media-server][hub]
|
|
|
|
[][git]
|
|
[][hub]
|
|
[][hub]
|
|
[][hub]
|
|
[][drone]
|
|
|
|
The _smallest*_ Plex Media Server docker image, built `FROM scratch` with musl provided by Plex and supporting libraries and binaries built from source. The container hosts a fully featured Plex Media Server, with almost all of the useless crap removed, resulting in the smallest container possible whilst maintaining full functionality.
|
|
|
|
_*last we checked_
|
|
|
|
## Getting Started
|
|
|
|
Navigate to [plex.tv/claim](https://www.plex.tv/claim) and obtain a token in the form `claim-xxxx...`
|
|
|
|
Start the container, as demonstrated below, passing the claim token via the `PLEX_CLAIM` environment variable. This only has to be present on the first run (when the configuration is generated/if you need to re-claim the server at any time) and can be removed for subsequent runs. _The Plex claim token is optional however it will make the server available to your account immediately._
|
|
|
|
Setting the container hostname on first boot will set the Plex server name.
|
|
|
|
```shell
|
|
docker run -dt \
|
|
--name=plex \
|
|
--restart=unless-stopped \
|
|
--hostname=my-plex-server \
|
|
-p 32400:32400 \
|
|
-e PLEX_CLAIM=claim-xxxx... \
|
|
-v /config/plex:/config \
|
|
-v /transcode:/transcode \
|
|
-v /media:/media \
|
|
spritsail/plex-media-server
|
|
```
|
|
|
|
Finally, navigate to [app.plex.tv/desktop](https://app.plex.tv/desktop) or [your-ip:32400/web](http://localhost:32400/web) and you're done!
|
|
|
|
|
|
### Volumes
|
|
|
|
- `/config` - Configuration, logs, caches and other Plex crap. You should keep this
|
|
- `/transcode` - Transcoder temporary directory. This should be backed by fast storage, ideally tmpfs/RAM.
|
|
- Don't forget to mount your media (tv-shows/movies) inside the container too!
|
|
|
|
### Environment
|
|
|
|
- `$SUID` - User ID to run as _default: 900_
|
|
- `$SGID` - Group ID to run as _default: 900_
|
|
- `$ALLOWED_NETWORKS` - IP/netmask entries which allow access to the server without requiring authorization. We recommend you set this only if you do not sign in your server. For example `192.168.1.0/24,172.16.0.0/16` will allow access to the entire `192.168.1.x` range and the `172.16.x.x` range.
|
|
- `$ADVERTISE_IP` - This variable defines the additional IPs on which the server may be be found. For example: `http://10.1.1.23:32400`. This adds to the list where the server advertises that it can be found.
|
|
- `$DISABLE_REMOTE_SEC` -
|
|
- `$PLEX_CLAIM` - The claim token for the server to obtain a real server token. If not provided, server will not be automatically logged in. If server is already logged in, this parameter is ignored.
|
|
- `$LOG_DEBUG` - Disables debug logging if set to 0, and enables it if set to 1. This overwrites preferences set in the Plex Web user interface.
|
|
- `$LOG_VERBOSE` - Disables logging (except warnings and errors) if set to 0, and enables it if set to 1. This overwrites preferences set in the Plex Web user interface.
|
|
|
|
### Network
|
|
|
|
The following ports are all used by Plex for various applications
|
|
|
|
- `32400/tcp` Plex Web/Client Access
|
|
- `5353/udp` Bonjour/Avahi
|
|
- `3005/tcp` Plex Home Theatre via Plex Companion
|
|
- `8324/tcp` Plex for Roku via Plex Companion
|
|
- `1900/udp` Plex DLNA Server
|
|
- `32469/udp` Plex DLNA Server
|
|
- `32410/udp` GDM network discovery
|
|
- `32412/udp` GDM network discovery
|
|
- `32413/udp` GDM network discovery
|
|
- `32414/udp` GDM network discovery
|
|
|
|
See also: https://support.plex.tv/articles/201543147-what-network-ports-do-i-need-to-allow-through-my-firewall/
|
|
|
|
At the very least, you should expose `32400/tcp` to your network, and _port forward_ it through your router if you would like Plex access outside your home network.
|
|
|
|
If you wish, you can map the Plex port to any other port outside your network, just be sure to update the port in _Settings > Server > Remote Access_ (Show Advanced) under _Manually specify public port_.
|
|
|
|
## Troubleshooting
|
|
|
|
* **Help, I accidentally logged my server out and I can no longer access it**
|
|
Just get another claim token from [plex.tv/claim](https://www.plex.tv/claim) and restart the container with it in the environment variable PLEX_CLAIM. This should re-claim your server and it'll appear in your server list once again. You can remove the claim token as soon as the server has been claimed- _they expire after 5 minutes anyway_
|