Skip to content

configuration.md

Latest commit

 

History

History
173 lines (123 loc) · 6.66 KB

configuration.md

File metadata and controls

173 lines (123 loc) · 6.66 KB
Raw

Configuration Reference

All configuration is done through environment variables. Copy .env.dist to .env and set the values for your environment.

Security: Never commit .env to version control. Add it to .gitignore.

Server

Variable Default Description
PORT 51675 HTTP port the application listens on

Database

Variable Default Required Description
DB_HOST localhost Yes PostgreSQL hostname
DB_PORT 5433 Yes PostgreSQL port
DB_NAME open-schedule Yes Database name
DB_USER postgres Yes Database username
DB_PASSWORD postgres Yes Database password — change in production

Object Storage (S3-compatible)

Open Schedule uses any S3-compatible object storage backend for speaker photos and attachments.

Variable Default Description
STORAGE_ENDPOINT http://localhost:9000 S3 API endpoint (MinIO default for dev)
STORAGE_ACCESS_KEY minioadmin Access key (MinIO default for dev)
STORAGE_SECRET_KEY minioadmin Secret key
STORAGE_BUCKET open-schedule Bucket / collection name
STORAGE_PUBLIC_ENDPOINT (same as STORAGE_ENDPOINT) Public URL for signed URLs. Set this when storage is behind a separate public hostname
STORAGE_SIGNED_URL_EXPIRY 3600 Signed URL expiry in seconds

See storage.md for provider-specific examples.

Email

General (shared across all providers)

Variable Default Description
EMAIL_OUTBOUND_ENABLED true Enables or disables all outbound email by default
EMAIL_PROVIDER_TYPE SMTP Default provider type: SMTP, SENDGRID, MAILJET, POSTAL
EMAIL_SECURITY_MODE STARTTLS Default SMTP security mode: NONE, STARTTLS, SSL_TLS
EMAIL_AUTH_ENABLED true Whether SMTP auth is enabled by default
EMAIL_CONNECTION_TIMEOUT_MS 10000 Mail connection timeout in milliseconds
EMAIL_READ_TIMEOUT_MS 10000 Mail read/write timeout in milliseconds
EMAIL_FROM_ADDRESS (none) Sender email address
EMAIL_FROM_NAME Open Schedule Sender display name
EMAIL_SETTINGS_MASTER_KEY (none) Master key used to encrypt secrets persisted from the admin UI
EMAIL_ALLOW_UI_SECRET_PERSISTENCE false Enables encrypted secret persistence from the admin UI when a master key is configured

SMTP Provider

Variable Default Description
EMAIL_SMTP_HOST (none) SMTP server hostname
EMAIL_SMTP_PORT 587 SMTP port (587 = STARTTLS, 465 = SSL)
EMAIL_SMTP_USERNAME (none) SMTP authentication username
EMAIL_SMTP_PASSWORD (none) SMTP authentication password
EMAIL_SMTP_SSL_TRUST (none) Set to SMTP hostname only when using a self-signed certificate. Leave blank for public providers

Postal HTTP API Provider

Variable Default Description
POSTAL_ENABLED false Set to true to use Postal instead of SMTP
POSTAL_BASE_URL (none) Postal server base URL, e.g. https://postal.yourdomain.com
POSTAL_API_KEY (none) Postal server API key
POSTAL_API_KEY_HEADER X-Server-API-Key HTTP header used for the Postal API key

When POSTAL_ENABLED=true, Postal becomes the default provider on first boot. Administrators can still override the provider later from the UI.

Admin UI behavior

  • Route: Admin → Mail settings
  • Access: authenticated users with the ADMIN role
  • Persists non-sensitive configuration in the database
  • Persists secrets only when EMAIL_SETTINGS_MASTER_KEY and EMAIL_ALLOW_UI_SECRET_PERSISTENCE=true are configured
  • Sends test emails from the UI after saving

See email.md for complete provider setup guides.

Application

Variable Default Description
APP_URL https://alphnology.com Public base URL of the application — used in email links
APP_NAME Open Schedule Application display name
BRANDING_EXTERNAL_CSS_PATH (none) Optional filesystem path to an external CSS file that overrides bundled theme tokens. Supports relative paths such as ./branding-overrides.css

External branding CSS

Use this when you want the same build artifact to keep the default theme in dev while loading customer-specific colors in production.

  1. Copy branding-overrides.example.css to a real file next to your deployment, for example branding-overrides.css
  2. Override only the CSS variables or selectors you need
  3. Set BRANDING_EXTERNAL_CSS_PATH to that file path

Example:

BRANDING_EXTERNAL_CSS_PATH=./branding-overrides.css

If the file is missing or the variable is blank, the bundled theme remains the only stylesheet.

Event

Variable Default Description
EVENT_WEBSITE https://alphnology.com URL shown in the "Event Website" nav link
EVENT_SCHEDULE https://alphnology.com URL for the schedule link

GitHub Integration (optional)

Used by the "Report a Bug" feature in the app. Leave blank to disable it.

Variable Default Description
GIT_HUB_API_TOKEN (none) GitHub Personal Access Token with repo scope
GIT_HUB_REPOSITORY_NAME alphnology/open-schedule Repository to open issues against

Date & Time Formatting

Variable Default Description
FORMATTER_DATE MM-dd-yyyy Date display format
FORMATTER_TIME HH:mm Time display format (24h)
FORMATTER_TIME_12 hh:mm a Time display format (12h)
FORMATTER_DATE_TIME MM-dd-yyyy HH:mm Date + time display format
FORMATTER_DATE_TIME_12 MM-dd-yyyy hh:mm a Date + time display format (12h)

Miscellaneous

Variable Default Description
NOTIFICATION_TIME 3000 Notification auto-dismiss time in milliseconds

Production checklist

[ ] DB_PASSWORD is a strong, unique password
[ ] STORAGE_ACCESS_KEY and STORAGE_SECRET_KEY are not default values
[ ] EMAIL_SMTP_PASSWORD / POSTAL_API_KEY are rotated secrets
[ ] EMAIL_SETTINGS_MASTER_KEY is set if UI secret persistence is enabled
[ ] GIT_HUB_API_TOKEN has minimum required scope
[ ] APP_URL matches your actual public domain
[ ] EMAIL_FROM_ADDRESS is a verified sender domain
[ ] .env is in .gitignore and never committed