compose.env.example

# Copy this file to .env. Docker Compose reads it automatically.
# Generate a random hex password with: openssl rand -hex 32
# Set it once before the first start; changing it later does not rotate the database password.
POSTGRES_PASSWORD=

# ClickHouse retains historical analytics; PostgreSQL remains the operational store.
# Generate a separate password with: openssl rand -hex 32
# If omitted, Compose uses POSTGRES_PASSWORD. Never publish ClickHouse ports publicly.
DEVFEED_CLICKHOUSE_PASSWORD=
DEVFEED_CLICKHOUSE_DATABASE=devfeed
DEVFEED_CLICKHOUSE_USERNAME=devfeed
DEVFEED_CLICKHOUSE_URL=http://clickhouse:8123
# Independent container budget; provision host capacity beyond PostgreSQL's allocation.
DEVFEED_CLICKHOUSE_CPUS=2
DEVFEED_CLICKHOUSE_MEMORY_LIMIT=2g
# Per-query limits and shared server profiles bound all reader replicas together.
DEVFEED_CLICKHOUSE_MAX_THREADS=2
DEVFEED_CLICKHOUSE_MAX_CONCURRENT_QUERIES=2
DEVFEED_CLICKHOUSE_MAX_EXECUTION_SECONDS=20
DEVFEED_CLICKHOUSE_MAX_MEMORY_BYTES=268435456
# Required: replace these placeholders with distinct generated passwords.
DEVFEED_CLICKHOUSE_INGEST_PASSWORD=change-me-ingest-password
# Give each application a distinct password for its scoped ClickHouse role.
DEVFEED_CLICKHOUSE_PUBLIC_PASSWORD=change-me-public-password
DEVFEED_CLICKHOUSE_USER_PASSWORD=change-me-user-password
DEVFEED_CLICKHOUSE_PARTNER_PASSWORD=change-me-partner-password
DEVFEED_CLICKHOUSE_ADMIN_PASSWORD=change-me-admin-password
DEVFEED_CLICKHOUSE_WORKER_PASSWORD=change-me-worker-password
# Required: replace this placeholder with a generated, distinct reader password.
DEVFEED_CLICKHOUSE_READER_PASSWORD=change-me-reader-password
DEVFEED_CLICKHOUSE_READER_MAX_QUERIES=2
DEVFEED_CLICKHOUSE_READER_MAX_MEMORY_BYTES=536870912
DEVFEED_CLICKHOUSE_INGEST_MAX_QUERIES=3
DEVFEED_CLICKHOUSE_INGEST_MAX_MEMORY_BYTES=402653184
DEVFEED_CLICKHOUSE_SERVER_MAX_MEMORY_BYTES=1610612736
DEVFEED_CLICKHOUSE_SERVER_MAX_QUERIES=6
DEVFEED_CLICKHOUSE_SERVER_MAX_SELECTS=3
DEVFEED_CLICKHOUSE_SERVER_MAX_INSERTS=2
# Import retained history in bounded, asynchronous batches.
DEVFEED_ANALYTICS_BACKFILL_BATCH_SIZE=1000
DEVFEED_ANALYTICS_POLL_SECONDS=1
DEVFEED_ANALYTICS_BACKFILL_POLL_SECONDS=0.1
# Resource budget for the finite historical import.
DEVFEED_ANALYTICS_IMPORTER_CPUS=0.5
DEVFEED_ANALYTICS_IMPORTER_MEMORY_LIMIT=512m

# CH-UI management interface: http://localhost:4000, using your ClickHouse login.
# It connects privately to the existing ClickHouse; no second database is started.
# Publish on the LAN; use a specific interface address to restrict the binding.
DEVFEED_CH_UI_BIND_IP=0.0.0.0
DEVFEED_CH_UI_PORT=4000
DEVFEED_CH_UI_URL=http://localhost:4000
# Generate a separate stable session-encryption key with openssl rand -hex 32.
# Empty generates and persists a private key in the ch-ui-data volume.
DEVFEED_CH_UI_SECRET_KEY=
DEVFEED_CH_UI_CPUS=0.5
DEVFEED_CH_UI_MEMORY_LIMIT=512m

# Optional pull-through registry host (no scheme or trailing slash).
# Unset/empty uses upstream images as usual. For example, registry.home maps
# postgres to registry.home/docker.io/library/postgres, typesense/typesense to
# registry.home/docker.io/typesense/typesense, and ghcr.io/... to registry.home/ghcr.io/...
# Applies to service images, local-build base images, and registry build caches.
# Explicit DEVFEED_*_IMAGE overrides are complete references and stay unchanged.
# DEVFEED_IMAGE_REGISTRY=registry.home

# Publish on every IPv4 interface. Set a specific host IP (or :: for IPv6) if needed.
DEVFEED_BIND_IP=0.0.0.0
DEVFEED_API_PORT=8000
DEVFEED_ADMIN_PORT=3001
# Set this to the IP/hostname used in your browser, including the published port.
# 0.0.0.0 is a bind address, not a browser origin. Register the matching OIDC callback.
DEVFEED_ADMIN_BASE_URL=http://localhost:3001
DEVFEED_ADMIN_COOKIE_SECURE=false

# Each replica handles one job at a time. General workers default to two.
DEVFEED_WORKER_REPLICAS=2
# The separate AI pool starts only with the ai profile; increase for parallel analysis.
DEVFEED_CODEX_CLIENT_REPLICAS=1
# Optional per-container caps for every RQ worker pool. Zero preserves uncapped local defaults.
# Choose limits from complete-job peaks, including native extraction/image work and telemetry.
DEVFEED_WORKER_CPUS=0
DEVFEED_WORKER_MEMORY_LIMIT=0

# By default the stack connects to its bundled PostgreSQL and Redis services.
# Optional overrides must be reachable INSIDE the containers; localhost is not the host.
# DEVFEED_DATABASE_URL=postgresql+psycopg://devfeed:${POSTGRES_PASSWORD}@postgres:5432/devfeed
# DEVFEED_REDIS_URL=redis://redis:6379/0

# Optional runtime settings from .env.example are forwarded to Python services:
# CORS, cache, feed/page limits, scheduler batch size, job logs, and AI settings.
# List-valued settings use JSON, e.g. DEVFEED_CORS_ORIGINS=["https://user.example.com"].
# Chimely starts by default. Enabled notifications are provisioned during compose up.
# These helpers generate the optional integration settings and build local images:
# python3 scripts/compose_dev.py --notifications
# python3 scripts/compose_dev.py --ai
# COMPOSE_PROFILES=ai
# The rebuild command also records compose.yaml + compose.build.yaml in COMPOSE_FILE.
# AI setup starts with gpt-6-sol; override DEVFEED_CODEX_MODEL for your account.
# DEVFEED_CODEX_MODEL=gpt-6-sol
# DEVFEED_CODEX_APP_SERVER_URL=unix:///run/codex/app-server.sock
# DEVFEED_AI_ENABLED=true
# DEVFEED_WORKER_QUEUE=background
# Autonomous research and publication (requires AI and a connected account):
# DEVFEED_AUTO_RESEARCH_IMPORTS=true
# Full mode researches source tags and publishes/rejects articles.
# Sources require an AI or explicit operator review, including imports and suggestions.
# DEVFEED_FULL_AUTOMATION=true
# DEVFEED_TOPIC_CORRECTION_MAX_ATTEMPTS=3
# DEVFEED_AUTO_REANALYZE_TOPICS=true
# DEVFEED_AUTO_RESEARCH_RELATIONSHIPS=true
# DEVFEED_AUTO_LINK_TAGS=true
# DEVFEED_RELATIONSHIP_RESEARCH_BATCH_SIZE=100
# DEVFEED_RELATIONSHIP_RESEARCH_MAX_PENDING=4
# DEVFEED_AUTO_APPROVE_TOPICS=true
# DEVFEED_AUTO_APPROVE_TOPIC_RELATIONSHIPS=true
# Article publication is configured per approved source in the admin UI.

# Chimely uses its own database/user on the bundled PostgreSQL server.
# The one-off provisioner prepares separate credentials for workers and the admin API.
# Runtime credentials live in scoped Docker volumes; no key copying is needed locally.
# CHIMELY_PORT=8082
# Optional dedicated hex password; otherwise it uses POSTGRES_PASSWORD.
# chimely-db-init reconciles this role password without resetting its database.
# CHIMELY_POSTGRES_PASSWORD=your-random-hex-password
# CHIMELY_ADMIN_EMAIL=admin@devfeed.local
# CHIMELY_ADMIN_PASSWORD=generated-by-setup
# CHIMELY_ADMIN_TLS_TERMINATED=false
# DEVFEED_NOTIFICATIONS_ENABLED=true
# DEVFEED_CHIMELY_API_URL=http://chimely:8080
# DEVFEED_CHIMELY_ADMIN_ENVIRONMENT=devfeed-admin
# Explicit keys are needed only for an externally provisioned Chimely:
# DEVFEED_CHIMELY_ADMIN_API_KEY=your-environment-api-key
# DEVFEED_CHIMELY_ADMIN_HMAC_SECRET=your-environment-hmac-secret
# An external Chimely remains supported; use its container-reachable origin instead.

# By default Compose uses the current verified master images.
# For a release, set all three references from the same verified image manifest.
# Full image references accept either a tag or @sha256: digest.
# DEVFEED_BACKEND_IMAGE=ghcr.io/abhi1693/devfeed.tech/backend:master
# DEVFEED_ADMIN_API_IMAGE=ghcr.io/abhi1693/devfeed.tech/admin-api:master
# DEVFEED_ADMIN_IMAGE=ghcr.io/abhi1693/devfeed.tech/admin:master

# Optional: configure your dedicated OIDC app to enable admin sign-in.
# Unknown optional sign-in values can stay empty; sign-in remains unavailable.
# Register http://localhost:3001/api/v1/admin/auth/callback as its redirect URI.
# DEVFEED_OIDC_ISSUER_URL=https://identity.example.com
# DEVFEED_OIDC_CLIENT_ID=your-devfeed-admin-client-id
# DEVFEED_OIDC_ORGANIZATION_ID=your-organization-id
# DEVFEED_OIDC_TOKEN_ENDPOINT_AUTH_METHOD=none
# DEVFEED_ADMIN_REQUIRED_ROLE=superuser
# Secret-authenticated clients also need DEVFEED_OIDC_CLIENT_SECRET.
# See docs/admin.md for role, organization and scope settings for your provider.

# Anonymous public user (admin remains on port 3001).
# DEVFEED_WEB_PORT=3000
# DEVFEED_WEB_IMAGE=ghcr.io/abhi1693/devfeed.tech/web:master
# Runtime flag: local Compose must not send GA4 page views or custom events.
DEVFEED_ANALYTICS_ENABLED=false
# GOOGLE_ANALYTICS_ID=G-N4V5CW5C0M
# Extension GA4 uses the website property through a server-only Measurement Protocol secret.
DEVFEED_EXTENSION_ANALYTICS_ENABLED=false
MICROSOFT_CLARITY_PROJECT_ID=
# X pixel pc5f8: opt in to browser and server conversion tracking.
DEVFEED_X_PIXEL_ENABLED=false
# Server-only credentials and completed sign-up event from Events Manager.
X_PIXEL_TOKEN=
X_SIGNUP_EVENT_ID=tw-pc5f8-rgbo7
# DEVFEED_EXTENSION_GA_API_SECRET=

# Optional user accounts (separate ZITADEL application, same organization as admin).
# Browsing works without these; only personalization requires sign-in.
# Optional additional reader origins trusted for CSRF-protected writes (web + user-api).
# Keep the registered sign-in callback at DEVFEED_USER_BASE_URL; list LAN aliases explicitly.
# DEVFEED_USER_ALLOWED_ORIGINS=[]
# DEVFEED_USER_BASE_URL=http://localhost:3000
# DEVFEED_USER_COOKIE_SECURE=false
# Exact trusted Chrome IDs, JSON array; set identically on web and user-api.
# DEVFEED_USER_EXTENSION_IDS=["hliakjocndflpkmfajndigbpngfcekdm"]
# DEVFEED_USER_SESSION_TTL_SECONDS=2592000
# DEVFEED_USER_OIDC_ISSUER_URL=https://identity.example.com
# DEVFEED_USER_OIDC_CLIENT_ID=your-user-client-id
# DEVFEED_USER_OIDC_ORGANIZATION_ID=your-organization-id
# Shared ZITADEL identity-provider IDs enable direct sign-in for reader and admin.
# Enable these providers for both applications; client IDs remain separate.
# DEVFEED_OIDC_GITHUB_IDP_ID=
# DEVFEED_OIDC_GOOGLE_IDP_ID=
# DEVFEED_USER_OIDC_TOKEN_ENDPOINT_AUTH_METHOD=none
# DEVFEED_USER_OIDC_SCOPES=["openid","profile","email"]
# Set a user-specific secret only for confidential clients:
# DEVFEED_USER_OIDC_CLIENT_SECRET=
# DEVFEED_USER_API_IMAGE=ghcr.io/abhi1693/devfeed.tech/user-api:master
# Outside Compose, the Next server also needs DEVFEED_USER_API_URL=http://127.0.0.1:8002

# Optional Typesense search; see docs/search.md. Preserve other profiles when enabling.
# COMPOSE_PROFILES=search
DEVFEED_SEARCH_ENABLED=false
DEVFEED_SEARCH_URL=http://typesense:8108
DEVFEED_SEARCH_COLLECTION_PREFIX=devfeed
DEVFEED_SEARCH_ADMIN_KEY=
DEVFEED_SEARCH_QUERY_KEY=
DEVFEED_SEARCH_INDEX_BATCH_SIZE=200

# Shared crawler inventory refresh; independent from reader-cache invalidation.
DEVFEED_SITEMAP_REFRESH_SECONDS=900
DEVFEED_SITEMAP_RETENTION_SECONDS=86400

# Import API tokens are saved per connection as encrypted database credentials.
# Generate one persistent Fernet key and keep it separate from database backups.
# Compose shares it only with the admin/partner APIs and import workers.
DEVFEED_PARTNER_CREDENTIAL_KEY=

# Image storage: credentials stay in the images worker and private APIs for avatar/ad uploads.
# Public reader APIs and frontends use only the public URL.
# Enable the `images` Compose profile for imgproxy and the dedicated Images worker.
DEVFEED_IMAGE_STORAGE_ENABLED=false
DEVFEED_IMAGE_STORAGE_ENDPOINT=https://492e25f5f18ef59e38763f58a78362f7.r2.cloudflarestorage.com
DEVFEED_IMAGE_STORAGE_BUCKET=devfeed-images-dev
DEVFEED_IMAGE_PUBLIC_URL=https://pub-5902d9886c3d4a00beeba906c0cbe154.r2.dev
DEVFEED_IMAGE_STORAGE_ACCESS_KEY=
DEVFEED_IMAGE_STORAGE_SECRET_KEY=
DEVFEED_IMGPROXY_URL=http://imgproxy:8080
# Generate separate hex secrets (openssl rand -hex 32). Never expose in frontend config.
DEVFEED_IMGPROXY_KEY=
DEVFEED_IMGPROXY_SALT=
DEVFEED_IMAGE_MAX_BYTES=10000000

# Superseded successful analysis input retention (results and current evidence remain).
DEVFEED_JOB_PAYLOAD_RETENTION_DAYS=30
DEVFEED_JOB_PAYLOAD_PRUNE_BATCH_SIZE=100

DEVFEED_USER_SESSION_ABSOLUTE_TTL_SECONDS=7776000