Files
StarPunk/.env.example
Phil Skentelbery 155cae8055 chore: remove VERSION from .env.example
VERSION is now automatically sourced from the package __version__
variable in config.py, so it should not be set in environment variables.

This prevents version inconsistencies and ensures the displayed version
always matches the code version.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-19 12:31:56 -07:00

103 lines
3.2 KiB
Plaintext

# StarPunk Configuration Template
# Copy this file to .env and fill in your values
# DO NOT commit .env to version control
# =============================================================================
# SITE CONFIGURATION
# =============================================================================
# Public URL where your site is hosted (no trailing slash)
SITE_URL=http://localhost:5000
# Your site name (appears in RSS feed and page titles)
SITE_NAME=My StarPunk Site
# Your name (appears as author in RSS feed)
SITE_AUTHOR=Your Name
# Site description (appears in RSS feed)
SITE_DESCRIPTION=My personal IndieWeb site
# =============================================================================
# AUTHENTICATION
# =============================================================================
# Your IndieWeb identity URL (REQUIRED)
# This is YOUR personal website URL that you authenticate with
# Example: https://yourname.com or https://github.com/yourname
ADMIN_ME=https://your-website.com
# Session secret key (REQUIRED - GENERATE A RANDOM VALUE)
# Generate with: python3 -c "import secrets; print(secrets.token_hex(32))"
SESSION_SECRET=REPLACE_WITH_RANDOM_SECRET
# Session lifetime in days (default: 30)
SESSION_LIFETIME=30
# IndieLogin service URL (usually don't change this)
INDIELOGIN_URL=https://indielogin.com
# =============================================================================
# DATA STORAGE
# =============================================================================
# Base data directory (relative to project root)
DATA_PATH=./data
# Notes directory (where markdown files are stored)
NOTES_PATH=./data/notes
# SQLite database path
DATABASE_PATH=./data/starpunk.db
# =============================================================================
# FLASK CONFIGURATION
# =============================================================================
# Environment: development or production
FLASK_ENV=development
# Debug mode: 1 (on) or 0 (off)
# NEVER use debug mode in production
FLASK_DEBUG=1
# Flask secret key (falls back to SESSION_SECRET if not set)
FLASK_SECRET_KEY=
# =============================================================================
# RSS FEED CONFIGURATION
# =============================================================================
# Maximum number of items in RSS feed (default: 50)
FEED_MAX_ITEMS=50
# Feed cache duration in seconds (default: 300 = 5 minutes)
FEED_CACHE_SECONDS=300
# =============================================================================
# CONTAINER CONFIGURATION
# =============================================================================
# Environment: development or production
ENVIRONMENT=production
# Number of Gunicorn workers (default: 4)
# Recommendation: (2 x CPU cores) + 1
WORKERS=4
# Worker timeout in seconds (default: 30)
WORKER_TIMEOUT=30
# Max requests per worker before restart (prevents memory leaks)
MAX_REQUESTS=1000
# =============================================================================
# DEVELOPMENT OPTIONS
# =============================================================================
# Log level: DEBUG, INFO, WARNING, ERROR, CRITICAL
LOG_LEVEL=INFO
# Enable SQL query logging (development only)
SQL_ECHO=0