yrtria/theme-song-booth
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update comments, docstrings, README, REVIEW, and env docs to match current features

Browse source
This commit is contained in:
Troll (Hermes Agent) 2026-08-03 00:11:41 +00:00
parent 0aa3eab084
commit e46893e0b4
12 changed files with 65 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

28
config.py
View file

@ -3,14 +3,30 @@ config.py
=========
Configuration object loaded by Flask from environment variables.
Most operational settings are now editable at runtime from /admin/settings
and stored in booth_settings.json on disk. Sensitive email credentials are
Most operational settings are editable at runtime from /admin/settings and
stored in booth_settings.json on disk. Sensitive values (SMTP password) are
encrypted with the Flask SECRET_KEY when saved.
Required environment values:
- APP_SECRET_KEY (used to sign sessions and encrypt stored settings)
- ADMIN_PASSWORD (plain-text login password)
- PUBLIC_BASE_URL
Environment variables (defaults shown):
Required:
- APP_SECRET_KEY long random string for Flask sessions and encryption
- ADMIN_PASSWORD plain-text password for /admin login
- PUBLIC_BASE_URL public URL customers use (e.g. https://booth.example.com)
- SMTP_PASS password for the SMTP account
Optional:
- BOOTH_NAME name in customer text and emails (default Trollgorithm Theme Songs)
- HOST_PORT docker-compose host-side port mapping (default 127.0.0.1:8000)
- INTERNAL_PORT gunicorn port inside the container (default 8000)
- MAX_REVISIONS default customer revision limit (default 2)
- PRICE_PER_VERSION price shown to customers (default 10.00)
- CURRENCY currency label (default CAD)
- DATABASE SQLite database path inside the container (default /app/data/booth.db)
- UPLOAD_FOLDER directory for uploaded MP3s inside the container (default /app/uploads)
- SETTINGS_FILE runtime settings JSON filename (default booth_settings.json)
- SMTP_HOST outgoing mail server (default mailroot8.namespro.ca)
- SMTP_PORT outgoing mail server port (default 465)
- SMTP_USER SMTP login username (default ai@hallsworth.ca)
- SMTP_FROM From address for customer emails (default ai@hallsworth.ca)
"""
import os