Admin login now uses OpenID Connect (PKCE, nonce, ID token verified against the provider JWKS) and only OIDC_ADMIN_SUB may log in. Micropub tokens are issued and verified by StarPunk itself, with a consent screen behind the OIDC session and a Connected Apps page to revoke them, so an external IndieAuth server (Gondulf) is no longer needed. Existing notes, media, tags, webmentions, author profile and sessions are unchanged. Migration 011 adds new tables only. BREAKING CHANGE: production requires OIDC_ISSUER, OIDC_CLIENT_ID, OIDC_CLIENT_SECRET and OIDC_ADMIN_SUB. The ADMIN_ME page must point Micropub apps at StarPunk's IndieAuth endpoints. See ADR-064. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
116 lines
3.8 KiB
Bash
116 lines
3.8 KiB
Bash
# 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 identity URL (REQUIRED)
|
|
# Your personal website. Used as the author h-card source and as the "me"
|
|
# value in Micropub tokens. It should link to this site's IndieAuth metadata
|
|
# (see docs/decisions/ADR-064) so Micropub apps can find StarPunk.
|
|
ADMIN_ME=https://your-website.com
|
|
|
|
# Admin login via OpenID Connect (REQUIRED in production)
|
|
# Register StarPunk as a confidential client with your provider (e.g. Pocket ID)
|
|
# using the callback URL: <SITE_URL>/auth/callback
|
|
OIDC_ISSUER=https://id.example.com
|
|
OIDC_CLIENT_ID=
|
|
OIDC_CLIENT_SECRET=
|
|
# The provider's subject ("sub") of the one account allowed to log in.
|
|
# Pocket ID: the user's ID shown in the admin user list.
|
|
OIDC_ADMIN_SUB=
|
|
# Name shown on the login button (default: "single sign-on")
|
|
OIDC_PROVIDER_NAME=Pocket ID
|
|
|
|
# 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
|
|
|
|
# Lifetime of Micropub access tokens StarPunk issues, in days (default: 90)
|
|
INDIEAUTH_TOKEN_LIFETIME_DAYS=90
|
|
|
|
# =============================================================================
|
|
# 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
|