liz/veilid
liz/veilid
1
0
Fork 0
Code Pull Requests Packages Releases Activity

Continued additions to config doc format

Browse Source
This commit is contained in:
Adam Shamblin 2022-09-19 21:05:59 -06:00
parent cf1ca2dcba
commit f70303a47e
No known key found for this signature in database
GPG Key ID: 22E0BC8E6B4D8C8E
1 changed files with 221 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

329
doc/config/veilid-server-config.md
View File

@ -14,9 +14,9 @@ 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) || | [auto\_attach](#auto_attach) ||
| [logging](#logging) || | [logging](#logging) ||
@ -39,16 +39,16 @@ client_api:
listen_address: 'localhost:5959' listen_address: 'localhost:5959'
``` ```
| Parameter | Description | | Parameter | Description |
|-------------------------------------|-------------| |-----------------------------------------------|-------------|
| [enabled](#enabled) || | [enabled](#client_apienabled) ||
| [listen\_address](#listen_address) || | [listen\_address](#client_apilisten_address) ||
#### enabled #### client\_api:enabled
**TODO** **TODO**
#### listen\_address #### client\_api:listen\_address
**TODO** **TODO**
@ -82,6 +82,57 @@ logging:
grpc_endpoint: 'localhost:4317' grpc_endpoint: 'localhost:4317'
``` ```
| Parameter | Description |
|-------------------------------|-------------|
| [system](#loggingsystem) ||
| [terminal](#loggingterminal) ||
| [file](#loggingfile) ||
| [api](#loggingapi) ||
| [otlp](#loggingotlp) ||
#### logging:system
```yaml
system:
enabled: false
level: 'info'
```
#### logging:terminal
```yaml
terminal:
enabled: true
level: 'info'
```
#### logging:file
```yaml
file:
enabled: false
path: ''
append: true
level: 'info'
```
#### logging:api
```yaml
api:
enabled: true
level: 'info'
```
#### logging:otlp
```yaml
otlp:
enabled: false
level: 'trace'
grpc_endpoint: 'localhost:4317'
```
### testing ### testing
```yaml ```yaml
@ -91,104 +142,166 @@ testing:
### core ### core
| Parameter | Description |
|-------------------------------------------|-------------|
| [protected\_store](#coreprotected_store) ||
| [table\_store](#coretable_store) ||
| [block\_store](#block_store) ||
| [network](#corenetwork) ||
#### core:protected\_store
```yaml ```yaml
core: protected_store:
protected_store: allow_insecure_fallback: true
allow_insecure_fallback: true always_use_insecure_storage: true
always_use_insecure_storage: true insecure_fallback_directory: '%INSECURE_FALLBACK_DIRECTORY%'
insecure_fallback_directory: '%INSECURE_FALLBACK_DIRECTORY%' delete: false
delete: false ```
table_store:
directory: '%TABLE_STORE_DIRECTORY%' #### core:table\_store
delete: false
block_store: ```yaml
directory: '%BLOCK_STORE_DIRECTORY%' table_store:
delete: false directory: '%TABLE_STORE_DIRECTORY%'
network: delete: false
connection_initial_timeout_ms: 2000 ```
connection_inactivity_timeout_ms: 60000
max_connections_per_ip4: 32 #### core:block\_store
max_connections_per_ip6_prefix: 32
max_connections_per_ip6_prefix_size: 56 ```yaml
max_connection_frequency_per_min: 128 block_store:
client_whitelist_timeout_ms: 300000 directory: '%BLOCK_STORE_DIRECTORY%'
reverse_connection_receipt_time_ms: 5000 delete: false
hole_punch_receipt_time_ms: 5000 ```
node_id: ''
node_id_secret: '' #### core:network
bootstrap: ['bootstrap.dev.veilid.net']
bootstrap_nodes: [] ```yaml
routing_table: network:
limit_over_attached: 64 connection_initial_timeout_ms: 2000
limit_fully_attached: 32 connection_inactivity_timeout_ms: 60000
limit_attached_strong: 16 max_connections_per_ip4: 32
limit_attached_good: 8 max_connections_per_ip6_prefix: 32
limit_attached_weak: 4 max_connections_per_ip6_prefix_size: 56
rpc: max_connection_frequency_per_min: 128
concurrency: 0 client_whitelist_timeout_ms: 300000
queue_size: 1024 reverse_connection_receipt_time_ms: 5000
max_timestamp_behind_ms: 10000 hole_punch_receipt_time_ms: 5000
max_timestamp_ahead_ms: 10000 node_id: ''
timeout_ms: 10000 node_id_secret: ''
max_route_hop_count: 7 bootstrap: ['bootstrap.dev.veilid.net']
dht: bootstrap_nodes: []
resolve_node_timeout: upnp: true
resolve_node_count: 20 natpmp: false
resolve_node_fanout: 3 detect_address_changes: true
max_find_node_count: 20 enable_local_peer_scope: false
get_value_timeout: restricted_nat_retries: 0
get_value_count: 20 ```
get_value_fanout: 3
set_value_timeout: | Parameter | Description |
set_value_count: 20 |---------------------------------------------|-------------|
set_value_fanout: 5 | [routing\_table](#corenetworkrouting_table) ||
min_peer_count: 20 | [rpc](#corenetworkrpc) ||
min_peer_refresh_time_ms: 2000 | [dht](#corenetworkdht) ||
validate_dial_info_receipt_time_ms: 2000 | [tls](#corenetworktls) ||
upnp: true | [application](#corenetworkapplication) ||
natpmp: false | [protocol](#corenetworkprotocol) ||
detect_address_changes: true
enable_local_peer_scope: false #### core:network:routing\_table
restricted_nat_retries: 0
tls: ```yaml
certificate_path: '%CERTIFICATE_PATH%' routing_table:
private_key_path: '%PRIVATE_KEY_PATH%' limit_over_attached: 64
connection_initial_timeout_ms: 2000 limit_fully_attached: 32
application: limit_attached_strong: 16
https: limit_attached_good: 8
enabled: false limit_attached_weak: 4
listen_address: ':5150' ```
path: 'app'
# url: 'https://localhost:5150' #### core:network:rpc
http:
enabled: false ```yaml
listen_address: ':5150' rpc:
path: 'app' concurrency: 0
# url: 'http://localhost:5150' queue_size: 1024
protocol: max_timestamp_behind_ms: 10000
udp: max_timestamp_ahead_ms: 10000
enabled: true timeout_ms: 10000
socket_pool_size: 0 max_route_hop_count: 7
listen_address: ':5150' ```
# public_address: ''
tcp: #### core:network:dht
connect: true
listen: true ```yaml
max_connections: 32 dht:
listen_address: ':5150' resolve_node_timeout:
#'public_address: '' resolve_node_count: 20
ws: resolve_node_fanout: 3
connect: true max_find_node_count: 20
listen: true get_value_timeout:
max_connections: 16 get_value_count: 20
listen_address: ':5150' get_value_fanout: 3
path: 'ws' set_value_timeout:
# url: 'ws://localhost:5150/ws' set_value_count: 20
wss: set_value_fanout: 5
connect: true min_peer_count: 20
listen: false min_peer_refresh_time_ms: 2000
max_connections: 16 validate_dial_info_receipt_time_ms: 2000
listen_address: ':5150' ```
path: 'ws'
# url: '' #### core:network:tls
```yaml
tls:
certificate_path: '%CERTIFICATE_PATH%'
private_key_path: '%PRIVATE_KEY_PATH%'
connection_initial_timeout_ms: 2000
```
#### core:network:application
```yaml
application:
https:
enabled: false
listen_address: ':5150'
path: 'app'
# url: 'https://localhost:5150'
http:
enabled: false
listen_address: ':5150'
path: 'app'
# url: 'http://localhost:5150'
```
#### core:network:protocol
```yaml
protocol:
udp:
enabled: true
socket_pool_size: 0
listen_address: ':5150'
# public_address: ''
tcp:
connect: true
listen: true
max_connections: 32
listen_address: ':5150'
#'public_address: ''
ws:
connect: true
listen: true
max_connections: 16
listen_address: ':5150'
path: 'ws'
# url: 'ws://localhost:5150/ws'
wss:
connect: true
listen: false
max_connections: 16
listen_address: ':5150'
path: 'ws'
# url: ''
``` ```