From 2df72cc692a1d86ef9cf4cf843624d05040a10b6 Mon Sep 17 00:00:00 2001 From: Nitin Date: Fri, 25 Jul 2025 17:45:33 +0530 Subject: [PATCH] docs(example.env): improve clarity of docker/example.env config for self-hosting (@nitin-is-me) (#6777) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### 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 --- docker/example.env | 61 +++++++++++++++++++++++----------------------- 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/docker/example.env b/docker/example.env index 52af38e91..b0e3f9417 100644 --- a/docker/example.env +++ b/docker/example.env @@ -1,45 +1,44 @@ -#url of the frontend, this must be accessible by your clients browser +# Copy this file to `.env` before starting the containers + +### === Required Config === + +# URL of the frontend (accessible by browser) MONKEYTYPE_FRONTENDURL=http://myserver:8080 -#url of the backend server, this must be accessible by your clients browser +# URL of the backend (accessible by browser) MONKEYTYPE_BACKENDURL=http://myserver:5005 -# firebase config -# uncomment below config if you need user accounts -#FIREBASE_APIKEY= -#FIREBASE_AUTHDOMAIN= -#FIREBASE_PROJECTID= -#FIREBASE_STORAGEBUCKET= -#FIREBASE_MESSAGINGSENDERID= -#FIREBASE_APPID= +### === Optional: Google reCAPTCHA === +# Default keys below work for localhost/private instances +# RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI +# RECAPTCHA_SECRET=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe -# email server config -# uncomment below if you want to send emails for e.g. password reset -#EMAIL_HOST=mail.myserver -#EMAIL_USER=mailuser -#EMAIL_PASS=mailpass -#EMAIL_PORT=465 -#EMAIL_FROM="Support " - -# google recaptcha -# uncomment below config if you need user accounts -# you can use these defaults if you host this privately -#RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI -#RECAPTCHA_SECRET=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe RECAPTCHA_SITE_KEY= RECAPTCHA_SECRET= -# use alternative ports +### === Optional: Firebase === + +# Uncomment if using user accounts +# FIREBASE_APIKEY=AIzaSy******** +# FIREBASE_AUTHDOMAIN=your-app.firebaseapp.com +# FIREBASE_PROJECTID=your-app +# FIREBASE_STORAGEBUCKET=your-app.appspot.com +# FIREBASE_MESSAGINGSENDERID=1234567890 +# FIREBASE_APPID=1:1234567890:web:abcdef123456 + +### === Optional: Email Server === +# Enables email (e.g. password reset) + +# EMAIL_HOST=smtp.mailserver.com +# EMAIL_USER=your@email.com +# EMAIL_PASS=password +# EMAIL_PORT=465 +# EMAIL_FROM="Support " + +### === Optional: Custom Ports === -# port of the frontend http server # HTTP_PORT=8080 - -# port of the backend api server # BACKEND_PORT=5005 - -# port of the redis server, not exposed by default # REDIS_PORT=6379 - -# port of the mongodb server, not exposed by default # MONGO_PORT=27017