summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStuart Stock <stuart@int08h.com>2018-09-29 23:48:01 -0500
committerStuart Stock <stuart@int08h.com>2018-09-29 23:48:01 -0500
commit146ed83d361ffd44d09e3879dde809150bb07a7a (patch)
treec5d4defd34d1f58feb36a9b5fa5b55e490683749 /README.md
parent606b144dc40ed418253d26bb56bcbe9469d04cf1 (diff)
downloadroughenough-146ed83d361ffd44d09e3879dde809150bb07a7a.zip
Major refeactoring for better code structure
* Extract distinct types for online and long-term keys * Extract and create separate configuration trait and implementation(s) * Clean-ups, renames, tidying
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index 8bf6c34..fc8f83e 100644
--- a/README.md
+++ b/README.md
@@ -90,19 +90,20 @@ The server is configured via a YAML file:
interface: 127.0.0.1
port: 8686
seed: f61075c988feb9cb700a4a6a3291bfbc9cab11b9c9eca8c802468eb38a43d7d3
-batch_size: 64
```
Where:
-* **`interface`** - IP address or interface name for listening to client requests
-* **`port`** - UDP port to listen for requests
-* **`seed`** - A 32-byte hexadecimal value used to generate the server's long-term
+* **`interface`** - [Mandatory] IP address or interface name for listening to client requests
+* **`port`** - [Mandatory] UDP port to listen for requests
+* **`seed`** - [Mandatory] A 32-byte hexadecimal value used to generate the server's long-term
key pair. **This is a secret value and must be un-guessable**,
treat it with care.
-* **`batch_size`** - The number of requests to process in one batch. All nonces
+* **`batch_size`** - [Optional] The maximum number of requests to process in one batch. All nonces
in a batch are used to build a Merkle tree, the root of which
- is signed.
+ is signed. Default is 64 requests per batch.
+* **`status_interval`** - [Optional] Number of _seconds_ between each logged status update.
+ Default is 600 seconds (10 minutes).
### Stopping the Server