4 Except for common @ref{Stats, -stats}, @ref{EGD, -egd} options client
5 has the following ones:
10 @ref{Network, Network protocol} to use. Can be @emph{udp} (default),
11 @emph{tcp} or @emph{all}.
14 Address (@code{host:port} format) we must bind to.
17 Path to YAML file with the configuration.
20 Start trivial HTTP @ref{Proxy} server on specified @emph{host:port}.
24 Configuration file is YAML file with following example structure:
27 stargrave: { <-- Peer human readable name
28 iface: tap10 <-- OPTIONAL TAP interface name
29 mtu: 1514 <-- OPTIONAL overriden MTU
30 up: ./stargrave-up.sh <-- OPTIONAL up-script
31 down: ./stargrave-down.sh <-- OPTIONAL down-script
32 timeout: 60 <-- OPTIONAL overriden timeout
33 timesync: 0 <-- OPTIONAL time synchronization requirement
34 noise: No <-- OPTIONAL noise enabler
35 cpr: 64 <-- OPTIONAL constant packet rate, KiB/sec
36 encless: No <-- OPTIONAL Encryptionless mode
37 verifier: $argon2d... <-- verifier received from client
41 At least one of either @code{iface} or @code{up} must be specified. If
42 you specify @code{iface}, then it will be forcefully used to determine
43 what TAP interface will be used. If it is not specified, then up-script
44 must output interface's name to stdout (first output line).
46 For example up-script can be just @code{echo tap10}, or more advanced
47 like the following one:
52 $tap=$(ifconfig tap create)
53 ifconfig $tap inet6 fc00::1/96 mtu 1412 up
57 Each minute server rereads and refreshes peers configuration and adds
58 newly appeared identities, deletes an obsolete ones.
60 You can use convenient @command{utils/newclient.sh} script for new client
64 % ./utils/newclient.sh Alice
66 Your client verifier is: $argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg
68 Place the following YAML configuration entry on the server's side:
72 iface: or TAP interface name
73 verifier: $argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10
76 Example configuration file:
80 verifier: $argon2d$m=4096,t=128,p=1$VMirzcshcHuG2V4jhUsEjw$X5fC07L8k61h3S1Oro/rC76+m0oGDTA9Bq+aWJ1uOgY
86 verifier: $argon2d$m=4096,t=128,p=1$YbIA5garDqCOhtI/2EZVNg$gOo5vcEGynmpeepNscwclicfZsWxzgYFRLbgG21EZ1U