From e8d2703050788604d1dc1ebb1418449bfc6526ed Mon Sep 17 00:00:00 2001
From: Piotr Tomczewski <piotr.tomczewski@callstack.com>
Date: Wed, 13 Nov 2024 12:39:16 +0100
Subject: [PATCH] chore: update formatting of `.env.example` for better
 readability

---
 api/.env.example | 114 ++++++++++++++++++++++++-----------------------
 1 file changed, 59 insertions(+), 55 deletions(-)

diff --git a/api/.env.example b/api/.env.example
index 90cbef7..7595fe4 100644
--- a/api/.env.example
+++ b/api/.env.example
@@ -1,70 +1,74 @@
-# Environment variables for CodePush Server
+##########################################
+# Environment Variables for CodePush Server
+##########################################
 
-# Storage Configuration
-# Set to 'true' to use the local emulator instead of a hosted instance
-EMULATED=false
+# ==============================
+# Storage Configuration (REQUIRED - choose one)
+# ==============================
+EMULATED=false # Set to 'true' to use the local emulator
 
-# Azure Storage Configuration
-# The name of your hosted Azure storage instance
-AZURE_STORAGE_ACCOUNT=
-# The key to your Azure storage instance (if KeyVault credentials are not provided)
-AZURE_STORAGE_ACCESS_KEY=
+# --- Azure Storage Configuration ---
+AZURE_STORAGE_ACCOUNT=    # Azure storage account name
+AZURE_STORAGE_ACCESS_KEY= # Azure storage access key (if KeyVault not used)
 
-# Server Configuration
-# The URL of your server
-SERVER_URL=http://localhost:3000
+# ==============================
+# Server Configuration (REQUIRED)
+# ==============================
+SERVER_URL=http://localhost:3000 # The URL of your server
 
-# GitHub OAuth Configuration
-GITHUB_CLIENT_ID=
-GITHUB_CLIENT_SECRET=
+# ==============================
+# Authentication (REQUIRED - at least one provider)
+# ==============================
 
-# Microsoft OAuth Configuration
-MICROSOFT_CLIENT_ID=
-MICROSOFT_CLIENT_SECRET=
+# --- GitHub OAuth ---
+GITHUB_CLIENT_ID=     # GitHub OAuth client ID
+GITHUB_CLIENT_SECRET= # GitHub OAuth client secret
 
-# HTTPS Configuration
-# Set to 'true' to enable HTTPS for local deployment
-HTTPS=
+# --- Microsoft OAuth ---
+MICROSOFT_CLIENT_ID=     # Microsoft OAuth client ID
+MICROSOFT_CLIENT_SECRET= # Microsoft OAuth client secret
 
-# Debugging Configuration
-# Turn on CodePush-specific logging of API and Storage requests
-LOGGING=false
-# Disable the OAuth authentication route
-DEBUG_DISABLE_AUTH=false
-# Backend id of user to behave as during the debugging session
-DEBUG_USER_ID=
+# ==============================
+# Optional Configuration
+# ==============================
 
+# --- HTTPS Configuration ---
+HTTPS= # Set to 'true' to enable HTTPS for local deployment
+
+# --- Debugging Configuration ---
+LOGGING=false            # Enable CodePush-specific logging
+DEBUG_DISABLE_AUTH=false # Disable OAuth authentication route
+DEBUG_USER_ID=           # Backend user ID for debugging session
+
+# ==============================
 # Redis Configuration
-# The IP address where the Redis server is hosted
-REDIS_HOST=
-# The port which Redis is listening on
-REDIS_PORT=6379
-# The key used to authenticate requests to the Redis cache
-REDIS_KEY=
+# ==============================
+REDIS_HOST=     # Redis server IP address
+REDIS_PORT=6379 # Redis port (default: 6379)
+REDIS_KEY=      # Redis authentication key
 
+# ==============================
 # Unit Testing Configuration
-# Set to 'true' to run API unit tests against Azure storage
-TEST_AZURE_STORAGE=false
-# If TEST_AZURE_STORAGE is set to true, set to the account of the storage you would like to test on
-AZURE_STORAGE_ACCOUNT=
-# If TEST_AZURE_STORAGE is set to true, set to the access key of the storage you would like to test on
-AZURE_STORAGE_ACCESS_KEY=
+# ==============================
+TEST_AZURE_STORAGE=false  # Run API unit tests against Azure storage
+AZURE_STORAGE_ACCOUNT=    # Storage account for testing (if TEST_AZURE_STORAGE=true)
+AZURE_STORAGE_ACCESS_KEY= # Storage access key for testing
 
-# Set to a Azure url to run acquisition tests against that server
-AZURE_ACQUISITION_URL=
+AZURE_ACQUISITION_URL= # URL for acquisition tests
 
+# ==============================
 # Other Configuration
-# Set to 'true' to disable acquisition routes
-DISABLE_ACQUISITION=false
-# Set to 'true' to disable management routes
-DISABLE_MANAGEMENT=false
-# Set to 'false' in order to disable account registration
-ENABLE_ACCOUNT_REGISTRATION=true
-# Set to the max number of megabytes allowed for file uploads
-UPLOAD_SIZE_LIMIT_MB=200
-
-# To enable generating diffs for releases
-ENABLE_PACKAGE_DIFFING=false
+# ==============================
+DISABLE_ACQUISITION=false        # Disable acquisition routes
+DISABLE_MANAGEMENT=false         # Disable management routes
+ENABLE_ACCOUNT_REGISTRATION=true # Enable account registration
+UPLOAD_SIZE_LIMIT_MB=200         # Max file upload size (in MB)
+ENABLE_PACKAGE_DIFFING=false     # Enable generating diffs for releases
 
-# To enable KeyVault credential resolution
-# Add any additional environment variables here
+# ==============================
+# Azure KeyVault Configuration (Optional)
+# ==============================
+AZURE_KEYVAULT_ACCOUNT=               # Azure KeyVault account name
+CLIENT_ID=                            # Active Directory app client ID
+CERTIFICATE_THUMBPRINT=               # AD app certificate thumbprint
+REFRESH_CREDENTIALS_INTERVAL=86400000 # Credential refresh interval (in ms, default: 1 day)