With Claude Code: Files named env should be renamed to .env.example to follow standard conventions. Also add warning headers indicating these are example values that must be changed (current hardcoded values like SECRET_KEY and passwords could be accidentally used in production).

Author: carlosplanchon

README.md

@@ -37,8 +37,8 @@ cp scripts/local_with_uvicorn/Dockerfile Dockerfile
 cp scripts/local_with_uvicorn/docker-compose.yml docker-compose.yml
 
 # Copy and create your environment file
-cp scripts/local_with_uvicorn/env src/.env
-# If you want, modify the minimal environment variables as described in the docs.
+cp scripts/local_with_uvicorn/.env.example src/.env
+# For local development, the example values work fine. Modify if needed.
 
 # Run everything using Docker:
 docker compose up
@@ -53,7 +53,8 @@ cp scripts/gunicorn_managing_uvicorn_workers/Dockerfile Dockerfile
 cp scripts/gunicorn_managing_uvicorn_workers/docker-compose.yml docker-compose.yml
 
 # Copy and create your environment file
-cp scripts/gunicorn_managing_uvicorn_workers/env src/.env
+cp scripts/gunicorn_managing_uvicorn_workers/.env.example src/.env
+# Recommended: Change SECRET_KEY and passwords for staging/testing environments.
 
 # Run everything using Docker:
 docker compose up
@@ -66,7 +67,8 @@ cp scripts/production_with_nginx/docker-compose.yml docker-compose.yml
 cp default.conf default.conf  # nginx configuration (already in root)
 
 # Copy and create your environment file
-cp scripts/production_with_nginx/env src/.env
+cp scripts/production_with_nginx/.env.example src/.env
+# CRITICAL: You MUST change SECRET_KEY, all passwords, and sensitive values before deploying!
 
 # Run everything using Docker:
 docker compose up

scripts/gunicorn_managing_uvicorn_workers/env renamed to scripts/gunicorn_managing_uvicorn_workers/.env.example

@@ -1,4 +1,18 @@
-# ------------- app settings ------------- 
+# ============================================================================
+# WARNING: EXAMPLE CONFIGURATION - DO NOT USE IN PRODUCTION AS-IS
+# ============================================================================
+# This file contains example values for development/testing purposes only.
+#
+# SECURITY CRITICAL: Before deploying to production, you MUST:
+#   1. Copy this file to src/.env
+#   2. Generate a new SECRET_KEY using: openssl rand -hex 32
+#   3. Change all passwords (POSTGRES_PASSWORD, ADMIN_PASSWORD, etc.)
+#   4. Update all sensitive configuration values
+#
+# Using these example values in production is a SECURITY RISK.
+# ============================================================================
+
+# ------------- app settings -------------
 APP_NAME="My Project"
 APP_DESCRIPTION="My Project Description"
 APP_VERSION="0.1"

scripts/local_with_uvicorn/env renamed to scripts/local_with_uvicorn/.env.example

@@ -1,4 +1,18 @@
-# ------------- app settings ------------- 
+# ============================================================================
+# WARNING: EXAMPLE CONFIGURATION - DO NOT USE IN PRODUCTION AS-IS
+# ============================================================================
+# This file contains example values for development/testing purposes only.
+#
+# SECURITY CRITICAL: Before deploying to production, you MUST:
+#   1. Copy this file to src/.env
+#   2. Generate a new SECRET_KEY using: openssl rand -hex 32
+#   3. Change all passwords (POSTGRES_PASSWORD, ADMIN_PASSWORD, etc.)
+#   4. Update all sensitive configuration values
+#
+# Using these example values in production is a SECURITY RISK.
+# ============================================================================
+
+# ------------- app settings -------------
 APP_NAME="My Project"
 APP_DESCRIPTION="My Project Description"
 APP_VERSION="0.1"

scripts/production_with_nginx/env renamed to scripts/production_with_nginx/.env.example

@@ -1,4 +1,18 @@
-# ------------- app settings ------------- 
+# ============================================================================
+# WARNING: EXAMPLE CONFIGURATION - DO NOT USE IN PRODUCTION AS-IS
+# ============================================================================
+# This file contains example values for development/testing purposes only.
+#
+# SECURITY CRITICAL: Before deploying to production, you MUST:
+#   1. Copy this file to src/.env
+#   2. Generate a new SECRET_KEY using: openssl rand -hex 32
+#   3. Change all passwords (POSTGRES_PASSWORD, ADMIN_PASSWORD, etc.)
+#   4. Update all sensitive configuration values
+#
+# Using these example values in production is a SECURITY RISK.
+# ============================================================================
+
+# ------------- app settings -------------
 APP_NAME="My Project"
 APP_DESCRIPTION="My Project Description"
 APP_VERSION="0.1"