.env.example

# ═══════════════════════════════════════════════════════════════════════════════
# GitHub Backup - Environment Configuration
# ═══════════════════════════════════════════════════════════════════════════════
# Copy this file to .env and fill in your values
# ═══════════════════════════════════════════════════════════════════════════════

# ───────────────────────────────────────────────────────────────────────────────
# GitHub Configuration
# ───────────────────────────────────────────────────────────────────────────────

# Organization or username to backup
GITHUB_OWNER=my-organization

# ─────────────────────────────────────────────────────────────────────────────
# Authentication Mode
# ─────────────────────────────────────────────────────────────────────────────
#
# ┌─────────────────┬──────────────────────┬─────────────────────────────────┐
# │ Mode            │ GITHUB_PAT           │ What you get                    │
# ├─────────────────┼──────────────────────┼─────────────────────────────────┤
# │ Authenticated   │ Set (ghp_xxx...)     │ Private + public repos          │
# │                 │                      │ 5000 requests/hour              │
# │                 │                      │ Full metadata (issues, PRs)     │
# ├─────────────────┼──────────────────────┼─────────────────────────────────┤
# │ Unauthenticated │ Empty or not set     │ Public repos ONLY               │
# │                 │                      │ 60 requests/hour                │
# │                 │                      │ Basic metadata only             │
# └─────────────────┴──────────────────────┴─────────────────────────────────┘
#
# For public repos only: Leave GITHUB_PAT empty or comment it out
# GITHUB_PAT=
#
# ─────────────────────────────────────────────────────────────────────────────
# Personal Access Token (PAT) - Required for private repos
# ─────────────────────────────────────────────────────────────────────────────
#
# CLASSIC PAT (Settings > Developer settings > Personal access tokens > Tokens (classic))
# ─────────────────────────────────────────────────────────────────────────────
# Required scopes:
#   [x] repo              - Full repository access (required for private repos)
#       OR public_repo    - Public repositories only (if no private repos)
#   [x] read:org          - Read organization membership (required for org backups)
#
# FINE-GRAINED PAT (Settings > Developer settings > Personal access tokens > Fine-grained tokens)
# ─────────────────────────────────────────────────────────────────────────────
# Resource owner: Select your organization or personal account
# Repository access: "All repositories" or select specific repos
#
# Repository permissions (all Read-only):
#   [x] Contents          - Clone repositories (includes wiki via git)
#   [x] Issues            - Export issues and comments
#   [x] Pull requests     - Export pull requests
#   [x] Metadata          - Basic repository info (automatically included)
#
# All permissions above should be set to "Read-only" - no write access needed.
# No organization permissions required.
#
# ─────────────────────────────────────────────────────────────────────────────
GITHUB_PAT=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# Include private repositories (requires PAT with 'repo' scope)
# Ignored in unauthenticated mode (no private repos accessible)
GITHUB_BACKUP_PRIVATE=true

# Include forked repositories
GITHUB_BACKUP_FORKS=false

# Include archived repositories
GITHUB_BACKUP_ARCHIVED=true

# Backup ALL repos the user has access to (not just owned by GITHUB_OWNER)
# When true: Backs up owned repos + repos from orgs where user is member + collaborations
# When false (default): Only backs up repos owned by GITHUB_OWNER
# Note: Only applies when GITHUB_OWNER is a user (not organization)
GITHUB_BACKUP_ALL_ACCESSIBLE=false

# ───────────────────────────────────────────────────────────────────────────────
# Backup Configuration
# ───────────────────────────────────────────────────────────────────────────────

# Number of backup copies to retain (older backups will be deleted)
BACKUP_RETENTION_COUNT=10

# Include metadata (issues, pull requests, releases)
BACKUP_INCLUDE_METADATA=true

# Include wiki repositories
BACKUP_INCLUDE_WIKI=true

# Incremental backup: only backup repos that changed since last backup
# Set to false for full backup every time
BACKUP_INCREMENTAL=true

# ───────────────────────────────────────────────────────────────────────────────
# Scheduler Configuration
# ───────────────────────────────────────────────────────────────────────────────

# Enable scheduled backups
BACKUP_SCHEDULE_ENABLED=true

# Schedule mode: cron or interval
# - cron:     Run at fixed time (controlled by HOUR, MINUTE, DAY_OF_WEEK)
# - interval: Run every N hours
BACKUP_SCHEDULE_MODE=cron

# Time to run backup (for cron mode)
BACKUP_SCHEDULE_HOUR=2
BACKUP_SCHEDULE_MINUTE=0

# Day of week (for cron mode): 0=Mon, 1=Tue, ..., 6=Sun
# - "*"     = every day (daily backup)
# - "0"     = Monday only (weekly backup)
# - "0,2,4" = Mon, Wed, Fri
BACKUP_SCHEDULE_DAY_OF_WEEK=*

# Hours between backups (for interval mode, 1-168)
# BACKUP_SCHEDULE_INTERVAL_HOURS=24

# ───────────────────────────────────────────────────────────────────────────────
# S3/MinIO Configuration
# ───────────────────────────────────────────────────────────────────────────────

# S3-compatible endpoint URL
S3_ENDPOINT_URL=https://minio.example.com

# ─────────────────────────────────────────────────────────────────────────────
# MinIO Admin Credentials (TEMPORARY - for setup script only!)
# ─────────────────────────────────────────────────────────────────────────────
# These credentials are ONLY needed to run tools/setup-bucket.py
# After running the setup script, REMOVE these values from your .env file!
# The script creates a dedicated service user with limited permissions.
# Keeping root credentials in .env is a security risk.
#
# MINIO_ROOT_USER=admin
# MINIO_ROOT_PASSWORD=your-minio-root-password
# ─────────────────────────────────────────────────────────────────────────────

# Bucket name for backups
S3_BUCKET=github-backups

# Access credentials
S3_ACCESS_KEY=minioadmin
S3_SECRET_KEY=minioadmin

# Region (required for signature)
S3_REGION=eu-north-1

# Optional prefix/folder in bucket (empty = store directly under {owner}/)
# Example: S3_PREFIX=github-backup -> s3://bucket/github-backup/{owner}/{repo}/{backup_id}/
# Default: S3_PREFIX= -> s3://bucket/{owner}/{repo}/{backup_id}/
S3_PREFIX=

# Multipart upload configuration
# Files larger than threshold use multipart upload with equal-sized chunks
# S3_MULTIPART_THRESHOLD=104857600
# S3_MULTIPART_CHUNK_SIZE=52428800

# ───────────────────────────────────────────────────────────────────────────────
# Alerting Configuration
# ───────────────────────────────────────────────────────────────────────────────

# Enable alerting system
ALERT_ENABLED=false

# Alert level: errors (only failures), warnings (failures + warnings), all (include success)
ALERT_LEVEL=errors

# Active alert channels (comma-separated): email, webhook, teams
ALERT_CHANNELS=

# --- SMTP Email Configuration ---
# SMTP server hostname
SMTP_HOST=
# SMTP server port (587 for TLS/STARTTLS, 465 for SSL)
SMTP_PORT=587
# Use TLS/STARTTLS (recommended for port 587)
SMTP_TLS=true
# Use SSL (for port 465)
SMTP_SSL=false
# SMTP authentication (leave empty for anonymous)
SMTP_USER=
SMTP_PASSWORD=
# Sender email address
SMTP_FROM=
# Sender display name
SMTP_FROM_NAME=GitHub Backup
# Recipients (comma-separated)
SMTP_TO=

# --- Generic Webhook Configuration ---
# Webhook URL for JSON POST alerts
WEBHOOK_URL=
# Optional HMAC secret for signature (X-Signature header)
WEBHOOK_SECRET=

# --- Microsoft Teams Configuration ---
# Teams Webhook URL (from Workflows or legacy Incoming Webhook)
TEAMS_WEBHOOK_URL=

# ───────────────────────────────────────────────────────────────────────────────
# Application Configuration
# ───────────────────────────────────────────────────────────────────────────────

# Timezone (e.g., Europe/Vienna, America/New_York, Etc/UTC)
TZ=Etc/UTC

# Log level (DEBUG, INFO, WARNING, ERROR)
LOG_LEVEL=INFO