ea00130d08
Some checks failed
CI / Test (push) Successful in 2m44s
CI / Build (push) Successful in 1m32s
CI / Build-1 (push) Successful in 1m57s
CI / Build-2 (push) Successful in 1m32s
CI / Build-3 (push) Successful in 1m32s
CI / Build-4 (push) Successful in 1m32s
CI / Build-5 (push) Successful in 1m29s
CI / Lint (push) Failing after 2m24s
CI / Coverage (push) Successful in 2m44s
CI / Vet (push) Successful in 1m59s
Rewrite docker-compose.yml with a user-ready setup: - pull_policy: always — keeps image up-to-date on every `up` - network_mode: host — required for LAN/Tailscale streaming reach - UNARR_API_KEY required variable with clear error message - DOWNLOAD_DIR required variable - named `unarr-data` volume for piece-DB + HLS cache (keeps them off NFS) - macOS/Windows bridge + ports alternative in comments - .env.example alongside with UNARR_API_KEY, DOWNLOAD_DIR, TZ Quick start: cp .env.example .env && edit .env && docker compose up -d
65 lines
2.3 KiB
YAML
65 lines
2.3 KiB
YAML
# unarr — TorrentClaw agent
|
|
#
|
|
# Quick start:
|
|
# 1. Copy this file to any directory.
|
|
# 2. Set UNARR_API_KEY to your key (Settings → API Keys on torrentclaw.com).
|
|
# 3. Set DOWNLOAD_DIR to your media folder (absolute path).
|
|
# 4. Run: docker compose up -d
|
|
#
|
|
# Get your API key: https://torrentclaw.com/settings/api-keys
|
|
# Full docs: https://torrentclaw.com/unarr
|
|
|
|
services:
|
|
unarr:
|
|
image: torrentclaw/unarr:latest
|
|
pull_policy: always # always pull on `up` so you stay on the latest release
|
|
container_name: unarr
|
|
restart: unless-stopped
|
|
|
|
# host network is required for:
|
|
# - streaming to reach your TV / mobile / other LAN devices (port 11818)
|
|
# - HLS transcode server (port 11819)
|
|
# - Tailscale connectivity (if you use it)
|
|
# On macOS / Windows Docker Desktop, replace with `ports` mapping (see below).
|
|
network_mode: host
|
|
|
|
environment:
|
|
# --- Required ---
|
|
- UNARR_API_KEY=${UNARR_API_KEY:?Set UNARR_API_KEY in .env or export it}
|
|
|
|
# --- Optional ---
|
|
# Server URL — change only if you run a self-hosted TorrentClaw instance
|
|
- UNARR_API_URL=${UNARR_API_URL:-https://torrentclaw.com}
|
|
- TZ=${TZ:-UTC}
|
|
|
|
volumes:
|
|
# Config: config.toml is auto-created here on first run.
|
|
# After first start, edit this file to set organize paths, quality, etc.
|
|
- ${CONFIG_DIR:-./config}:/config
|
|
|
|
# Downloads: where finished media is saved.
|
|
# Set DOWNLOAD_DIR in .env or export it before running.
|
|
- ${DOWNLOAD_DIR:?Set DOWNLOAD_DIR to your media folder}:/downloads
|
|
|
|
# Data: piece-completion DB, HLS cache, DHT nodes.
|
|
# Named volume keeps this off your media drive (avoids NFS locking issues).
|
|
- unarr-data:/data
|
|
|
|
# Optional: limit CPU/RAM for transcoding on shared hosts
|
|
# deploy:
|
|
# resources:
|
|
# limits:
|
|
# memory: 2G
|
|
# cpus: "4.0"
|
|
|
|
# --- macOS / Windows alternative (replace network_mode: host above) ---
|
|
# network_mode: bridge
|
|
# ports:
|
|
# - "11818:11818" # direct stream (VLC, download)
|
|
# - "11819:11819" # HLS transcode (web player)
|
|
# - "42069:42069" # BitTorrent incoming peers
|
|
# Note: streaming will only reach devices on the same machine.
|
|
# For LAN / Tailscale playback use a Linux host with network_mode: host.
|
|
|
|
volumes:
|
|
unarr-data:
|