Skip to content

Commit e13a234

Browse files
committed
Add doc for server's confs
- Resolve #141
1 parent 62c0a2d commit e13a234

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

keyserver/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ Use "coniksserver [command] --help" for more information about a command.
3636
is for the registration proxy, the second is the server's public address
3737
for "read-only" requests (lookups, monitoring etc).
3838
- Edit the configuration file as needed:
39-
- Replace the `epoch_deadline` with the desired duration in seconds.
39+
- Replace the `loaded_history_length` with the desired number of snapshots kept in memory.
40+
- Replace the `epoch_deadline` with the desired duration in **seconds**.
4041
- If using a CONIKS registration proxy, replace the registration proxy `address`. Otherwise, remove the registration proxy `addresses` entry, and add `allow_registration = true` field to the public `addresses` entry.
4142
- In either case, replace the public `address` with the server's public CONIKS address.
4243
- Test setup (no registration proxy) config file example:

keyserver/server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ type Address struct {
6565

6666
// ServerPolicies contains a server's CONIKS policies configuration
6767
// including paths to the VRF private key, the signing private
68-
// key and the epoch deadline value.
68+
// key and the epoch deadline value in seconds.
6969
type ServerPolicies struct {
7070
EpochDeadline protocol.Timestamp `toml:"epoch_deadline"`
7171
VRFKeyPath string `toml:"vrf_key_path"`

0 commit comments

Comments
 (0)