WIP, work on doc structure

This commit is contained in:
Adam Shamblin 2022-09-19 20:41:54 -06:00
parent 8fea21a20b
commit cf1ca2dcba
No known key found for this signature in database
GPG Key ID: 22E0BC8E6B4D8C8E

View File

@ -12,23 +12,55 @@ status: Draft
`veilid-server` may be run using configuration from both command-line arguments `veilid-server` may be run using configuration from both command-line arguments
and the `veilid-server.conf` file. and the `veilid-server.conf` file.
### Global Directives ## Global Directives
| Directive | Description | | Directive | Description |
|---------------------------|---------------------------------------------------| |-------------------------------|---------------------------------------------------|
| [daemon](#daemon) | Run `veilid-server` in the background | | [daemon](#daemon) | Run `veilid-server` in the background |
| [client_api](#client_api) || | [client\_api](#client_api) ||
| [auto\_attach](#auto_attach) ||
| [logging](#logging) ||
| [testing](#testing) ||
| [core](#core) ||
#### daemon ### daemon
```yaml ```yaml
daemon: daemon:
enabled: false enabled: false
```
### client_api
```yaml
client_api: client_api:
enabled: true enabled: true
listen_address: 'localhost:5959' listen_address: 'localhost:5959'
```
| Parameter | Description |
|-------------------------------------|-------------|
| [enabled](#enabled) ||
| [listen\_address](#listen_address) ||
#### enabled
**TODO**
#### listen\_address
**TODO**
### auto\_attach
```yaml
auto_attach: true auto_attach: true
```
### logging
```yaml
logging: logging:
system: system:
enabled: false enabled: false
@ -48,8 +80,18 @@ logging:
enabled: false enabled: false
level: 'trace' level: 'trace'
grpc_endpoint: 'localhost:4317' grpc_endpoint: 'localhost:4317'
```
### testing
```yaml
testing: testing:
subnode_index: 0 subnode_index: 0
```
### core
```yaml
core: core:
protected_store: protected_store:
allow_insecure_fallback: true allow_insecure_fallback: true