Skip to content

Environment Variables

Reference for all environment variables used across In Falcone services.

Bootstrap

VariableServiceDescription
KEYCLOAK_ADMIN_USERBootstrapKeycloak admin username
KEYCLOAK_ADMIN_PASSWORDBootstrapKeycloak admin password
APISIX_ADMIN_KEYBootstrapAPISIX admin API key

Control Plane

VariableDefaultDescription
NODE_ENVproductionNode.js environment
PORT8080HTTP listen port
LOG_LEVELinfoLog level (debug, info, warn, error)
DEPLOYMENT_PROFILEstandardDeployment profile name
DATABASE_URLPostgreSQL connection string
MONGODB_URLMongoDB connection string
KAFKA_BROKERSComma-separated Kafka broker addresses
KEYCLOAK_URLKeycloak base URL
KEYCLOAK_REALMin-falcone-platformPlatform realm name
OPENWHISK_API_HOSTOpenWhisk API endpoint
MINIO_ENDPOINTMinIO S3 endpoint
MINIO_ACCESS_KEYMinIO access key
MINIO_SECRET_KEYMinIO secret key

Web Console

VariableDefaultDescription
NODE_ENVproductionEnvironment
PUBLIC_BASE_PATH/Base path for the SPA
VITE_CONSOLE_AUTH_REALMin-falcone-platformKeycloak realm
VITE_CONSOLE_AUTH_CLIENT_IDin-falcone-consoleOAuth 2.0 client ID
VITE_CONSOLE_AUTH_LOGIN_PATH/loginLogin route
VITE_CONSOLE_AUTH_SIGNUP_PATH/signupSignup route
VITE_CONSOLE_AUTH_TITLEAccede a In Falcone ConsoleLogin page title
VITE_CONSOLE_SIGNUP_TITLECrea tu acceso a In Falcone ConsoleSignup page title

Provisioning Orchestrator

VariableDefaultDescription
PO_DATABASE_URLPostgreSQL connection for orchestrator
PO_KEYCLOAK_URLKeycloak admin API URL
PO_OPENWHISK_URLOpenWhisk API URL
PO_MONGODB_URLMongoDB admin connection
PO_KAFKA_BROKERSKafka broker addresses
PO_S3_ENDPOINTS3/MinIO endpoint
PO_VAULT_ADDRVault API address

Realtime Gateway

VariableDefaultDescription
RG_PORT8080WebSocket listen port
RG_KEYCLOAK_JWKS_URLJWKS endpoint for JWT validation
RG_KEYCLOAK_INTROSPECTION_URLToken introspection URL
RG_KAFKA_BROKERSKafka broker addresses
RG_KAFKA_GROUP_IDrealtime-gatewayKafka consumer group
RG_MAX_SUBSCRIPTIONS100Max subscriptions per connection

Event Gateway

VariableDefaultDescription
EG_PORT8080HTTP listen port
EG_KAFKA_BROKERSKafka broker addresses
EG_KAFKA_CLIENT_IDevent-gatewayKafka producer client ID

PostgreSQL CDC Bridge

VariableDefaultDescription
DATABASE_URLPostgreSQL connection (with replication)
PG_CDC_KAFKA_BROKERSKafka broker addresses
PG_CDC_KAFKA_TOPICconsole.pg-capture.lifecycleOutput Kafka topic
PG_CDC_CACHE_TTL_SECONDS30CDC event cache TTL
WAL_KEEP_THRESHOLD_MB512WAL retention threshold
MAX_EVENTS_PER_SECOND1000Rate limit for CDC events

Backup Status

VariableDefaultDescription
BS_DATABASE_URLPostgreSQL connection
BS_KAFKA_BROKERSKafka broker addresses
BS_MFA_ENABLEDtrueMFA required for restore confirmations
BS_OPERATIONAL_HOURS_START09:00Start of operational window
BS_OPERATIONAL_HOURS_END18:00End of operational window

Vault

VariableDefaultDescription
VAULT_ADDRVault API address
VAULT_NAMESPACEadminVault namespace
VAULT_TOKENVault authentication token
VAULT_CACERTPath to Vault CA certificate

Infrastructure

PostgreSQL

VariableDefaultDescription
POSTGRES_USERpostgresSuperuser username
POSTGRES_PASSWORDSuperuser password
POSTGRES_DBfalconeDefault database
PGDATA/bitnami/postgresql/dataData directory

MongoDB

VariableDefaultDescription
MONGODB_ROOT_USERrootRoot username
MONGODB_ROOT_PASSWORDRoot password

Kafka

VariableDefaultDescription
KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLEfalseAuto topic creation
KAFKA_CFG_LISTENERSPLAINTEXT://:9092Listener configuration
KAFKA_CFG_NUM_PARTITIONS3Default partition count

MinIO

VariableDefaultDescription
MINIO_ROOT_USERRoot access key
MINIO_ROOT_PASSWORDRoot secret key
MINIO_BROWSER_REDIRECT_URLConsole redirect URL

Released under the MIT License.