Skip to main content

Environment Variables

WIXY Hub follows 12-Factor App principles. Every configuration property can be overridden via environment variables.

Complete Reference

Environment VariableMaps ToDefaultDescription
SERVER_PORTserver.port8080Hub HTTP port (UI/API)
WIXY_REGISTRY_FILE_PATHwixy.registry.file-path~/.wixy/servers.jsonPath to persistent registry file
WIXY_UI_ENABLEDwixy.ui.enabledtrueToggle management dashboard
WIXY_WIREMOCK_PORTwixy.wiremock.port9090Embedded engine port
WIXY_WIREMOCK_VERBOSEwixy.wiremock.verbosetrueVerbose WireMock logging
WIXY_WIREMOCK_ROOT_DIRwixy.wiremock.root-dirclasspath:/wiremockWireMock mappings directory
WIXY_PROXY_ENABLEDwixy.proxy.enabledfalseEnable proxy forwarding
WIXY_PROXY_TARGET_URLwixy.proxy.target-url(empty)Upstream URL for proxy/recording
WIXY_PROXY_RECORDwixy.proxy.recordfalseEnable auto-recording on startup
WIXY_SECURITY_ENABLEDwixy.security.enabledfalseEnable API-key authentication
WIXY_SECURITY_API_KEYwixy.security.api-key(empty)Required API-key value
SPRING_PROFILES_ACTIVEspring.profiles.active(none)Active Spring profile(s)

Usage Examples

Custom Registry Path

docker run -d \
-p 8080:8080 \
-e WIXY_REGISTRY_FILE_PATH=/data/servers.json \
wixy:latest

Headless Hub (API Only)

java -jar wixy.jar --wixy.ui.enabled=false

Naming Convention

Spring Boot converts environment variables to properties using relaxed binding:

Environment VariableProperty
WIXY_REGISTRY_FILE_PATHwixy.registry.file-path
WIXY_UI_ENABLEDwixy.ui.enabled

Rule: Replace dots with underscores and use UPPER_CASE.