docs: update comments, docstrings, README, REVIEW, and env docs to match current features
This commit is contained in:
parent
0aa3eab084
commit
e46893e0b4
12 changed files with 65 additions and 25 deletions
11
.env.example
11
.env.example
|
|
@ -11,12 +11,18 @@
|
|||
# PUBLIC_BASE_URL - public HTTPS URL customers will use (e.g. https://booth.example.com)
|
||||
#
|
||||
# Optional:
|
||||
# BOOTH_NAME - name shown in emails
|
||||
# BOOTH_NAME - name shown in emails and customer text (default Trollgorithm Theme Songs)
|
||||
# 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
|
||||
# MAX_REVISIONS - default customer revision limit (default 2)
|
||||
# DATABASE - SQLite database path inside the container (default /app/data/booth.db)
|
||||
# UPLOAD_FOLDER - directory for uploaded MP3s inside the container (default /app/uploads)
|
||||
# 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)
|
||||
|
||||
APP_SECRET_KEY=change-me-in-production
|
||||
ADMIN_PASSWORD=change-me
|
||||
|
|
@ -32,5 +38,6 @@ INTERNAL_PORT=8000
|
|||
HOST_PORT=127.0.0.1:8000
|
||||
PRICE_PER_VERSION=10.00
|
||||
CURRENCY=CAD
|
||||
MAX_REVISIONS=2
|
||||
DATABASE=/app/data/booth.db
|
||||
UPLOAD_FOLDER=/app/uploads
|
||||
|
|
|
|||
Reference in a new issue