From ae1ce706e92fcdce2b1537f5a25b8633c54d974e Mon Sep 17 00:00:00 2001 From: S4NKALP Date: Tue, 3 Jun 2025 13:59:02 +0545 Subject: [PATCH] refactor(.env.example): simplify and document environment variables --- .env.example | 27 --------------------------- 1 file changed, 27 deletions(-) diff --git a/.env.example b/.env.example index 489aa2d..2b644b0 100644 --- a/.env.example +++ b/.env.example @@ -1,25 +1,17 @@ # Django Settings # Required: Secret key for Django's cryptographic signing DJANGO_SECRET_KEY=your-secret-key-here -# Optional: Enable debug mode (True/False) DJANGO_DEBUG=True -# Optional: Comma-separated list of allowed hosts DJANGO_ALLOWED_HOSTS=* # Database Configuration # Optional: Database engine (default: django.db.backends.sqlite3) DB_ENGINE=django.db.backends.sqlite3 -# Optional: Database name (default: db.sqlite3) DB_NAME=db.sqlite3 -# Optional: Database timeout in seconds (default: 20) DB_TIMEOUT=20 -# Optional: Database host (required for non-SQLite databases) DB_HOST= -# Optional: Database port (required for non-SQLite databases) DB_PORT= -# Optional: Database user (required for non-SQLite databases) DB_USER= -# Optional: Database password (required for non-SQLite databases) DB_PASSWORD= # Cache Configuration @@ -27,57 +19,38 @@ DB_PASSWORD= USE_REDIS_CACHE=True # Optional: Redis URL (default: redis://localhost:6379/1) REDIS_URL=redis://localhost:6379/1 -# Optional: Cache timeout in seconds (default: 300) CACHE_TIMEOUT=300 -# Optional: Cache key prefix (default: sms) CACHE_KEY_PREFIX=sms -# Optional: Maximum number of cache connections (default: 1000) CACHE_MAX_CONNECTIONS=1000 # Email Configuration # Optional: Email backend (default: django.core.mail.backends.console.EmailBackend) EMAIL_BACKEND=django.core.mail.backends.console.EmailBackend -# Optional: Default from email address DEFAULT_FROM_EMAIL=noreply@studentmanagementsystem.com -# Optional: Email host (required for SMTP backend) EMAIL_HOST= -# Optional: Email port (required for SMTP backend) EMAIL_PORT= -# Optional: Email username (required for SMTP backend) EMAIL_USERNAME= -# Optional: Email password (required for SMTP backend) EMAIL_PASSWORD= -# Optional: Use TLS for email (True/False) EMAIL_USE_TLS=True # Firebase Configuration # Required: Firebase API key FIREBASE_API_KEY=your_firebase_api_key_here -# Required: Firebase auth domain FIREBASE_AUTH_DOMAIN=your_project_id.firebaseapp.com -# Required: Firebase project ID FIREBASE_PROJECT_ID=your_project_id -# Required: Firebase storage bucket FIREBASE_STORAGE_BUCKET=your_project_id.firebasestorage.app -# Required: Firebase messaging sender ID FIREBASE_MESSAGING_SENDER_ID=your_sender_id -# Required: Firebase app ID FIREBASE_APP_ID=your_app_id -# Required: Firebase measurement ID FIREBASE_MEASUREMENT_ID=your_measurement_id # SMS Configuration # Required: SMS API key SMS_API_KEY=your_sms_api_key_here -# Optional: SMS sender ID (default: SMSSYS) SMS_SENDER_ID=SMSSYS # Gunicorn Configuration # Optional: Number of worker processes (default: 4) GUNICORN_WORKERS=4 -# Optional: Number of threads per worker (default: 2) GUNICORN_THREADS=2 -# Optional: Worker timeout in seconds (default: 30) GUNICORN_TIMEOUT=30 -# Optional: Keep-alive timeout in seconds (default: 2) GUNICORN_KEEPALIVE=2 \ No newline at end of file