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.

Instance name

Provided instance name will be attached to metric labels. It is required for monitoring multiple Aidbox instances.

Root FHIR package

Identifier for the main Aidbox FHIR package that stores dependencies and canonical resources provided by the user.

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>...

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.

Share usage statistics with Aidbox developers

Allows Aidbox to collect and send high-level API usage statistics to help improve the product.

Settings mode

Settings mode defines the source of settings values and possibility to change them at runtime.

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.

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.

Aidbox modules load list

During startup Aidbox loads these modules. Format: <module-name2>,<module-name2>,<module-name3>...

Aidbox module jar

Path to an Aidbox module jar files separated by ":" Format: <path1>:<path2>:<path3>...