From cf1ca2dcba039ddbac2aded2b0069538fd6fb744 Mon Sep 17 00:00:00 2001 From: Adam Shamblin Date: Mon, 19 Sep 2022 20:41:54 -0600 Subject: [PATCH] WIP, work on doc structure --- doc/config/veilid-server-config.md | 54 ++++++++++++++++++++++++++---- 1 file changed, 48 insertions(+), 6 deletions(-) diff --git a/doc/config/veilid-server-config.md b/doc/config/veilid-server-config.md index 15e586e0..3aa78f55 100644 --- a/doc/config/veilid-server-config.md +++ b/doc/config/veilid-server-config.md @@ -12,23 +12,55 @@ status: Draft `veilid-server` may be run using configuration from both command-line arguments and the `veilid-server.conf` file. -### Global Directives +## Global Directives -| Directive | Description | -|---------------------------|---------------------------------------------------| -| [daemon](#daemon) | Run `veilid-server` in the background | -| [client_api](#client_api) || +| Directive | Description | +|-------------------------------|---------------------------------------------------| +| [daemon](#daemon) | Run `veilid-server` in the background | +| [client\_api](#client_api) || +| [auto\_attach](#auto_attach) || +| [logging](#logging) || +| [testing](#testing) || +| [core](#core) || -#### daemon +### daemon ```yaml daemon: enabled: false +``` + +### client_api + +```yaml client_api: enabled: true listen_address: 'localhost:5959' +``` + +| Parameter | Description | +|-------------------------------------|-------------| +| [enabled](#enabled) || +| [listen\_address](#listen_address) || + +#### enabled + +**TODO** + +#### listen\_address + +**TODO** + +### auto\_attach + +```yaml auto_attach: true +``` + +### logging + +```yaml logging: system: enabled: false @@ -48,8 +80,18 @@ logging: enabled: false level: 'trace' grpc_endpoint: 'localhost:4317' +``` + +### testing + +```yaml testing: subnode_index: 0 +``` + +### core + +```yaml core: protected_store: allow_insecure_fallback: true