Configuration Documentation¶
Configure system settings, integrations, and security.
📑 Contents¶
Email Setup¶
Configure SMTP for sending email notifications (reports, verification emails, etc.).
When to use: Production deployment, testing email functionality
Environment Variables¶
Complete reference for all .env configuration options.
When to use: Initial setup, troubleshooting configuration issues
Security Audit¶
Security checklist and hardening guide for production deployments.
When to use: Before production launch, security reviews
Python Dependencies (uv)¶
How to add Python packages (pyproject.toml + uv.lock), rebuild Docker, and audit runtime deps.
When to use: Adding libraries (e.g. bleach), fixing ModuleNotFoundError after pull, before deploy
🎯 Configuration Workflow¶
Initial Setup¶
1. Copy .env.example → .env
2. Edit environment variables
3. Configure email (if needed)
4. Review security settings
Production Checklist¶
✅ DEBUG=false
✅ Strong SECRET_KEY generated
✅ ALLOWED_HOSTS configured
✅ Database password changed
✅ Email configured and tested
✅ Security audit completed
⚡ Quick Configuration¶
Essential Variables¶
# .env file
SECRET_KEY=<generate-with-./run-secret>
DEBUG=false
ALLOWED_HOSTS=yourdomain.com,www.yourdomain.com
POSTGRES_PASSWORD=<strong-password>
Email Configuration¶
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=587
EMAIL_USE_TLS=true
EMAIL_HOST_USER=your-email@gmail.com
EMAIL_HOST_PASSWORD=your-app-password
🔒 Security Priority¶
- Always change
SECRET_KEYin production - Never commit
.envfiles to git - Use strong database passwords
- Enable HTTPS in production
- Review security audit before launch
🔗 Related Documentation¶
- Deployment - Deployment procedures
- Operations - Daily operations
- Setup - Development setup