deploy

.env.example

@@ -1,24 +1,33 @@
-# WooCommerce API (Legacy - not currently used)
-WOOCOMMERCE_URL=https://klz-cables.com
-WOOCOMMERCE_CONSUMER_KEY=
-WOOCOMMERCE_CONSUMER_SECRET=
-WORDPRESS_APP_PASSWORD=
+# ============================================================================
+# KLZ Cables - Environment Configuration
+# ============================================================================
+# Copy this file to .env for local development
+# For production, use .env.production as a template
+# ============================================================================
 
-# Umami Analytics
-NEXT_PUBLIC_UMAMI_WEBSITE_ID=
-UMAMI_SCRIPT_URL=https://analytics.infra.mintel.me/script.js
-
-# GlitchTip (Sentry protocol)
-SENTRY_DSN=
-# Client-side DSN should use the proxy path: https://[key]@[domain]/errors/[id]
-NEXT_PUBLIC_SENTRY_DSN=
-
-# Application
+# ────────────────────────────────────────────────────────────────────────────
+# Application Configuration
+# ────────────────────────────────────────────────────────────────────────────
 NODE_ENV=development
 NEXT_PUBLIC_BASE_URL=http://localhost:3000
-LOG_LEVEL=info
 
-# SMTP Configuration
+# ────────────────────────────────────────────────────────────────────────────
+# Analytics (Umami)
+# ────────────────────────────────────────────────────────────────────────────
+# Optional: Leave empty to disable analytics
+NEXT_PUBLIC_UMAMI_WEBSITE_ID=
+NEXT_PUBLIC_UMAMI_SCRIPT_URL=https://analytics.infra.mintel.me/script.js
+
+# ────────────────────────────────────────────────────────────────────────────
+# Error Tracking (GlitchTip/Sentry)
+# ────────────────────────────────────────────────────────────────────────────
+# Optional: Leave empty to disable error tracking
+SENTRY_DSN=
+
+# ────────────────────────────────────────────────────────────────────────────
+# Email Configuration (SMTP)
+# ────────────────────────────────────────────────────────────────────────────
+# Required for contact form functionality
 MAIL_HOST=smtp.eu.mailgun.org
 MAIL_PORT=587
 MAIL_USERNAME=
@@ -26,6 +35,45 @@ MAIL_PASSWORD=
 MAIL_FROM=KLZ Cables <noreply@klz-cables.com>
 MAIL_RECIPIENTS=info@klz-cables.com
 
-# Redis Configuration (optional)
-REDIS_URL=redis://redis:6379/2
+# ────────────────────────────────────────────────────────────────────────────
+# Redis Cache Configuration
+# ────────────────────────────────────────────────────────────────────────────
+# Optional: Leave empty to disable Redis caching
+REDIS_URL=redis://localhost:6379/2
 REDIS_KEY_PREFIX=klz:
+
+# ────────────────────────────────────────────────────────────────────────────
+# Logging
+# ────────────────────────────────────────────────────────────────────────────
+LOG_LEVEL=info
+
+# ────────────────────────────────────────────────────────────────────────────
+# Varnish Cache (Docker only)
+# ────────────────────────────────────────────────────────────────────────────
+VARNISH_CACHE_SIZE=256m
+
+# ============================================================================
+# IMPORTANT NOTES
+# ============================================================================
+#
+# BUILD-TIME vs RUNTIME Variables:
+# ─────────────────────────────────
+# • NEXT_PUBLIC_* variables are baked into the client bundle at BUILD time
+#   They must be provided as --build-arg when building the Docker image
+#
+# • All other variables are used at RUNTIME only
+#   They are loaded from the .env file by docker-compose
+#
+# Docker Deployment:
+# ──────────────────
+# 1. Build-time: Only NEXT_PUBLIC_* vars are needed (via --build-arg)
+# 2. Runtime: All vars are loaded from .env file on the server
+# 3. The .env file should exist at: /home/deploy/sites/klz-cables.com/.env
+#
+# Security:
+# ─────────
+# • NEVER commit .env files with real credentials to git
+# • Use Gitea/GitHub secrets for CI/CD workflows
+# • Store production .env file securely on the server only
+#
+# ============================================================================