diff --git a/env.default b/env.default index 6073916..62c1220 100644 --- a/env.default +++ b/env.default @@ -1,131 +1,102 @@ -# One Sky IT's Aether Framework and System (Template) -TZ=US/Eastern +# ------------------------------------------------------------------------------ +# AETHER FRAMEWORK - DOCKER ENVIRONMENT CONFIGURATION (TEMPLATE) +# ------------------------------------------------------------------------------ +# Instructions: Copy this to .env and update the paths and credentials. +# ------------------------------------------------------------------------------ +# System Settings +TZ=US/Eastern +OSIT_ENV=development +AE_LOG_LVL=warning + +# Container Names CONTAINER_WEB=ae_web_default CONTAINER_AE_API=ae_api_default -CONTAINER_AE_API_RED=ae_api_default_red -CONTAINER_AE_API_GREEN=ae_api_default_green -CONTAINER_AE_API_BLUE=ae_api_default_blue -CONTAINER_AE_API_BLACK=ae_api_default_black -CONTAINER_AE_API_WHITE=ae_api_default_white CONTAINER_AE_APP=ae_app_default -CONTAINER_PHP7=ae_php7_default CONTAINER_REDIS=ae_redis_default +CONTAINER_MARIADB=ae_mariadb_default +CONTAINER_PMA=ae_pma_default -OSIT_ENV=development -# OSIT_ENV=production -# OSIT_ENV=testing - -AE_LOG_LVL=warning # Python loglevel: warning, info, debug, etc - +# ------------------------------------------------------------------------------ +# NETWORK & PROXY SETTINGS +# ------------------------------------------------------------------------------ +# Local Nginx Ports OSIT_WEB_HTTP_PORT=8080 OSIT_WEB_HTTPS_PORT=4443 -# Max body size is for nginx gunicorn apps (AE app and AE API) OSIT_WEB_MAX_BODY_SIZE=5120M -# For now this extra host variable is important for the AE Flask app to connect to the AE FastAPI API. -DOCKER_AE_SERVER_EXTRA_HOST=example.oneskyit.com:192.168.32.20 -DOCKER_AE_APP_SERVER_EXTRA_HOST=example-app.oneskyit.com:192.168.32.20 -DOCKER_AE_API_SERVER_EXTRA_HOST=example-api.oneskyit.com:192.168.32.20 -DOCKER_AE_API_BAK_SERVER_EXTRA_HOST=example-bak-api.oneskyit.com:192.168.32.20 -DOCKER_AE_APP_EXTRA_HOST=example-api.oneskyit.com:192.168.32.20 -DOCKER_AE_DB_SERVER_EXTRA_HOST=db.oneskyit.com:104.237.143.4 +# Gateway Port for External Reverse Proxy +AE_API_GATEWAY_PORT=5060 -# This is the server name for nginx for each of these sites. +# DNS Overrides +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_DB_SERVER_EXTRA_HOST=db.oneskyit.com:127.0.0.1 + +# Nginx Server Names 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 DOCKER_OSIT_SERVER_NAME=example-docker.oneskyit.com -# This needs to be updated for each client's subdomain. -OSIT_NGINX_SERVER_NAMES=flask_gunicorn.localhost,demo.localhost,example.localhost,example.oneskyit.com - -# Aether general shared config options -AE_CFG_ID=0 -AE_SERVER=example.oneskyit.com - -## Aether API access and use -AE_API_PROTOCOL=https -AE_API_SERVER=example-api.oneskyit.com -AE_API_SERVER_INTERNAL=example-api.oneskyit.com -AE_API_PORT=443 -AE_API_SECRET_KEY=the-secret-api-key - -## Aether DB access and use +# ------------------------------------------------------------------------------ +# DATABASE SETTINGS (MariaDB) +# ------------------------------------------------------------------------------ AE_DB_SERVER=mariadb AE_DB_PORT=3306 AE_DB_NAME=aether_dev AE_DB_USERNAME=osit_aether -AE_DB_PASSWORD="the-password-with-\$\$-escape" +AE_DB_PASSWORD="your-password-here" -# MariaDB timeouts -AE_DB_WAIT_TIMEOUT=1800 +# Connection Tuning AE_DB_CONNECTION_TIMEOUT=15 AE_DB_POOL_RECYCLE=1800 -## Aether Redis access and use +# ------------------------------------------------------------------------------ +# REDIS SETTINGS +# ------------------------------------------------------------------------------ AE_REDIS_SERVER=redis AE_REDIS_PORT=6379 -## Aether SMTP access and use -AE_SMTP_SERVER=linode.oneskyit.com -AE_SMTP_PORT=465 -AE_SMTP_USERNAME=send_mail - -# Aether API specific config options (FastAPI) +# ------------------------------------------------------------------------------ +# API SETTINGS (FastAPI) +# ------------------------------------------------------------------------------ AE_API_ENV=development -AE_API_DIR=/srv/aether_api -AE_API_LOG_PATH="/logs/aether_api.log" +AE_API_REPLICAS=2 AE_API_GUNICORN_PORT=5065 -AE_API_GUNICORN_PORT_RED=5066 -AE_API_GUNICORN_PORT_GREEN=5067 AE_API_GUNICORN_TIMEOUT=2100 -AE_API_GUNICORN_GRACEFUL_TIMEOUT=20 -AE_API_GUNICORN_KEEPALIVE=5 AE_API_GUNICORN_WORKERS=2 AE_API_GUNICORN_THREADS=2 -AE_API_RELOAD=False -AE_API_JWT_KEY="ABC123_22_CHARS_SEC_KEY" +AE_API_JWT_KEY="your-22-char-secret-key" AE_API_ORIGINS_REGEX="(https://.*\.oneskyit\.com)|(https://.*\.oneskyit\.com:4443)" -# Aether app specific config (Flask with Svelte) -AE_APP_CFG_ID=0 +# ------------------------------------------------------------------------------ +# APP SETTINGS (Legacy Flask) +# ------------------------------------------------------------------------------ AE_APP_ENV=development -AE_APP_UX_MODE=default -AE_APP_DIR=/srv/aether_app -AE_APP_LOG_PATH="/logs/aether_app.log" AE_APP_GUNICORN_PORT=5055 -AE_APP_GUNICORN_TIMEOUT=1200 -AE_APP_GUNICORN_GRACEFUL_TIMEOUT=20 -AE_APP_GUNICORN_KEEPALIVE=30 -AE_APP_GUNICORN_WORKERS=2 -AE_APP_GUNICORN_THREADS=1 -AE_APP_RELOAD=True -AE_APP_CACHE_SECRET_KEY="CACHE_SECRET_KEY" +AE_APP_CACHE_SECRET_KEY="your-secret-key" AE_APP_SESSION_LIFETIME=86400 AE_APP_CACHE_TIMEOUT=5 # ------------------------------------------------------------------------------ -# DOCKER VOLUME SOURCE PATHS +# SOURCE PATHS (Absolute paths on Host) # ------------------------------------------------------------------------------ -# These replace the fragile symlinks in srv/ -# IMPORTANT: Use absolute paths to your application source directories +# IMPORTANT: Update these to match your local filesystem AE_API_SRC=/path/to/aether_api_fastapi AE_APP_SRC=/path/to/aether_app_flask HOSTED_FILES_SRC=/path/to/hosted_files HOSTED_TMP_SRC=/path/to/hosted_tmp # ------------------------------------------------------------------------------ -# SERVICES CONFIG +# SERVICE TUNING # ------------------------------------------------------------------------------ AE_PMA_PORT=8081 -AE_API_GATEWAY_PORT=5060 -AE_API_REPLICAS=2 - -# MariaDB Tuning (Adjust per environment hardware) +# MariaDB Performance 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 \ No newline at end of file