General
General settings
Aidbox name
Aidbox instance unique ID. Can be used to separate telemetry data (logs, metrics, traces) in observability systems for multiple deployments.
ID
box-id
Type
String
Default value
devbox
Environment variable
BOX_ID
Deprecated environment variables
AIDBOX_BOX_ID
Sensitive
false
— value will be visible in plaintext in Admin UI
Set via
Environment variables
Hot reload
false
— setting requires system restart
Instance name
Provided instance name will be attached to metric labels. It is required for monitoring multiple Aidbox instances.
ID
instance-name
Type
String
Default value
(no default)
Environment variable
BOX_INSTANCE_NAME
Sensitive
false
— value will be visible in plaintext in Admin UI
Set via
Admin UI → Settings Environment variables
Hot reload
true
— setting can be changed at runtime
Root FHIR package
Identifier for the main Aidbox FHIR package that stores dependencies and canonical resources provided by the user.
ID
root-fhir-package
Type
String
Default value
app.aidbox.main#0.0.1
Environment variable
BOX_ROOT_FHIR_PACKAGE
Deprecated environment variables
AIDBOX_AR_PACKAGE
Sensitive
false
— value will be visible in plaintext in Admin UI
Set via
Admin UI → Settings Environment variables
Hot reload
false
— setting requires system restart
Bootstrap FHIR package list
During the first startup Aidbox loads these packages. This setting has no effect on any consecutive starts.
Format:<name1>#<version1>:<name2>#<version2>...
ID
bootstrap-fhir-packages
Type
String
Default value
(no default)
Environment variable
BOX_BOOTSTRAP_FHIR_PACKAGES
Deprecated environment variables
AIDBOX_FHIR_PACKAGES
Sensitive
false
— value will be visible in plaintext in Admin UI
Set via
Admin UI → Settings Environment variables
Hot reload
false
— setting requires system restart
Init bundle
URL of the Bundle resource in JSON format executed on Aidbox startup. Not available to edit because if file is not reachable, Aidbox will not start.
ID
init-bundle
Type
String
Default value
(no default)
Environment variable
BOX_INIT_BUNDLE
Sensitive
false
— value will be visible in plaintext in Admin UI
Set via
Environment variables
Hot reload
false
— setting requires system restart
Share usage statistics with Aidbox developers
Allows Aidbox to collect and send high-level API usage statistics to help improve the product.
ID
usage-stats
Type
Bool
Default value
true
Environment variable
BOX_USAGE_STATS
Deprecated environment variables
BOX_TELEMETRY_USAGE_STATS
Sensitive
false
— value will be visible in plaintext in Admin UI
Set via
Admin UI → Settings Environment variables
Hot reload
true
— setting can be changed at runtime
Settings mode
Settings mode defines the source of settings values and possibility to change them at runtime.
ID
settings-mode
Type
Enum
Values
legacy
— Reads configuration values from the legacy Aidbox configuration project (zen) in read-only mode. This mode exists for backward compatibility. It will be obsolete in July 2025. <a href='https://www.health-samurai.io/news/aidbox-transitions-to-the-fhir-schema-engine'>Read more</a>
read-only
— Reads settings values from environment variables and Aidbox settings in read-only mode. Loading configuration from the Aidbox configuration project (Zen) is disabled.
read-write
— Enables editing Aidbox settings using the UI. Loading configuration from the Aidbox configuration project (Zen) is disabled.
Default value
legacy
Environment variable
BOX_SETTINGS_MODE
Available from
2502
Sensitive
false
— value will be visible in plaintext in Admin UI
Set via
Environment variables
Hot reload
false
— setting requires system restart
Enable export settings endpoint
Allow user to request current Aidbox settings as a set of environment variables on /api/v1/settings/export
.
Be aware, that endpoint may expose your sensitive settings.
ID
export-settings-endpoint
Type
Bool
Default value
(no default)
Environment variable
BOX_EXPORT_SETTINGS_ENDPOINT
Sensitive
false
— value will be visible in plaintext in Admin UI
Set via
Environment variables
Hot reload
false
— setting requires system restart
Enable cache replication
Aidbox automatically syncs runtime cache (SearchParameters, FHIR Schemas, OperationDefinitions, etc) across multiple instances for high availability. If you configure everything at startup and don't modify metadata at runtime, you can disable cache replication to improve performance.
ID
cache-replication-disable
Type
Bool
Default value
(no default)
Environment variable
BOX_CACHE_REPLICATION_DISABLE
Sensitive
false
— value will be visible in plaintext in Admin UI
Set via
Admin UI → Settings Environment variables
Hot reload
false
— setting requires system restart
Last updated
Was this helpful?