From 4a096ca23631e6975d8614f06d00075a2810232f Mon Sep 17 00:00:00 2001 From: Daniel Mader Date: Thu, 29 Aug 2024 22:02:34 +0200 Subject: [PATCH] docs: config options for DID document cache --- agent_application/CONFIGURATION.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/agent_application/CONFIGURATION.md b/agent_application/CONFIGURATION.md index 27fc2893..473f2a51 100644 --- a/agent_application/CONFIGURATION.md +++ b/agent_application/CONFIGURATION.md @@ -12,18 +12,21 @@ All environment variables need to be prefixed with `UNICORE__` to prevent confli ## 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://:@/` | -| `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 | +| 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://:@/` | +| `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. | - | - |