fetcharr/docker-compose.example.yml at main · furey/fetcharr · 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
# Example docker-compose for fetcharr.
#
# Copy to `docker-compose.yml`, then create a `.env` file alongside it with:
#   CONFIG_PATH=/path/to/your/config          # required
#   DATA_PATH=/path/to/your/media             # required
#   CSRF_SECRET=paste-openssl-rand-hex-32     # required (openssl rand -hex 32)
#   PLEX_PREFS_PATH=/path/to/Plex/Preferences.xml   # optional; leave unset if no local Plex
#   TZ=Australia/Sydney
#   PUID=1000
#   PGID=1000
#   FETCHARR_PORT=8124
#
# CONFIG_PATH, DATA_PATH and CSRF_SECRET are required: compose fails fast with a
# message if any is unset, rather than silently mounting the wrong host paths.
#
# `network_mode: host` is required: SSDP/UPnP auto-discovery of the Fetch TV box
# uses multicast on 239.255.255.250:1900, which does NOT traverse Docker's bridge
# network. With host networking the container has no `ports:` mapping — it binds
# directly to ${FETCHARR_PORT} on the host LAN IP.
#
# The optional ad-removal feature (Settings → AD REMOVAL) runs comskip inside
# this container and is CPU-bound: expect minutes of sustained CPU per scanned
# recording. It's niced down, but budget for it on low-power hosts.

services:
  fetcharr:
    container_name: fetcharr
    build: .
    restart: unless-stopped
    network_mode: host
    user: "${PUID:-1000}:${PGID:-1000}"
    environment:
      - NODE_ENV=production
      - PORT=${FETCHARR_PORT:-8124}
      - TZ=${TZ:-UTC}
      - DB_PATH=/config/state.db
      - MEDIA_ROOT=/media/tv
      - CSRF_SECRET=${CSRF_SECRET:?set CSRF_SECRET in your .env (openssl rand -hex 32)}
      # Only set if you want the "Auto-detect from local Plex" button to work:
      - PLEX_PREFS_PATH=/plex-preferences.xml
    volumes:
      - ${CONFIG_PATH:?set CONFIG_PATH in your .env}/fetcharr:/config
      - ${DATA_PATH:?set DATA_PATH in your .env}/media/tv:/media/tv
      # Plex Preferences.xml, read-only, only for the "Auto-detect token" button.
      # Defaults to /dev/null when PLEX_PREFS_PATH is unset, so leaving it blank is
      # safe (the button just degrades). Set it only if Plex runs on this host.
      - ${PLEX_PREFS_PATH:-/dev/null}:/plex-preferences.xml:ro