Skip to main content

Configuration

Server settings, for operators. Set them as Spring properties (application.yml, --name=value) or as environment variables: upper-case, with . and - turned into _, e.g. opendbapi.serving.slow-query-ms → OPENDBAPI_SERVING_SLOW_QUERY_MS. List values are comma-separated.

Database and keys​

Environment variableDefaultMeaning
OPENDBAPI_DB_URLjdbc:postgresql://localhost:55432/opendbapiOpenDBAPI's own PostgreSQL
OPENDBAPI_DB_USER / OPENDBAPI_DB_PASSWORDopendbapi_app / —App role, subject to row-level security
OPENDBAPI_DB_OWNER / OPENDBAPI_DB_OWNER_PASSWORDopendbapi_owner / —Owner role, runs the migrations
OPENDBAPI_MASTER_KEY—Base64 of 32 bytes; encrypts stored secrets
OPENDBAPI_BOOTSTRAP_ADMIN_PASSWORDrandom, printed oncePassword of the first system admin
OPENDBAPI_SECURE_COOKIEStrue in the imageSession cookies only over HTTPS
OPENDBAPI_TRACE_SAMPLING0.1Share of requests traced

The server listens on port 8520. Browser sessions last 8 hours.

opendbapi.*​

PropertyDefaultMeaning
auth.local-enabledtrueOffer local accounts on the sign-in page; system admins can always sign in locally
auth.lockout-attempts5Wrong local passwords in a row before the account locks
auth.lockout-duration15mHow long it stays locked
auth.post-login-redirect/Where the browser lands after SSO
serving.contextapiFirst path segment of every endpoint: /{context}/{workspace}/…
serving.url-basederived from the requestPublic base URL shown in endpoint URLs and API documents
serving.trusted-proxies—IPs or CIDR ranges of reverse proxies whose X-Forwarded-For is believed
serving.slow-query-ms1000Statements slower than this are logged (SQL only, no values)
serving.docs-uitrueServe /api/{workspace}/docs.html
datasources.extra-denied-hosts—Host names, *.suffix wildcards or CIDR ranges datasources may not reach, besides cloud metadata addresses
datasources.allowed-hosts—When set, the only hosts datasources may reach
access-log.retention-days30Days Activity keeps calls
alerts.allow-httpfalseAllow http:// webhook URLs
alerts.dedup-windowPT5MOne alert per endpoint and error code within this window
cache.max-bytes134217728 (128 MB)Memory for cached answers, per instance
publish.require-tests-passfalseRefuse to publish while an endpoint's tests fail
rate-limit.sharedfalse (true in the Helm chart)Count rate limits across instances in PostgreSQL
script.groovy-enabledtrueAllow Groovy script endpoints and nodes
script.timeout2sRun time of a fragment-mode script
script.full-timeout30sRun time of a full-mode script
tokens.ttlPT15MLifetime of client access tokens
ui.read-onlyfalseLock every workspace to configuration files
vault.*—See HashiCorp Vault

Actuator​

/actuator/health (with /liveness and /readiness) and /actuator/prometheus are exposed; nothing else is.