Youtarr/docker-compose.external-db.yml at main · DialmasterOrg/Youtarr · 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
# IMPORTANT NOTES:
# By default, the youtarr service runs as ROOT (UID 0, GID 0) for compatibility with existing setups.
# For improved security, you can set YOUTARR_UID and YOUTARR_GID environment variables to run the container as a non-root user.
# If you do so, ensure that the following directories exist on the host with the correct ownership/permissions before
# starting the container:
# - ./config
# - ./jobs
# - ./server/images
# - <YOUTUBE_OUTPUT_DIR> (as specified in environment variable)
# Docker will create these directories as ROOT if they do not exist!
#
# To create and set ownership/permissions, you can use the following commands:
# Example (using example YOUTUBE_OUTPUT_DIR of /path/to/youtube_videos and YOUTARR_UID/GID of 1000/1000):
# mkdir -p config jobs server/images /path/to/youtube_videos
# sudo chown -R 1000:1000 config jobs server/images /path/to/youtube_videos

services:
  youtarr:
    image: ${YOUTARR_IMAGE:-dialmaster/youtarr:latest}
    container_name: youtarr
    restart: unless-stopped
    # Optional: Run as specific UID:GID for security (defaults to root if not set per previous behavior)
    user: "${YOUTARR_UID:-0}:${YOUTARR_GID:-0}"

    # Add extra_hosts for connecting to external DB on host
    extra_hosts:
      - "host.docker.internal:host-gateway"

    environment:
      # DEPRECATED but retained for backwards compatibility with old images for now
      IN_DOCKER_CONTAINER: 1
      # Override DB connection settings for external database
      # Enforced for external DB usage
      TZ: ${TZ:-UTC}
      DB_HOST: ${DB_HOST:?Set DB_HOST in .env or environment}
      DB_PORT: ${DB_PORT:-3306}
      DB_USER: ${DB_USER:?Set DB_USER in .env or environment}
      DB_PASSWORD: ${DB_PASSWORD:?Set DB_PASSWORD in .env or environment}
      DB_NAME: ${DB_NAME:-youtarr}
      # Optional: Disable authentication (for platforms with external auth like Elfhosted)
      AUTH_ENABLED: ${AUTH_ENABLED:-}
      # Optional: Enable the separately authenticated versioned external API
      EXTERNAL_API_ENABLED: ${EXTERNAL_API_ENABLED:-false}
      # Optional: Seed initial admin credentials for headless deployments
      AUTH_PRESET_USERNAME: ${AUTH_PRESET_USERNAME:-}
      AUTH_PRESET_PASSWORD: ${AUTH_PRESET_PASSWORD:-}
      # Optional: Configure Express proxy header trust
      TRUST_PROXY: ${TRUST_PROXY:-}
      # Optional external cookies; /app/config uses the existing mount (see docs/CONFIG.md).
      YOUTARR_COOKIES_FILE: ${YOUTARR_COOKIES_FILE:-}
      # Logging configuration
      LOG_LEVEL: ${LOG_LEVEL:-info}
      # Optional: rolling log files in config/logs (defaults: 10MB per file, 5 older files kept)
      LOG_FILE_MAX_SIZE: ${LOG_FILE_MAX_SIZE:-}
      LOG_FILE_MAX_COUNT: ${LOG_FILE_MAX_COUNT:-}
      # Optional: seconds the pre-download write check of the output directory may take (default 10; raise for a slow NFS share)
      OUTPUT_DIR_HEALTHCHECK_TIMEOUT: ${OUTPUT_DIR_HEALTHCHECK_TIMEOUT:-}
      # This is just informational and lets the app know where the videos will be stored on the host
      YOUTUBE_OUTPUT_DIR: ${YOUTUBE_OUTPUT_DIR}
      # Optional: Custom data path for platforms like Elfhosted (defaults to /usr/src/app/data)
      # This is the internal path where videos are downloaded inside the container and is not needed for most users
      # DATA_PATH: /storage/rclone/storagebox/youtube

    ports:
      - "${YOUTARR_HOST_PORT:-3087}:3011"
    volumes:
      - ${YOUTUBE_OUTPUT_DIR}:/usr/src/app/data
      - ./server/images:/app/server/images
      - ./config:/app/config
      - ./jobs:/app/jobs
    healthcheck:
      test: ["CMD", "curl", "--fail", "--silent", "--show-error", "--output", "/dev/null", "http://localhost:3011/api/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 40s

networks:
  default:
    name: youtarr-network