LunarDump/config.example.yaml at main · LunarPy-Labs/LunarDump · 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
version: "1.0"
backup:
  name: "production-postgres-daily"
  # Optional Daemon Schedule Pattern:
  # Examples: "day-2" (daily 02:00), "day-14.5" (daily 14:30), "week-14.5" (weekly), "month-1-2" (monthly), "every-15m", "0 2 * * *"
  # cron: "day-2"
  database:
    type: "postgres" # Options: postgres | mysql | mongo
    host: "localhost"
    port: 5432
    name: "main_db"
    user: "postgres"
    password_env: "DB_PASSWORD" # Environment variable name holding database password

  security:
    encrypt: true
    algorithm: "aes-256-gcm"
    key_env: "LUNARDUMP_ENCRYPTION_KEY" # Env var name, key file path, or raw hex key string

  storage:
    # Target storage provider options:
    # - "s3"    : AWS S3, Cloudflare R2, MinIO, Wasabi, DigitalOcean Spaces
    # - "gcs"   : Google Cloud Storage (Requires GOOGLE_APPLICATION_CREDENTIALS in .env or environment)
    # - "local" : Local server directory path
    provider: "s3"

    # Bucket name for cloud storage (S3/GCS), or root folder path for local storage (e.g., "/var/backups")
    bucket: "company-db-backups"

    # Storage region (Required for AWS S3; optional for GCS or Local)
    region: "ap-southeast-1"

    # Remote folder path prefix inside the bucket where backup files (.enc) will be stored
    path: "daily/postgres/"

    # Retention policy: automatic purge of backup archives older than the specified days
    retention_days: 30

    # Custom S3 endpoint URL (Required ONLY for MinIO, Cloudflare R2, or custom S3-compatible providers)
    # Examples:
    # - Cloudflare R2: "https://<ACCOUNT_ID>.r2.cloudflarestorage.com"
    # - MinIO        : "http://minio.internal:9000"
    endpoint_url: ""

  notifications:
    on_success: true
    on_failure: true

    # Notification Channels:
    # - Must contain AT LEAST 1 channel or CAN contain MULTIPLE channels (e.g. Telegram + Slack together).
    # - Supported types: "telegram" and "slack".
    channels:
      - type: "telegram"
        bot_token_env: "TELEGRAM_BOT_TOKEN" # Env var name or direct bot token string
        chat_id: "-100123456789"
      - type: "slack"
        webhook_url_env: "SLACK_WEBHOOK_URL" # Env var name or direct webhook URL