From e8ec94bfa85261dcb2a0e6bd4f055da819153b6f Mon Sep 17 00:00:00 2001
From: hackerESQ <corey@coreyvarma.com>
Date: Sat, 25 Jan 2025 23:36:33 -0600
Subject: [PATCH] add in-line docs to env

---
 .env.example | 43 +++++++++++++++++++++++++++++++------------
 1 file changed, 31 insertions(+), 12 deletions(-)

diff --git a/.env.example b/.env.example
index 85e48ee..52f8928 100644
--- a/.env.example
+++ b/.env.example
@@ -1,20 +1,39 @@
-APP_KEY=                                # Generate a secure key using `openssl rand -base64 32`
-APP_TIMEZONE=UTC                        # Timezone used internally
-APP_PORT=8000                           # Port for NGINX to listen on 
-APP_URL="http://localhost:${APP_PORT}"  # Used internally to generate absolute links 
-ASSET_URL="${APP_URL}"                  # Webroot for static assets (css, js, images, etc)
-REGISTRATION_ENABLED=true               # Enable or disable new user registration
+# Generate a secure key using `openssl rand -base64 32`
+APP_KEY=
 
-AI_CHAT_ENABLED=false                   # Enable or disable AI chat feature
-OPENAI_API_KEY=                         # API key for OpenAI (for Llama support, see docs)
-OPENAI_ORGANIZATION=                    # Org ID for OpenAI
+# Timezone used internally
+APP_TIMEZONE=UTC
 
-MARKET_DATA_PROVIDER=yahoo              # Market data provider to use (comma separated list)
-MARKET_DATA_REFRESH=30
-DAILY_CHANGE_TIME=
+# Port for NGINX to listen on 
+APP_PORT=8000
+
+# Used internally to generate absolute links 
+APP_URL="http://localhost:${APP_PORT}"
+
+# Webroot for static assets (css, js, images, etc)
+ASSET_URL="${APP_URL}"
+
+# Enables or disables new user registration
+REGISTRATION_ENABLED=true
+
+# Enable or disable AI chat feature
+AI_CHAT_ENABLED=false
+
+# API key for OpenAI (for Llama support, see docs)
+OPENAI_API_KEY=
+OPENAI_ORGANIZATION=
+
+# Market data provider to use (comma separated list)
+MARKET_DATA_PROVIDER=yahoo
 ALPHAVANTAGE_API_KEY=
 FINNHUB_API_KEY=
 
+# Cadence to refresh market data (in minutes)
+MARKET_DATA_REFRESH=30
+DAILY_CHANGE_TIME=
+
+#### Advanced configurations ####
+
 ENABLED_LOGIN_PROVIDERS= 
 GITHUB_CLIENT_ID=
 GITHUB_CLIENT_SECRET=