From a80b125ed0281c95ac4ffe077370c66f612b919e Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Thu, 1 Aug 2024 13:35:55 +0300 Subject: [PATCH] Docs: Create properties documentation. (#137) --- docs/config.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/docs/config.md b/docs/config.md index 5d99b81..5efbebd 100644 --- a/docs/config.md +++ b/docs/config.md @@ -9,8 +9,33 @@ The next sections describes how to set up project configuration. ## Application properties -### Server -- `cache.allowed_proxy_host` - set the allowed proxy host for request with `ch` parameter. +### API +- `api.path` - (Deprecated) set path for cache endpoint. +- `api.cache_path` - set path for cache endpoint. +- `api.module_storage_path` - set path for storage endpoint. +- `api.api_key` - set API key. +#### Cors +- `cors.enabled` - toggle for cors. +- `cors.mapping` - set path pattern for cors. +- `cors.allowed_origin_patterns` - set allowed origin patterns. +- `cors.allowed_methods` - set allowed methods. +- `cors.allow_credentials` - sets `Access-Control-Allow-Credentials` response header value (`true` or `false`). -[//]: # (TODO: Add all server config proprties) +### Cache +- `cache.prefix` - set prefix for all saved cache entries. +- `cache.expiry_sec` - set default expiration time (in seconds) for cache entries. +- `cache.min_expiry` - set minimum expiration time (in seconds) for cache entries. +- `cache.max_expiry` - set maximum expiration time (in seconds) for cache entries. +- `cache.timeout_ms` - set timeout for persistence provider. +- `cache.allow_external_UUID` - toggle for accepting externally provided UUID. If set to `false`, error will be returned on external UUID. When set to `true` externally provided UUID will be accepted. +- `cache.secondary_uris` - uris of secondary caches. +- `cache.secondary_cache_path` - path of secondary cache. +- `cache.clients_cache_duration` - expiration time (in seconds) for internal web clients cache. +- `cache.clients_cache_size` - maximum amount of cached web clients. +- `cache.allowed_proxy_host` - set the allowed proxy host for request with `ch` parameter. +- `cache.host_param_protocol` - set protocol for secondary cache requests. +- `circuitbreaker.failure_rate_threshold` - failure rate threshold for circuit breaker. +- `circuitbreaker.open_state_duration` - duration (in millis) of circuit breaker sitting in open state. +- `circuitbreaker.closed_state_calls_number` - size of circuit breaker sliding window. +- `circuitbreaker.half_open_state_calls_number` - number of calls in half open state.