Docs: Create properties documentation. (#137)

prebid · Aug 1, 2024 · a80b125 · a80b125
1 parent 7edb620
commit a80b125
Showing 1 changed file with 28 additions and 3 deletions.
diff --git 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.