.env.example

# Application Configuration
# Basic settings for your application
APP_NAME=<APP_NAME>                                 # Name of your application
PORT=<PORT>                                         # Port the application will listen on
TITLE=<TITLE>                                       # Title of the API
DESCRIPTION=<DESCRIPTION>                           # Description of the API
VERSION=<VERSION>                                   # Version of your API
AUTHOR=<AUTHOR>                                     # Author(s) of the API

# MongoDB Credentials
# Settings for connecting to MongoDB
DATA_CONNECTION_METHOD=<CONNECTION_METHOD>          # Connection method (mongodb+srv or mongodb)
DATA_SOURCE_USERNAME=<USERNAME>                     # MongoDB username
DATA_SOURCE_PASSWORD=<PASSWORD>                     # MongoDB password
DATA_SOURCE_DOMAIN=<DOMAIN>                         # MongoDB server domain
DATA_SOURCE_DB=<DATABASE>                           # Database name
DATA_PARAMS=<CONNECTION_PARAMS>                     # Additional connection parameters

# Redis Credentials
# Settings for connecting to Redis (used for caching)
CACHE_TYPE=<CACHE_TYPE>                             # Cache type (redis)
CACHE_HOST=<REDIS_HOST>                             # Redis host
CACHE_PORT=<REDIS_PORT>                             # Redis port
CACHE_DB=<REDIS_DB>                                 # Redis database ID (usually 0)
CACHE_USERNAME=<REDIS_USERNAME>                     # Redis username
CACHE_PASSWORD=<REDIS_PASSWORD>                     # Redis password
CACHE_TIMEOUT=<CACHE_TIMEOUT>                       # Timeout for cache operations (in ms)
CACHE_LETTUCE_POOL_MAX_ACTIVE=<MAX_ACTIVE>          # Max active connections in Redis pool
CACHE_LETTUCE_POOL_MAX_WAIT=<MAX_WAIT>              # Max wait time for Redis connections (in ms)
CACHE_LETTUCE_POOL_MAX_IDLE=<MAX_IDLE>              # Max idle connections in Redis pool
CACHE_LETTUCE_POOL_MIN_IDLE=<MIN_IDLE>              # Min idle connections in Redis pool

# Cache Configuration
# Settings for cache behavior
CACHE_TIME_TO_LIVE=<CACHE_TTL>                      # Time to live for cache items (in ms)
CACHE_NULL_VALUES=<BOOLEAN>                         # Whether to store null values in cache (true/false)

# Email Credentials
# Settings for sending emails via SMTP
MAIL_HOST=<SMTP_HOST>                               # SMTP server (e.g., Gmail)
MAIL_PORT=<SMTP_PORT>                               # SMTP port (587 for TLS)
MAIL_USERNAME=<SMTP_USERNAME>                       # SMTP login username
MAIL_PASSWORD=<SMTP_PASSWORD>                       # SMTP login password
MAIL_PROPERTIES_SMTP_AUTH=<TRUE/FALSE>              # Enable SMTP authentication (true/false)
MAIL_PROPERTIES_SMTP_STARTTLS_ENABLE=<TRUE/FALSE>   # Enable STARTTLS for secure connection

# JWT Credentials
# Settings for JWT (JSON Web Token) authentication
SECURITY_JWT_SECRET_KEY=<JWT_SECRET_KEY>            # Secret key for signing JWT tokens
SECURITY_JWT_EXPIRATION=<JWT_EXPIRATION>            # JWT expiration time (in ms)
SECURITY_PUBLIC_ROUTES=<PUBLIC_ROUTES>              # Public routes that do not require authentication (e.g., /auth/login)
SECURITY_AES_KEY=<AES_KEY>                          # AES encryption key for sensitive data
SECURITY_SCHEME_NAME=<NAME_SECURITY_SCHEMA>         # Name of the security scheme used in API documentation

# Rate Limiting Config
# Settings for API rate limiting
RATE_LIMITING_MAX_REQUESTS=<MAX_REQUESTS>           # Max requests per client IP within the defined time window
RATE_LIMITING_TIME_WINDOW=<TIME_WINDOW>             # Time window in milliseconds (1 minute)
RATE_LIMITING_PUBLIC_ROUTES=<PUBLIC_ROUTES>         # Public routes excluded from rate limiting

# HTTPS Headers (CORS)
# Settings for Cross-Origin Resource Sharing (CORS)
HEADER_CORS_ALLOWED_ORIGINS=<ALLOWED_ORIGINS>       # Allowed origins for CORS (e.g., http://localhost:3000)

# Server Configuration
# Settings for your Tomcat server
SERVER_TOMCAT_TIMEOUT=<TOMCAT_TIMEOUT>              # Timeout for Tomcat server (in ms)
# Settings for your Spring server
SERVER_FORWARD_HEADERS_STRATEGY=<STRATEGY>          # Forward headers strategy (framework or native)

# Swagger / OpenAPI Configuration
# Settings for your OpenAPI Docs
SWAGGER_API_DOCS_ENABLED=<TRUE/FALSE>               # Enable or disable API documentation generation
SWAGGER_API_DOCS_PATH=<API_DOCS_PATH>               # Path to serve OpenAPI JSON (default: /v3/api-docs)

#  Settings for your ReDoc UI
SWAGGER_REDOC_ENABLED=<TRUE/FALSE>                  # Enable or disable ReDoc UI
SWAGGER_REDOC_PATH=<REDOC_PATH>                     # Path to access ReDoc UI (e.g., /redoc)

# Settings for your Scalar UI
SCALAR_ENABLED=<TRUE/FALSE>                         # Enable or disable Scalar UI
SCALAR_PATH=<SCALAR_PATH>                           # Path to access Scalar UI (e.g., /scalar)

# Settings for your Swagger UI
SWAGGER_UI_ENABLED=<TRUE/FALSE>                     # Enable or disable Swagger UI
SWAGGER_UI_PATH=<SWAGGER_UI_PATH>                   # Swagger UI access path (e.g., /)
SWAGGER_UI_URL=<SWAGGER_UI_URL>                     # URL of the OpenAPI docs (default: /v3/api-docs)
SWAGGER_UI_DEFAULT_MODEL_EXPAND_DEPTH=<DEPTH>       # Model expand depth (e.g., 1)
SWAGGER_UI_DEFAULT_MODEL_RENDERING=<RENDERING>      # Rendering type: example/model
SWAGGER_UI_DISPLAY_OPERATION_ID=<TRUE/FALSE>        # Show operation IDs
SWAGGER_UI_DISPLAY_REQUEST_DURATION=<TRUE/FALSE>    # Show request duration
SWAGGER_UI_DOC_EXPANSION=<MODE>                     # Expansion mode: list/full/none

# OpenAPI Server URL
OPENAPI_SERVER_URL=<API_SERVER_URL>                 # URL of the API server (e.g., https://api.example.com)>

# Log Level Configuration
# Define the logging level (e.g., INFO, DEBUG, OFF)
DEBUGGER_MODE=<DEBUG_MODE>                          # Log level: INFO, DEBUG, or OFF