From 607ce3b814eba04fd35c01629abf9c01f80e6360 Mon Sep 17 00:00:00 2001
From: Henry <henry_ball@hotmail.co.uk>
Date: Fri, 13 Jun 2025 23:38:44 +0100
Subject: [PATCH] chore: tidy .env.example

---
 .env.example | 33 ++++++++++++++++++++++-----------
 1 file changed, 22 insertions(+), 11 deletions(-)

diff --git a/.env.example b/.env.example
index 48222264..e09caf70 100644
--- a/.env.example
+++ b/.env.example
@@ -1,28 +1,39 @@
-POSTGRES_URL=
+# https://github.com/kanbn/kan?tab=readme-ov-file#environment-variables-)
 
-EMAIL_FROM=
+# Required environment variables 
+NEXT_PUBLIC_BASE_URL= # e.g. https://kan.bn
+BETTER_AUTH_SECRET= # Random 32+ char string (can gen with: openssl rand -base64 24 | tr -dc 'a-zA-Z0-9' | head -c 32)
+POSTGRES_URL= # e.g. postgresql://kan:your_password@your_host:5432/kan
+
+# Only required if deploying from compose
+POSTGRES_PASSWORD=
+
+# SMTP (optional)
 SMTP_HOST=
-SMTP_PORT=
+SMTP_PORT=465 # Port 587 will not work
 SMTP_USER=
 SMTP_PASSWORD=
+EMAIL_FROM= # e.g. "Kan <hello@mail.kan.bn>"
 
-NEXT_PUBLIC_BASE_URL=
-NEXT_PUBLIC_STORAGE_URL=
-NEXT_PUBLIC_AVATAR_BUCKET_NAME=
-NEXT_PUBLIC_ALLOW_CREDENTIALS=
-NEXT_PUBLIC_DISABLE_SIGN_UP=
-
+# S3 storage (optional)
 S3_REGION=
 S3_ENDPOINT=
 S3_ACCESS_KEY_ID=
 S3_SECRET_ACCESS_KEY=
+NEXT_PUBLIC_STORAGE_URL=
+NEXT_PUBLIC_AVATAR_BUCKET_NAME=
+NEXT_PUBLIC_STORAGE_DOMAIN=
 
-BETTER_AUTH_SECRET=
-BETTER_AUTH_TRUSTED_ORIGINS=
+# Auth config (optional)
+NEXT_PUBLIC_ALLOW_CREDENTIALS=
+NEXT_PUBLIC_DISABLE_SIGN_UP=
 
+# Integration providers (optional)
 TRELLO_APP_API_KEY=
 TRELLO_APP_SECRET=
 
+# OAuth providers (optional)
+BETTER_AUTH_TRUSTED_ORIGINS=
 GOOGLE_CLIENT_ID=
 GOOGLE_CLIENT_SECRET=
 DISCORD_CLIENT_ID=