Add comprehensive comments to all source files and expand documentation

This commit is contained in:
Troll (Hermes Agent) 2026-07-31 22:23:40 +00:00
parent 9e532a1920
commit b4f0222bd5
16 changed files with 1230 additions and 552 deletions

View file

@ -1,3 +1,23 @@
# .env.example
# ============
#
# Copy this file to .env for local development, or paste the values into
# Portainer when deploying the stack.
#
# Required for production:
# APP_SECRET_KEY - long random string used by Flask for sessions
# ADMIN_PASSWORD - password for the /admin dashboard
# SMTP_PASS - password for the SMTP account
# PUBLIC_BASE_URL - public HTTPS URL customers will use (e.g. https://booth.example.com)
#
# Optional:
# BOOTH_NAME - name shown in emails
# HOST_PORT - host-side port mapping for docker-compose (default 127.0.0.1:8000)
# INTERNAL_PORT - port gunicorn binds inside the container (default 8000)
# PRICE_PER_VERSION - shown on the receipt page (default 10.00)
# CURRENCY - currency label (default CAD)
# ADMIN_ALERT_EMAIL - unused; dashboard is the operator queue
APP_SECRET_KEY=change-me-in-production
ADMIN_PASSWORD=change-me
SMTP_HOST=mailroot8.namespro.ca
@ -8,9 +28,9 @@ SMTP_FROM=ai@hallsworth.ca
ADMIN_ALERT_EMAIL=
PUBLIC_BASE_URL=http://127.0.0.1:5000
BOOTH_NAME=Trollgorithm Theme Songs
DATABASE=/app/data/booth.db
UPLOAD_FOLDER=/app/uploads
INTERNAL_PORT=8000
HOST_PORT=127.0.0.1:8000
PRICE_PER_VERSION=10.00
CURRENCY=CAD
DATABASE=/app/data/booth.db
UPLOAD_FOLDER=/app/uploads