compose.example.yaml

# SemanticDog Docker Compose Example
# https://github.com/kytmanov/semantic-dog
#
# Quick start:
#   1. Replace /path/to/semanticdog/* with your actual paths
#   2. Replace 1000 with your NAS user's UID (find with: id -u)
#   3. Replace America/Your_Timezone with your timezone
#   4. Replace /path/to/your/photos with your actual photo path
#   5. docker compose up -d
#   6. Open http://localhost:8181

services:
  semanticdog:
    image: ghcr.io/kytmanov/semantic-dog:latest
    container_name: semanticdog
    restart: unless-stopped
    # Replace 1000 with your NAS user's UID (e.g., 1000, 568, etc.)
    user: "1000"
    # Security: prevent container from gaining root access
    security_opt:
      - no-new-privileges:true
    ports:
      - "8181:8181"
    environment:
      # Replace with your timezone (e.g., America/Los_Angeles, Europe/London)
      TZ: America/Your_Timezone
    volumes:
      # App data - persists config and scan database across updates
      # Create these directories first and set ownership:
      #   mkdir -p /path/to/semanticdog/config /path/to/semanticdog/state
      #   chown -R 1000 /path/to/semanticdog/config /path/to/semanticdog/state
      - /path/to/semanticdog/config:/data/config
      - /path/to/semanticdog/state:/data/state
      # Your media library - replace with your actual photo path
      - /path/to/your/photos:/Photos:ro

# Named volumes alternative (easier, no permission management):
# - Rename this file to compose.yaml and use: docker compose up -d
# - Named volumes are easier but data is harder to back up manually.
# volumes:
#   sdog-config:
#   sdog-state: