rclone-manager/docker-compose.yml at master · Zarestia-Dev/rclone-manager · 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
# =============================================================================
# RClone Manager — Docker Compose
# =============================================================================
# Quick start:
#   docker compose up -d
#   Open http://localhost:8080
#
# For advanced configuration (auth, TLS, host networking):
#   https://hakanismail.info/zarestia/rclone-manager/docs/configuration-headless
# =============================================================================

services:
  rclone-manager:
    image: ghcr.io/zarestia-dev/rclone-manager:latest
    container_name: rclone-manager
    restart: unless-stopped

    ports:
      - '8080:8080'
      # Uncomment below if you need OAuth authentication for cloud remotes
      # (Google Drive, OneDrive, Dropbox, etc.)
      # Alternatively, use 'network_mode: host' — see docs for details.
      # - "53682:53682"

    volumes:
      - rclone-data:/data # App data & rclone binary (auto-downloaded on first run)
      - rclone-config:/config # rclone.conf

    environment:
      # Match these to your host user to avoid permission issues on mounted volumes.
      # Run 'id' in your terminal to find your UID/GID.
      - PUID=1000
      - PGID=1000
      # - PGIDS=1000,3000 # Optional: Supplementary group IDs (comma-separated) for NFSv4 ACLs / ZFS mounts

      # --- Optional: Master Secret / rcman Encrypted Credentials ---
      # Master password for rcman encrypted credentials store (remote passwords, tokens).
      # Optional: containers have no OS keyring, so without it secrets are kept in memory
      # only and must be re-entered after every restart. Set it to persist them.
      # - RCLONE_MANAGER_SECRET=MySuperSecretPassword123!
      # - RCLONE_MANAGER_SECRET_PATH=/data/.secret # Path to secret file (must exist before starting container)

      # --- Optional: Basic Authentication ---
      # Uncomment and fill in to password-protect the web UI.
      # Most users behind a reverse proxy (NPM, Traefik) don't need this.
      # - RCLONE_MANAGER_USER=admin
      # - RCLONE_MANAGER_PASS=changeme

      # --- Optional: HTTPS/TLS ---
      # Mount your certs and uncomment these to enable HTTPS directly.
      # - RCLONE_MANAGER_TLS_CERT=/app/certs/cert.pem
      # - RCLONE_MANAGER_TLS_KEY=/app/certs/key.pem

    # --- Optional: TLS cert volume ---
    # Uncomment if using the TLS options above.
    # volumes:
    #   - ./certs:/app/certs:ro

    # --- Optional: Host networking ---
    # Uncomment to fix OAuth browser authentication (Google Drive, OneDrive, etc.)
    # When enabled, remove the 'ports' section above — it's not needed.
    # network_mode: host

    # --- Optional: FUSE Mounting on Host ---
    # Uncomment if you want to mount cloud remotes directly to your host filesystem from inside Docker.
    # Note: To propagate mounts to the host, bind-mount a host folder with 'rshared' propagation.
    # devices:
    #   - /dev/fuse:/dev/fuse
    # cap_add:
    #   - SYS_ADMIN
    # security_opt:
    #   - apparmor:unconfined
    # volumes:
    #   - /mnt/remotes:/mnt/remotes:rshared

    healthcheck:
      test: ['CMD', 'curl', '-sf', 'http://localhost:8080/health']
      interval: 30s
      timeout: 5s
      retries: 3
      start_period: 15s

volumes:
  rclone-data:
    name: rclone-manager-data
  rclone-config:
    name: rclone-manager-config