summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAaron Hill <aa1ronham@gmail.com>2018-03-11 16:23:10 -0400
committerAaron Hill <aa1ronham@gmail.com>2018-03-11 16:23:10 -0400
commitee38933f7c60ef7abe714722d565435819f9aaf7 (patch)
tree1810634da538645aeac4488af5b0d453d5e918d9 /README.md
parent3471e04b9b28ded3d12ef31a2477a06ec71ae97e (diff)
downloadroughenough-ee38933f7c60ef7abe714722d565435819f9aaf7.zip
Update documentation for new batch_size option
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 949d4a5..56fa8ba 100644
--- a/README.md
+++ b/README.md
@@ -64,6 +64,7 @@ The server is configured via a YAML file:
interface: 127.0.0.1
port: 8686
seed: f61075c988feb9cb700a4a6a3291bfbc9cab11b9c9eca8c802468eb38a43d7d3
+batch_size: 64
```
Where:
@@ -73,6 +74,10 @@ Where:
* **`seed`** - 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
+ in a batch are used to build a Merkle tree, the root of which
+ is signed.
+
### Stopping the Server
@@ -83,8 +88,6 @@ Use Ctrl-C or `kill` the process.
Roughtime features not implemented by the server:
* On-line key rotation. The server must be restarted to generate a new delegated key.
-* Multi-request Merkle Tree batching. For now each request gets its own response
- with `PATH` empty and `INDX` zero.
* The Rougheough server depends on the host's time source to comply with the smeared leap-second
requirement of the Roughtime protocol. A Roughenough server sourcing time from
[Google's public NTP servers](https://developers.google.com/time/) would produce compliant