refactor(config): Simplify environment configuration and standardize variable naming

Author: Bit-Maximum

.env.example

@@ -1,36 +1,32 @@
+# Environment: debug, local, pytest, staging, production
+ENVIRONMENT=local
+
 APP_VERSION=latest
-RELOAD=True
-USERS_SECRET="changethis"
+USERS_SECRET=changethis
+
+LOG_FILE_PATH=logs/app.log
 # Domain
-# This would be set to the production domain with an env var on deployment
+# This would be set to the production services with an env var on deployment
 # used by Traefik to transmit traffic and aqcuire TLS certificates
-DOMAIN=localhost
+TRAEFIK_DOMAIN=localhost
 # To test the local Traefik config
 # DOMAIN=localhost.myapp.com
 APP_HOST=0.0.0.0
-HOST_FILESYSTEM=/
-DOCKER_SOCK=/var/run/docker.sock
-# Used by the backend to generate links in emails to the frontend
-FRONTEND_HOST=http://localhost:5173
+TRAEFIK_HOST_FILESYSTEM=/
+TRAEFIK_DOCKER_SOCK=/var/run/docker.sock
 # In staging and production, set this env var to the frontend host, e.g.
 # FRONTEND_HOST=https://dashboard.example.com
 API_BASE_PATH=/api
-# Environment: local, pytest, staging, production
-ENVIRONMENT=local
-
-PROJECT_NAME="FastAPI Feature-rich Template"
-STACK_NAME=fastapi-project
 
+TRAEFIK_STACK_NAME=myapp
+TRAEFIK_SWAGER_STATIC_DIR=api
 # Backend
 API_CONTAINER_HOST=app-api
 API_TASKIQ_CONTAINER_HOST=api-taskiq
-BACKEND_CORS_ORIGINS="http://localhost,http://localhost:5173,https://localhost,https://localhost:5173,http://localhost.tiangolo.com"
 SECRET_KEY=changethis
-FIRST_SUPERUSER=admin@example.com
-FIRST_SUPERUSER_PASSWORD=changethis
 
 # Uvicorn
-UVICORN_HOST=127.0.0.1
+UVICORN_HOST=0.0.0.0
 UVICORN_PORT=8000
 UVICORN_WORKERS_COUNT=1
 UVICORN_RELOAD=True
@@ -49,7 +45,7 @@ DB_CONTAINER_HOST=app-db
 DB_PORT=5432
 DB_NAME=app
 DB_USER=postgres
-DB_PASSWORD=changethis
+DB_PASS=changethis
 DB_DATAPATH=/var/lib/postgresql/data/pgdata
 DB_ECHO=False
 
@@ -64,11 +60,11 @@ CONNECTION_POOL_RECYCLE=1800
 
 # Redis
 REDIS_CONTAINER_HOST=app-redis
-REDIS_USER=redis
+#REDIS_USER=redis
 REDIS_PORT=6379
 REDIS_DATABASE=redis
-REDIS_PASS=changethis
-REDIS_MASTER_PASSWORD=changethis
+REDIS_PASS=nil
+REDIS_MASTER_PASSWORD=nil
 
 # RabbitMQ
 RABBITMQ_CONTAINER_HOST=app-rmq
@@ -84,46 +80,45 @@ KAFKA_CONTAINER_HOST=app-kafka
 KAFKA_CFG_NODE_ID=0
 KAFKA_CFG_PROCESS_ROLES=controller,broker
 KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093,EXTERNAL://:9094
-KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://localhost:9094
+KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9092,EXTERNAL://localhost:9094
 KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,EXTERNAL:PLAINTEXT,PLAINTEXT:PLAINTEXT
-KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@app-kafka:9093
+KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@${KAFKA_CONTAINER_HOST}:9093
 KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
 KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE=true
 KAFKA_CFG_OFFSETS_TOPIC_REPLICATION_FACTOR=1
 KAFKA_CFG_HEALTHCHECK_PORT=9092
 KAFKA_PORT=9092
-KAFKA_HOST=kafka
-KAFKA_ADDR=${KAFKA_HOST}:${KAFKA_PORT}
+KAFKA_ADDR=["${KAFKA_CONTAINER_HOST}:${KAFKA_PORT}"]
 
 # Sentry
 SENTRY_DSN=
 SENTRY_ALLOW_BEACON_REPORTS=False
 SENTRY_TRACES_SAMPLE_RATE=1.0
 SENTRY_PROFILES_SAMPLE_RATE=0.1
 
-# OpenTelemetry Collector
-OTEL_COLLECTOR_HOST=otel-collector
-OTEL_COLLECTOR_PORT_GRPC=4317
-OTEL_COLLECTOR_PORT_HTTP=4318
-OTEL_COLLECTOR_CONFIG=./src/otel-collector/otelcol-config.yml
-OTEL_COLLECTOR_CONFIG_EXTRAS=./src/otel-collector/otelcol-config-extras.yml
-OTEL_EXPORTER_OTLP_ENDPOINT=http://${OTEL_COLLECTOR_HOST}:${OTEL_COLLECTOR_PORT_GRPC}
-PUBLIC_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:8080/otlp-http/v1/traces
-# OpenTelemetry Resource Definitions
-OTEL_RESOURCE_ATTRIBUTES=service.namespace=opentelemetry-demo,service.version=${IMAGE_VERSION}
-# Metrics Temporality
-OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE=cumulative
-
-# ********************
-# Telemetry Components
-# ********************
-# Grafana
-GRAFANA_PORT=3000
-GRAFANA_HOST=grafana
-
-# Jaeger
-JAEGER_PORT=16686
-JAEGER_HOST=jaeger
+## OpenTelemetry Collector
+#OTEL_COLLECTOR_HOST=otel-collector
+#OTEL_COLLECTOR_PORT_GRPC=4317
+#OTEL_COLLECTOR_PORT_HTTP=4318
+#OTEL_COLLECTOR_CONFIG=./src/otel-collector/otelcol-config.yml
+#OTEL_COLLECTOR_CONFIG_EXTRAS=./src/otel-collector/otelcol-config-extras.yml
+#OTEL_EXPORTER_OTLP_ENDPOINT=http://${OTEL_COLLECTOR_HOST}:${OTEL_COLLECTOR_PORT_GRPC}
+#PUBLIC_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:8080/otlp-http/v1/traces
+## OpenTelemetry Resource Definitions
+#OTEL_RESOURCE_ATTRIBUTES=service.namespace=opentelemetry-demo,service.version=${IMAGE_VERSION}
+## Metrics Temporality
+#OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE=cumulative
+#
+## ********************
+## Telemetry Components
+## ********************
+## Grafana
+#GRAFANA_PORT=3000
+#GRAFANA_HOST=grafana
+#
+## Jaeger
+#JAEGER_PORT=16686
+#JAEGER_HOST=jaeger
 
 # Prometheus
 PROMETHEUS_PORT=9090
@@ -135,29 +130,13 @@ DOCKER_IMAGE_BACKEND=backend
 DOCKER_IMAGE_FRONTEND=frontend
 
 # CORE SETTINGS
-BACKEND_CORS_ORIGINS=["http://localhost:3000", "https://myfrontendapp.com"]
-ALLOWED_HOSTS=["localhost", "127.0.0.1"]
-APP_LOG_DIR=logs # This path will be declareted in the docker-compose.yml file
-APP_LOG_FILE_PATH=${APP_LOG_DIR}/app.log
-
-# POSTGRESQL DATABASE
-POSTGRES_SERVER=db
-POSTGRES_USER=postgres
-POSTGRES_PASSWORD=postgres
-POSTGRES_PORT=5432
-POSTGRES_DB=app-db
-
-# PGADMIN
-PGADMIN_DEFAULT_EMAIL=admin@mail.com
-PGADMIN_DEFAULT_PASSWORD=admin
+CORS_ORIGINS=["http://localhost:3000", "https://myfrontendapp.com", "http://localhost", "http://localhost:5173", "https://localhost", "https://localhost:5173", "http://localhost.tiangolo.com"]
+ALLOWED_HOSTS=["localhost", "127.0.0.1", "api.localhost"]
 
 # PROJECT SETTINGS
 BASE_API_PATH=customer-system
 API_VERSION=1.0.0
-PROJECT_NAME="Customer System"
 PROJECT_DESCRIPTION="Customer API - System Layer"
 PROJECT_VERSION=1.0.0
 CONTACT_NAME="John Doe"
 CONTACT_EMAIL="john.doe@email.com"
-
-WORKERS_COUNT=1