chore(env): synchronize env.default and stabilize API config
Updated env.default with self-documenting comments and all active environment variables. Hardened conf/aether_api_config.py to ensure SMTP and FILES_PATH dictionaries are preserved during refactors. Integrated v3 websocket routes into Nginx template.
This commit is contained in:
Scott Idem
95
env.default
95
env.default
@@ -2,16 +2,30 @@
|
||||
# AETHER FRAMEWORK - DOCKER ENVIRONMENT CONFIGURATION (TEMPLATE)
|
||||
# ------------------------------------------------------------------------------
|
||||
# Instructions: Copy this to .env and update the paths and credentials.
|
||||
# This file serves as the master reference for all available environment variables.
|
||||
# ------------------------------------------------------------------------------
|
||||
|
||||
# System Settings
|
||||
# ------------------------------------------------------------------------------
|
||||
# SYSTEM SETTINGS
|
||||
# ------------------------------------------------------------------------------
|
||||
# System timezone for all containers
|
||||
TZ=US/Eastern
|
||||
|
||||
# Environment mode (development, testing, production)
|
||||
OSIT_ENV=development
|
||||
|
||||
# Logging level for the API and background workers (debug, info, warning, error)
|
||||
AE_LOG_LVL=warning
|
||||
# Profiles: 'database' includes mariadb, phpmyadmin, ae_ops. Comment out or leave empty for app-only nodes.
|
||||
|
||||
# Docker Compose Profiles
|
||||
# 'database' includes: mariadb, phpmyadmin, ae_ops
|
||||
# Comment out or leave empty for "app-only" nodes that connect to a remote DB
|
||||
COMPOSE_PROFILES=database
|
||||
|
||||
# Container Names
|
||||
# ------------------------------------------------------------------------------
|
||||
# CONTAINER NAMES
|
||||
# ------------------------------------------------------------------------------
|
||||
# Internal Docker container names (should be unique per environment)
|
||||
CONTAINER_WEB=ae_web_default
|
||||
CONTAINER_AE_API=ae_api_default
|
||||
CONTAINER_AE_APP=ae_app_default
|
||||
@@ -22,22 +36,27 @@ CONTAINER_PMA=ae_pma_default
|
||||
# ------------------------------------------------------------------------------
|
||||
# NETWORK & PROXY SETTINGS
|
||||
# ------------------------------------------------------------------------------
|
||||
# Local Nginx Ports
|
||||
# Local Nginx listener ports on the host system
|
||||
OSIT_WEB_HTTP_PORT=8080
|
||||
OSIT_WEB_HTTPS_PORT=4443
|
||||
|
||||
# Maximum allowed file upload size (Global for Nginx)
|
||||
OSIT_WEB_MAX_BODY_SIZE=5120M
|
||||
|
||||
# Gateway Port for External Reverse Proxy
|
||||
# Used when a master proxy (e.g. Home Server) forwards traffic to this node
|
||||
AE_API_GATEWAY_PORT=5060
|
||||
|
||||
# DNS Overrides
|
||||
# DNS Overrides (Injected into containers' /etc/hosts)
|
||||
# Format: DOMAIN:IP_ADDRESS
|
||||
# Useful for container-to-container routing when using real domain names
|
||||
DOCKER_AE_SERVER_EXTRA_HOST=example.oneskyit.com:127.0.0.1
|
||||
DOCKER_AE_APP_SERVER_EXTRA_HOST=example-app.oneskyit.com:127.0.0.1
|
||||
DOCKER_AE_API_SERVER_EXTRA_HOST=example-api.oneskyit.com:127.0.0.1
|
||||
DOCKER_AE_API_BAK_SERVER_EXTRA_HOST=example-bak-api.oneskyit.com:127.0.0.1
|
||||
DOCKER_AE_DB_SERVER_EXTRA_HOST=db.oneskyit.com:127.0.0.1
|
||||
|
||||
# Nginx Server Names
|
||||
# Nginx Server Names (Used in vhost configuration templates)
|
||||
DOCKER_AE_API_SERVER_NAME=example-api.oneskyit.com
|
||||
DOCKER_AE_APP_SERVER_NAME=example-app.oneskyit.com
|
||||
DOCKER_PHPMYADMIN_SERVER_NAME=example-phpmyadmin.oneskyit.com
|
||||
@@ -46,19 +65,23 @@ DOCKER_OSIT_SERVER_NAME=example-docker.oneskyit.com
|
||||
# ------------------------------------------------------------------------------
|
||||
# DATABASE SETTINGS (MariaDB)
|
||||
# ------------------------------------------------------------------------------
|
||||
# To use an external DB:
|
||||
# 1. Set COMPOSE_PROFILES= (empty) in .env to disable local DB containers.
|
||||
# 2. Set AE_DB_SERVER to the external IP/Hostname.
|
||||
# 3. Ensure the external DB allows connections from this host.
|
||||
# AE_DB_SERVER=HOSTNAME or IP_ADDRESS or "vpn-db.oneskyit.com"
|
||||
# To use an EXTERNAL database:
|
||||
# 1. Set COMPOSE_PROFILES= (empty) above to disable local DB containers.
|
||||
# 2. Set AE_DB_SERVER to the external IP or Hostname.
|
||||
# 3. Ensure the external DB allows connections from this host's IP.
|
||||
|
||||
# DB Hostname (use 'mariadb' for the local container, or a remote IP/FQDN)
|
||||
AE_DB_SERVER=mariadb
|
||||
AE_DB_PORT=3306
|
||||
# Port to expose on the host if running local MariaDB (default 3306)
|
||||
|
||||
# Port to expose on the host system if running a local MariaDB container
|
||||
AE_DB_EXTERNAL_PORT=3306
|
||||
|
||||
# Database credentials
|
||||
AE_DB_NAME=aether_dev
|
||||
AE_DB_USERNAME=osit_aether
|
||||
AE_DB_PASSWORD="your-password-here"
|
||||
AE_DB_ROOT_PASSWORD="mariadb-root-password-here"
|
||||
AE_DB_PASSWORD="your-secure-password-here"
|
||||
AE_DB_ROOT_PASSWORD="your-mariadb-root-password-here"
|
||||
|
||||
# Connection Tuning
|
||||
AE_DB_CONNECTION_TIMEOUT=15
|
||||
@@ -67,6 +90,7 @@ AE_DB_POOL_RECYCLE=1800
|
||||
# ------------------------------------------------------------------------------
|
||||
# REDIS SETTINGS
|
||||
# ------------------------------------------------------------------------------
|
||||
# Redis is used for caching, ID resolution, and messaging
|
||||
AE_REDIS_SERVER=redis
|
||||
AE_REDIS_PORT=6379
|
||||
|
||||
@@ -74,14 +98,32 @@ AE_REDIS_PORT=6379
|
||||
# API SETTINGS (FastAPI)
|
||||
# ------------------------------------------------------------------------------
|
||||
AE_API_ENV=development
|
||||
|
||||
# Number of API container instances to run (Docker Compose Scaling)
|
||||
AE_API_REPLICAS=2
|
||||
|
||||
# Gunicorn / Uvicorn Tuning
|
||||
AE_API_GUNICORN_PORT=5065
|
||||
AE_API_GUNICORN_TIMEOUT=2100
|
||||
AE_API_GUNICORN_WORKERS=2
|
||||
AE_API_GUNICORN_THREADS=2
|
||||
|
||||
# Security & CORS
|
||||
# JWT_KEY should be a 22+ character secret string
|
||||
AE_API_JWT_KEY="your-22-char-secret-key"
|
||||
|
||||
# Regex for allowed CORS origins
|
||||
AE_API_ORIGINS_REGEX="(https://.*\.oneskyit\.com)|(https://.*\.oneskyit\.com:4443)"
|
||||
|
||||
# ------------------------------------------------------------------------------
|
||||
# SMTP SETTINGS (Email)
|
||||
# ------------------------------------------------------------------------------
|
||||
# Core SMTP configuration for system notifications and user emails
|
||||
AE_SMTP_SERVER=smtp.example.com
|
||||
AE_SMTP_PORT=465
|
||||
AE_SMTP_USERNAME=send_mail
|
||||
AE_SMTP_PASSWORD="your-smtp-password-here"
|
||||
|
||||
# ------------------------------------------------------------------------------
|
||||
# APP SETTINGS (Legacy Flask)
|
||||
# ------------------------------------------------------------------------------
|
||||
@@ -92,24 +134,37 @@ AE_APP_SESSION_LIFETIME=86400
|
||||
AE_APP_CACHE_TIMEOUT=5
|
||||
|
||||
# ------------------------------------------------------------------------------
|
||||
# SOURCE PATHS (Absolute paths on Host)
|
||||
# SOURCE PATHS (Absolute paths on Host Machine)
|
||||
# ------------------------------------------------------------------------------
|
||||
# IMPORTANT: Update these to match your local filesystem
|
||||
# IMPORTANT: These paths must exist on the machine running Docker
|
||||
# They are mounted into containers as volumes for real-time development
|
||||
|
||||
# Project Source Code
|
||||
AE_API_SRC=/path/to/aether_api_fastapi
|
||||
AE_APP_SRC=/path/to/aether_app_flask
|
||||
|
||||
# NOTE: This is *correct* even in the *development* environment: /home/scott/OSIT/hosted_files
|
||||
# Physical File Storage (Images, Documents, etc.)
|
||||
# NOTE: Shared between environments to ensure binary availability
|
||||
HOSTED_FILES_SRC=/path/to/hosted_files
|
||||
HOSTED_TMP_SRC=/path/to/hosted_tmp
|
||||
|
||||
# ------------------------------------------------------------------------------
|
||||
# SERVICE TUNING
|
||||
# SERVICE TUNING & PERFORMANCE
|
||||
# ------------------------------------------------------------------------------
|
||||
# phpMyAdmin Host Port
|
||||
AE_PMA_PORT=8081
|
||||
|
||||
# MariaDB Performance
|
||||
# MariaDB Performance (Injected via Docker Compose command flags)
|
||||
MARIADB_MAX_CONNECTIONS=500
|
||||
MARIADB_INNODB_BUFFER_POOL_SIZE=512M
|
||||
MARIADB_QUERY_CACHE_SIZE=32M
|
||||
MARIADB_TMP_TABLE_SIZE=384M
|
||||
MARIADB_TABLE_OPEN_CACHE=4000
|
||||
MARIADB_TABLE_OPEN_CACHE=4000
|
||||
|
||||
# ------------------------------------------------------------------------------
|
||||
# AETHER SHARED CONFIG (DB Driven)
|
||||
# ------------------------------------------------------------------------------
|
||||
# Specifies which record from the 'cfg' table to use for shared settings
|
||||
# (SMTP, API routes, and external service keys)
|
||||
# common options: 1=Default, 5=Home Dev, 7=Live Test
|
||||
AE_CFG_ID=1
|
||||
|
||||
Reference in New Issue
Block a user