]> Cypherpunks.ru repositories - govpn.git/blobdiff - doc/server.texi
Add time synchronization requirement option
[govpn.git] / doc / server.texi
index 0882ff2d3ea62315c7dc1a6475f3237ab38a872c..489402c0ed5e600e32e6040b6c7dbd869f23390a 100644 (file)
@@ -1,4 +1,9 @@
 @node Server
+@cindex Server
+@cindex Server part
+@cindex Server configuration
+@cindex Server side
+@cindex govpn-server
 @section Server part
 
 Except for common @code{-stats}, @code{-egd} options server has the
@@ -21,6 +26,9 @@ Start trivial HTTP @ref{Proxy} server on specified @emph{host:port}.
 
 @end table
 
+@cindex YAML
+@cindex YAML configuration
+@cindex Configuration file
 Configuration file is YAML file with following example structure:
 
 @verbatim
@@ -30,6 +38,7 @@ stargrave: {                        <-- Peer human readable name
     up: ./stargrave-up.sh           <-- OPTIONAL up-script
     down: ./stargrave-down.sh       <-- OPTIONAL down-script
     timeout: 60                     <-- OPTIONAL overriden timeout
+    timesync: 0                     <-- OPTIONAL time synchronization requirement
     noise: No                       <-- OPTIONAL noise enabler
     cpr: 64                         <-- OPTIONAL constant packet rate, KiB/sec
     encless: No                     <-- OPTIONAL Encryptionless mode
@@ -45,6 +54,8 @@ must output interface's name to stdout (first output line).
 For example up-script can be just @code{echo tap10}, or more advanced
 like the following one:
 
+@cindex up-script
+
 @example
 #!/bin/sh
 $tap=$(ifconfig tap create)