From 7d47f36d991e539d83c4ddc2a59c095451731a00 Mon Sep 17 00:00:00 2001
From: Dragory <2606411+Dragory@users.noreply.github.com>
Date: Sun, 7 Aug 2022 13:58:47 +0300
Subject: [PATCH] docs: documentation updates

---
 .env.example  | 4 ++++
 PRODUCTION.md | 2 ++
 2 files changed, 6 insertions(+)

diff --git a/.env.example b/.env.example
index 363e617f..aadba71b 100644
--- a/.env.example
+++ b/.env.example
@@ -6,6 +6,8 @@ CLIENT_ID=
 CLIENT_SECRET=
 BOT_TOKEN=
 
+# The defaults here automatically work for the development environment.
+# For production, change localhost:3300 to your domain.
 DASHBOARD_URL=https://localhost:3300
 API_URL=https://localhost:3300/api
 
@@ -28,6 +30,7 @@ DOCKER_USER_GID=
 
 #
 # DOCKER (DEVELOPMENT)
+# NOTE: You only need to fill in these values for running the development environment. See production config further below.
 #
 
 DOCKER_DEV_WEB_PORT=3300
@@ -50,6 +53,7 @@ DOCKER_DEV_SSH_PASSWORD=password
 
 #
 # DOCKER (PRODUCTION)
+# NOTE: You only need to fill in these values for running the production environment. See development config above.
 #
 
 DOCKER_PROD_DOMAIN=
diff --git a/PRODUCTION.md b/PRODUCTION.md
index 2a9b1baa..e05d5cc3 100644
--- a/PRODUCTION.md
+++ b/PRODUCTION.md
@@ -7,6 +7,8 @@ Zeppelin's production environment - that is, the **bot, API, and dashboard** - u
 3. Fill in the missing values in `.env`
 4. Run `docker compose -f docker-compose.production.yml up -d`
 
+**Note:** The dashboard and API are exposed with a self-signed certificate. It is recommended to set up a proxy with a proper certificate in front of them. Cloudflare is a popular choice here.
+
 ## Updating the bot
 
 ### One-click script