Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 5.23 KB

CONFIGURATION.md

File metadata and controls

52 lines (41 loc) · 5.23 KB
Raw

Configuration

A configuration file is used to configure UniCore. It is expected to be present in agent_application/config.yaml. An example can be found in example-config.yaml. Values can also be set through the environment, preferably used to inject sensitive values or environment-specific values.

:::info Environment variables override values specified in the configuration file. :::

:::note All environment variables need to be prefixed with UNICORE__ to prevent conflicts with other unrelated variables. :::

General

Name Description Default value Accepted values
UNICORE__LOG_FORMAT The format of the log output. json json, text
UNICORE__EVENT_STORE__TYPE The type of event store to use. - in_memory, postgres
UNICORE__EVENT_STORE__CONNECTION_STRING The connection string for the event store database. - postgresql://<user>:<pass>@<host>/<db>
UNICORE__URL The base URL UniCore runs on. - https://my-domain.example.org
UNICORE__BASE_PATH A base path can be set if needed. - string
UNICORE__CORS_ENABLED Enable CORS (permissive). Only required for browser-based access. false boolean
UNICORE__DID_METHODS__DID_WEB__ENABLED Create and host a did:web DID document. false boolean
UNICORE__SIGNING_ALGORITHMS_SUPPORTED__EDDSA__ENABLED Toggles the algorithm allowed for cryptographic operations. true boolean
UNICORE__DOMAIN_LINKAGE_ENABLED Enable domain linkage (only works with did:web). - boolean
UNICORE__EXTERNAL_SERVER_RESPONSE_TIMEOUT_MS The timeout for external server responses (in milliseconds). 1000 integer
UNICORE__DID_DOCUMENT_CACHE__ENABLED Enables a simple in-memory cache for DID documents. false boolean
UNICORE__DID_DOCUMENT_CACHE__TTL Sets the expiry for cache entries in milliseconds. 5000 integer
UNICORE__DID_DOCUMENT_CACHE__INCLUDE An optional list of DIDs to include in the cache. If not specified, all DIDs will be cached. - -

Secret Management

Name Description Default value Accepted values
UNICORE__SECRET_MANAGER__STRONGHOLD_PATH The path to the stronghold file. - /var/lib/unicore/stronghold
UNICORE__SECRET_MANAGER__STRONGHOLD_PASSWORD The password to unlock the stronghold. - -
UNICORE__SECRET_MANAGER__ISSUER_EDDSA_KEY_ID The key ID of the EDDSA (Ed25519) key to be used. - -
UNICORE__SECRET_MANAGER__ISSUER_ES256_KEY_ID The key ID of the ES256 key to be used. - -
UNICORE__SECRET_MANAGER__ISSUER_DID The DID of the issuer. - -
UNICORE__SECRET_MANAGER__ISSUER_FRAGMENT The fragment to be used. - -

Look and Feel

:::info Setting display values is currently not supported through environment variables. Please refer to config.yaml. :::