.env.example

# =============================================================================
# SyncBot Environment Variables
# =============================================================================
# Copy this file to .env and fill in your values:
#   cp .env.example .env
#
# Docker Compose and Dev Containers read .env automatically.
# For native Python development, source it:  source .env  or  export $(cat .env | xargs)

# -----------------------------------------------------------------------------
# Database (mysql, postgresql, or sqlite)
# -----------------------------------------------------------------------------
# Option A — MySQL (default): legacy vars or DATABASE_URL
DATABASE_BACKEND=mysql
DATABASE_HOST=127.0.0.1
# DATABASE_PORT=3306
DATABASE_USER=root
DATABASE_PASSWORD=rootpass
DATABASE_SCHEMA=syncbot
# Optional TLS (provider-dependent)
# DATABASE_TLS_ENABLED=true
# DATABASE_SSL_CA_PATH=/etc/pki/tls/certs/ca-bundle.crt

# Option B — PostgreSQL: set backend and PostgreSQL vars or DATABASE_URL
# DATABASE_BACKEND=postgresql
# DATABASE_HOST=127.0.0.1
# DATABASE_PORT=5432
# DATABASE_USER=postgres
# DATABASE_PASSWORD=postgres
# DATABASE_SCHEMA=syncbot

# Option C — SQLite (forks / local): set backend and URL only
# DATABASE_BACKEND=sqlite
# DATABASE_URL=sqlite:///syncbot.db

# Slack Team ID of the primary workspace. Required for backup/restore to appear.
# DB reset (when enabled below) is also scoped to this workspace.
# PRIMARY_WORKSPACE=T0123456789

# When true (and PRIMARY_WORKSPACE matches), show "Reset Database" on the Home tab.
# ENABLE_DB_RESET=true

# -----------------------------------------------------------------------------
# Local Development Mode
# -----------------------------------------------------------------------------
# This lets you run the app without all the Slack credentials.
# LOCAL_DEVELOPMENT=true

# -----------------------------------------------------------------------------
# Slack
# In cloud deploys these are usually injected by your provider's secret system
# (AWS/GCP/Azure). Uncomment if running locally with OAuth flow.
# -----------------------------------------------------------------------------
# SLACK_BOT_TOKEN=xoxb-your-bot-token
# SLACK_SIGNING_SECRET=your-signing-secret
# SLACK_CLIENT_ID=your-client-id
# SLACK_CLIENT_SECRET=your-client-secret
# SLACK_BOT_SCOPES — bot OAuth scopes; must match slack-manifest.json oauth_config.scopes.bot (see syncbot/slack_manifest_scopes.py).
# SLACK_BOT_SCOPES=app_mentions:read,channels:history,channels:join,channels:read,channels:manage,chat:write,chat:write.customize,files:read,files:write,groups:history,groups:read,groups:write,im:write,reactions:read,reactions:write,team:read,users:read,users:read.email
# SLACK_USER_SCOPES — user OAuth scopes; must match oauth_config.scopes.user and USER_SCOPES in slack_manifest_scopes.py.
# SLACK_USER_SCOPES=chat:write,channels:history,channels:read,files:read,files:write,groups:history,groups:read,groups:write,im:write,reactions:read,reactions:write,team:read,users:read,users:read.email
# OAuth state and installation data are stored in the same database (PostgreSQL, MySQL, or SQLite).

# -----------------------------------------------------------------------------
# Encryption (optional)
# -----------------------------------------------------------------------------
# Passphrase for Fernet bot-token encryption at rest.
# Use any value except "123" to enable encryption.
# TOKEN_ENCRYPTION_KEY=my-secret-passphrase

# -----------------------------------------------------------------------------
# Admin Authorization (optional)
# -----------------------------------------------------------------------------
# Set to "false" to allow all users to configure syncs (default: true).
# REQUIRE_ADMIN=true

# -----------------------------------------------------------------------------
# Logging (optional)
# -----------------------------------------------------------------------------
# Log output level: DEBUG, INFO, WARNING, ERROR, or CRITICAL (default: INFO).
# LOG_LEVEL=INFO

# -----------------------------------------------------------------------------
# Soft-Delete Retention (optional)
# -----------------------------------------------------------------------------
# Number of days to keep soft-deleted workspace data before permanent purge.
# When a workspace uninstalls the app, its group memberships and syncs are paused.
# If it reinstalls within this window, everything is restored automatically.
# SOFT_DELETE_RETENTION_DAYS=30

# -----------------------------------------------------------------------------
# External Connections (optional, disabled by default)
# -----------------------------------------------------------------------------
# Set SYNCBOT_FEDERATION_ENABLED=true to activate external connections.
# SYNCBOT_INSTANCE_ID is a unique UUID for this instance (auto-generated if not set).
# SYNCBOT_PUBLIC_URL is the publicly reachable base URL (required for external connections).
# SYNCBOT_FEDERATION_ENABLED=false
# SYNCBOT_INSTANCE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
# SYNCBOT_PUBLIC_URL=https://your-syncbot.example.com