X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=doc%2Fserver.texi;fp=doc%2Fserver.texi;h=0882ff2d3ea62315c7dc1a6475f3237ab38a872c;hb=a5872551bfa75d7efde5a186c7ff2de2e3bb8449;hp=2668b1da962e543b09dddba3e37a16d0ed233a35;hpb=867a8de03177abf0a5d678e6ce5cf0d0963ca207;p=govpn.git diff --git a/doc/server.texi b/doc/server.texi index 2668b1d..0882ff2 100644 --- a/doc/server.texi +++ b/doc/server.texi @@ -14,32 +14,27 @@ following ones: Address (@code{host:port} format) we must bind to. @item -conf -Path to JSON file with the configuration. +Path to YAML file with the configuration. @item -proxy Start trivial HTTP @ref{Proxy} server on specified @emph{host:port}. @end table -Configuration file is JSON file with following example structure: +Configuration file is YAML file with following example structure: @verbatim -{ - "stargrave": { <-- Peer human readable name - "iface": "tap10", <-- OPTIONAL TAP interface name - "mtu": 1514, <-- OPTIONAL overriden MTU - "up": "./stargrave-up.sh", <-- OPTIONAL up-script - "down": "./stargrave-down.sh", <-- OPTIONAL down-script - "timeout": 60, <-- OPTIONAL overriden timeout - "noise": true, <-- OPTIONAL noise enabler - (default: false) - "cpr": 64, <-- OPTIONAL constant packet - rate in KiB/sec - "encless": false, <-- OPTIONAL Encryptionless mode - "verifier": "$argon2d..." <-- verifier received from client - }, - [...] -} +stargrave: { <-- Peer human readable name + iface: tap10 <-- OPTIONAL TAP interface name + mtu: 1514 <-- OPTIONAL overriden MTU + up: ./stargrave-up.sh <-- OPTIONAL up-script + down: ./stargrave-down.sh <-- OPTIONAL down-script + timeout: 60 <-- OPTIONAL overriden timeout + noise: No <-- OPTIONAL noise enabler + cpr: 64 <-- OPTIONAL constant packet rate, KiB/sec + encless: No <-- OPTIONAL Encryptionless mode + verifier: $argon2d... <-- verifier received from client +[...] @end verbatim At least one of either @code{iface} or @code{up} must be specified. If @@ -68,12 +63,23 @@ creation: [...] Your client verifier is: $argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg -Place the following JSON configuration entry on the server's side: +Place the following YAML configuration entry on the server's side: - "Alice": { - "up": "/path/to/up.sh", - "iface": "or TAP interface name", - "verifier": "$argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10" - } -[...] + Alice: + up: /path/to/up.sh + iface: or TAP interface name + verifier: $argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10 +@end verbatim + +Example configuration file: +@verbatim +stargrave: + iface: tap0 + verifier: $argon2d$m=4096,t=128,p=1$VMirzcshcHuG2V4jhUsEjw$X5fC07L8k61h3S1Oro/rC76+m0oGDTA9Bq+aWJ1uOgY +slow: + iface: tap1 + encless: Yes + mtu: 9000 + cpr: 384 + verifier: $argon2d$m=4096,t=128,p=1$YbIA5garDqCOhtI/2EZVNg$gOo5vcEGynmpeepNscwclicfZsWxzgYFRLbgG21EZ1U @end verbatim