sankalp/Student-Management-System-In-Django
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 6 Wiki Activity

refactor(.env.example): simplify and document environment variables

Browse Source
This commit is contained in:
sankalp committed 2025-06-03 13:59:02 +05:45
1 parent 3bd95f6abe
commit ae1ce706e9
1 file changed
-27
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
-27
View File
@@ -1,25 +1,17 @@
# Django Settings # Django Settings
# Required: Secret key for Django's cryptographic signing # Required: Secret key for Django's cryptographic signing
DJANGO_SECRET_KEY=your-secret-key-here DJANGO_SECRET_KEY=your-secret-key-here
# Optional: Enable debug mode (True/False)
DJANGO_DEBUG=True DJANGO_DEBUG=True
# Optional: Comma-separated list of allowed hosts
DJANGO_ALLOWED_HOSTS=* DJANGO_ALLOWED_HOSTS=*
# Database Configuration # Database Configuration
# Optional: Database engine (default: django.db.backends.sqlite3) # Optional: Database engine (default: django.db.backends.sqlite3)
DB_ENGINE=django.db.backends.sqlite3 DB_ENGINE=django.db.backends.sqlite3
# Optional: Database name (default: db.sqlite3)
DB_NAME=db.sqlite3 DB_NAME=db.sqlite3
# Optional: Database timeout in seconds (default: 20)
DB_TIMEOUT=20 DB_TIMEOUT=20
# Optional: Database host (required for non-SQLite databases)
DB_HOST= DB_HOST=
# Optional: Database port (required for non-SQLite databases)
DB_PORT= DB_PORT=
# Optional: Database user (required for non-SQLite databases)
DB_USER= DB_USER=
# Optional: Database password (required for non-SQLite databases)
DB_PASSWORD= DB_PASSWORD=
# Cache Configuration # Cache Configuration
@@ -27,57 +19,38 @@ DB_PASSWORD=
USE_REDIS_CACHE=True USE_REDIS_CACHE=True
# Optional: Redis URL (default: redis://localhost:6379/1) # Optional: Redis URL (default: redis://localhost:6379/1)
REDIS_URL=redis://localhost:6379/1 REDIS_URL=redis://localhost:6379/1
# Optional: Cache timeout in seconds (default: 300)
CACHE_TIMEOUT=300 CACHE_TIMEOUT=300
# Optional: Cache key prefix (default: sms)
CACHE_KEY_PREFIX=sms CACHE_KEY_PREFIX=sms
# Optional: Maximum number of cache connections (default: 1000)
CACHE_MAX_CONNECTIONS=1000 CACHE_MAX_CONNECTIONS=1000
# Email Configuration # Email Configuration
# Optional: Email backend (default: django.core.mail.backends.console.EmailBackend) # Optional: Email backend (default: django.core.mail.backends.console.EmailBackend)
EMAIL_BACKEND=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 DEFAULT_FROM_EMAIL=noreply@studentmanagementsystem.com
# Optional: Email host (required for SMTP backend)
EMAIL_HOST= EMAIL_HOST=
# Optional: Email port (required for SMTP backend)
EMAIL_PORT= EMAIL_PORT=
# Optional: Email username (required for SMTP backend)
EMAIL_USERNAME= EMAIL_USERNAME=
# Optional: Email password (required for SMTP backend)
EMAIL_PASSWORD= EMAIL_PASSWORD=
# Optional: Use TLS for email (True/False)
EMAIL_USE_TLS=True EMAIL_USE_TLS=True
# Firebase Configuration # Firebase Configuration
# Required: Firebase API key # Required: Firebase API key
FIREBASE_API_KEY=your_firebase_api_key_here FIREBASE_API_KEY=your_firebase_api_key_here
# Required: Firebase auth domain
FIREBASE_AUTH_DOMAIN=your_project_id.firebaseapp.com FIREBASE_AUTH_DOMAIN=your_project_id.firebaseapp.com
# Required: Firebase project ID
FIREBASE_PROJECT_ID=your_project_id FIREBASE_PROJECT_ID=your_project_id
# Required: Firebase storage bucket
FIREBASE_STORAGE_BUCKET=your_project_id.firebasestorage.app FIREBASE_STORAGE_BUCKET=your_project_id.firebasestorage.app
# Required: Firebase messaging sender ID
FIREBASE_MESSAGING_SENDER_ID=your_sender_id FIREBASE_MESSAGING_SENDER_ID=your_sender_id
# Required: Firebase app ID
FIREBASE_APP_ID=your_app_id FIREBASE_APP_ID=your_app_id
# Required: Firebase measurement ID
FIREBASE_MEASUREMENT_ID=your_measurement_id FIREBASE_MEASUREMENT_ID=your_measurement_id
# SMS Configuration # SMS Configuration
# Required: SMS API key # Required: SMS API key
SMS_API_KEY=your_sms_api_key_here SMS_API_KEY=your_sms_api_key_here
# Optional: SMS sender ID (default: SMSSYS)
SMS_SENDER_ID=SMSSYS SMS_SENDER_ID=SMSSYS
# Gunicorn Configuration # Gunicorn Configuration
# Optional: Number of worker processes (default: 4) # Optional: Number of worker processes (default: 4)
GUNICORN_WORKERS=4 GUNICORN_WORKERS=4
# Optional: Number of threads per worker (default: 2)
GUNICORN_THREADS=2 GUNICORN_THREADS=2
# Optional: Worker timeout in seconds (default: 30)
GUNICORN_TIMEOUT=30 GUNICORN_TIMEOUT=30
# Optional: Keep-alive timeout in seconds (default: 2)
GUNICORN_KEEPALIVE=2 GUNICORN_KEEPALIVE=2