Skip to content

Commit 2df72cc

Browse files
authored
docs(example.env): improve clarity of docker/example.env config for self-hosting (@nitin-is-me) (monkeytypegame#6777)
### Description Improved the `docker/example.env` file to make it more beginner-friendly and easier to configure for self-hosters. Changes made: - Added section headers for clarity (e.g. Required Config, Firebase Config, etc.) - Clarified which settings are optional (Firebase, email, ports) - Added better inline comments explaining each env variable - Improved formatting and spacing for better readability --- ### Checks - [x] Make sure the PR title follows the Conventional Commits standard. - [ ] Adding quotes? (N/A) - [ ] Adding a language? (N/A) - [ ] Adding a theme? (N/A) - [ ] Adding a layout? (N/A) - [x] Check if any open issues are related – None that I found --- ### Closes N/A
1 parent 2af1f79 commit 2df72cc

File tree

1 file changed

+32
-33
lines changed

1 file changed

+32
-33
lines changed

docker/example.env

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,44 @@
1-
#url of the frontend, this must be accessible by your clients browser
1+
# Copy this file to `.env` before starting the containers
2+
3+
### === Required Config ===
4+
5+
# URL of the frontend (accessible by browser)
26
MONKEYTYPE_FRONTENDURL=http://myserver:8080
37

4-
#url of the backend server, this must be accessible by your clients browser
8+
# URL of the backend (accessible by browser)
59
MONKEYTYPE_BACKENDURL=http://myserver:5005
610

7-
# firebase config
8-
# uncomment below config if you need user accounts
9-
#FIREBASE_APIKEY=
10-
#FIREBASE_AUTHDOMAIN=
11-
#FIREBASE_PROJECTID=
12-
#FIREBASE_STORAGEBUCKET=
13-
#FIREBASE_MESSAGINGSENDERID=
14-
#FIREBASE_APPID=
15-
16-
17-
# email server config
18-
# uncomment below if you want to send emails for e.g. password reset
19-
#EMAIL_HOST=mail.myserver
20-
#EMAIL_USER=mailuser
21-
#EMAIL_PASS=mailpass
22-
#EMAIL_PORT=465
23-
#EMAIL_FROM="Support <noreply@myserver>"
24-
25-
# google recaptcha
26-
# uncomment below config if you need user accounts
27-
# you can use these defaults if you host this privately
28-
#RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
29-
#RECAPTCHA_SECRET=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe
11+
### === Optional: Google reCAPTCHA ===
12+
13+
# Default keys below work for localhost/private instances
14+
# RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
15+
# RECAPTCHA_SECRET=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe
16+
3017
RECAPTCHA_SITE_KEY=
3118
RECAPTCHA_SECRET=
3219

33-
# use alternative ports
20+
### === Optional: Firebase ===
3421

35-
# port of the frontend http server
36-
# HTTP_PORT=8080
22+
# Uncomment if using user accounts
23+
# FIREBASE_APIKEY=AIzaSy********
24+
# FIREBASE_AUTHDOMAIN=your-app.firebaseapp.com
25+
# FIREBASE_PROJECTID=your-app
26+
# FIREBASE_STORAGEBUCKET=your-app.appspot.com
27+
# FIREBASE_MESSAGINGSENDERID=1234567890
28+
# FIREBASE_APPID=1:1234567890:web:abcdef123456
3729

38-
# port of the backend api server
39-
# BACKEND_PORT=5005
30+
### === Optional: Email Server ===
31+
# Enables email (e.g. password reset)
4032

41-
# port of the redis server, not exposed by default
42-
# REDIS_PORT=6379
33+
# EMAIL_HOST=smtp.mailserver.com
34+
35+
# EMAIL_PASS=password
36+
# EMAIL_PORT=465
37+
# EMAIL_FROM="Support <[email protected]>"
38+
39+
### === Optional: Custom Ports ===
4340

44-
# port of the mongodb server, not exposed by default
41+
# HTTP_PORT=8080
42+
# BACKEND_PORT=5005
43+
# REDIS_PORT=6379
4544
# MONGO_PORT=27017

0 commit comments

Comments
 (0)