docker-compose.example.yml

---
name: calendarr
# ‼️ RENAME THIS FILE TO docker-compose.yml SHOULD YOU WISH TO USE IT

# ╔══════════════════════════════════════╗
# ║               SERVICES               ║
# ╚══════════════════════════════════════╝
services:
  calendarr:
    image: ghcr.io/khw315/calendarr:latest
    restart: "unless-stopped"
    container_name: calendarr
    ports:
      - "5000:5000" # Web UI - Access at http://localhost:5000
    volumes:
      # Mount config directory to save settings from Web UI
      - ./calendarr/config:/app/config:rw
      # Mount logs directory (optional but recommended)
      - ./calendarr/logs:/app/logs:rw
      # Mount custom footers directory (required if ENABLE_CUSTOM_*_FOOTER is true)
      - ./calendarr/custom_footers:/app/custom_footers:rw

    healthcheck:
      # You can delete this if  you don't care about healthchecks
      test: [ "CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:5000/health')" ]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 20s