From 21a017a8ba19e28673c382bbaf78a491f8ef6871 Mon Sep 17 00:00:00 2001
From: Simon Larsen <simonlarsen@oneuptime.com>
Date: Mon, 17 Jul 2023 17:45:07 +0100
Subject: [PATCH] add docs around external cname

---
 config.example.env | 29 ++++++++++++++++++-----------
 1 file changed, 18 insertions(+), 11 deletions(-)

diff --git a/config.example.env b/config.example.env
index 4473656309..e719cbce84 100644
--- a/config.example.env
+++ b/config.example.env
@@ -12,10 +12,27 @@ export GLOBAL_PROBE_KEY=please-change-this-to-random-value
 
 # Which domain is this server hosted on? replace this with oneuptime.yourdomain.com or yourdomain.com. 
 export DOMAIN=localhost
-# Is this server hosted with a TLS cert. If yes, this should be "https"
+# Is this server hosted with a TLS cert (for ex: SSL from LetsEncrypt / Cloudflare). If yes, this should be "https"
 export HTTP_PROTOCOL=http
 
 
+# SMTP SETTINGS. You need to change these if you like emails to be sent. 
+export SMTP_USERNAME=
+export SMTP_PASSWORD=
+export SMTP_PORT=
+export SMTP_EMAIL=
+export SMTP_FROM_NAME=
+export SMTP_IS_SECURE=
+export SMTP_HOST=
+
+
+# If you would like to attach status page to custom domains use this setting.
+# For example, lets say you would like the status page to be hosted on status.yourcompany.com, then 
+# 1. Create a A record in your DNS provider with the name "oneuptime" and value "oneuptime.yourcompany.com"
+# 2. Set the STATUS_PAGE_CNAME_RECORD to "oneuptime.yourcompany.com"
+# 3. Create CNAME record in your DNS provider with the name "status" and value "oneuptime.yourcompany.com"
+export STATUS_PAGE_CNAME_RECORD=oneuptime.yourcompany.com
+
 
 # --------------------------------------------- #
 # You can safely ignore anything below this line. Keep them as default to make things work. 
@@ -110,14 +127,6 @@ export AIRTABLE_API_KEY=
 export AIRTABLE_BASE_ID=
 
 
-# SMTP SETTINGS
-export SMTP_USERNAME=
-export SMTP_PASSWORD=
-export SMTP_PORT=
-export SMTP_EMAIL=
-export SMTP_FROM_NAME=
-export SMTP_IS_SECURE=
-export SMTP_HOST=
 
 # Plans
 # This is in the format of <PlanName>,<PlanIdFromBillingProvider>,<MonthlySubscriptionPlanAmountInUSD>,<YearlySubscriptionPlanAmountInUSD>,<Order>,<TrialPeriodInDays>
@@ -127,8 +136,6 @@ export SUBSCRIPTION_PLAN_GROWTH=Growth,<priceMonthlyId>,<priceYearlyId>,0,0,2,14
 export SUBSCRIPTION_PLAN_SCALE=Scale,<priceMonthlyId>,<priceYearlyId>,0,0,3,0
 export SUBSCRIPTION_PLAN_ENTERPRISE=Enterprise,<priceMonthlyId>,<priceYearlyId>,-1,-1,4,14
 
-export STATUS_PAGE_CNAME_RECORD=statuspage.oneuptime.com
-
 
 export DATABASE_BACKUP_DIRECTORY=/Backups
 export DATABASE_BACKUP_HOST=localhost