plex/compose.yaml at main · daemonless/plex · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
name: plex

x-daemonless:
  title: "Plex Media Server"
  icon: ":simple-plex:"
  category: "Media Servers"
  description: "Personal media server that organizes and streams your movie, TV, and music collections to all your devices."
  upstream_url: "https://github.com/daemonless/plex"
  web_url: "https://plex.tv/"
  user: "bsd"
  mlock: false
  appjail: true

  docs:
    env:
      PUID: "User ID for the application process"
      PGID: "Group ID for the application process"
      TZ: "Timezone for the container"
      VERSION: "Plex update channel (container, public, plexpass)"
      PLEX_CLAIM:
        desc: "Claim token — get one at https://plex.tv/claim"
        optional: true
        level: primary
      ADVERTISE_IP:
        desc: "URLs clients should use to reach the server, comma-separated, e.g. http://192.168.1.10:32400 (bridge networking)"
        optional: true
      ALLOWED_NETWORKS:
        desc: "Networks allowed in without signing in, comma-separated, e.g. 192.168.1.0/24"
        optional: true
        level: primary
    volumes:
      /config: "Configuration directory"
      /transcode:
        desc: "Transcode directory"
        optional: true
      /movies:
        desc: "Movie library"
      /tv:
        desc: "TV series library"
    ports:
      32400: "Web UI"

  notes: |
    ## First-time setup

    An unclaimed Plex server only accepts its setup wizard from `127.0.0.1`; from anywhere else
    it answers "Not authorized". Set one of these before the first start:

    - `ALLOWED_NETWORKS` to your LAN (e.g. `192.168.1.0/24`), then open `http://<host>:32400/web`,
      sign in and finish the wizard. Devices on those networks can use Plex without signing in.
    - `PLEX_CLAIM` to a token from https://plex.tv/claim. The container claims the server on
      first start; then sign in at `http://<host>:32400/web`. Tokens expire 4 minutes after you
      get one: fetch it right before the first start.

    Set `ADVERTISE_IP` to the address clients should use (e.g. `http://192.168.1.10:32400`), so
    Plex doesn't advertise its container-internal IP.

    `PLEX_CLAIM`, `ADVERTISE_IP` and `ALLOWED_NETWORKS` work as in the official Plex image.

    ## Host networking (optional)

    `network_mode: host` (`--network host`) additionally lets Plex apps on your LAN discover the
    server (GDM) and enables DLNA. Use it instead of the `32400` port mapping where your platform
    supports it.

services:
  plex:
    image: ghcr.io/daemonless/plex:latest
    container_name: plex
    restart: unless-stopped
    ports:
      - 32400:32400

    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - VERSION=container
      - PLEX_CLAIM=
      - ADVERTISE_IP=
      - ALLOWED_NETWORKS=

    volumes:
      - /path/to/containers/plex:/config
      - /path/to/transcode:/transcode # optional
      - /path/to/movies:/movies
      - /path/to/tv:/tv