make success_report_interval configuraable

[hippotat.git] / README.config

diff --git a/README.config b/README.config
index 4afc45ae1960747111c661eec29b35d6cf5d3030..aa493bb7a41db77108259cb2c167bb03a00cf661 100644 (file)
--- a/README.config
+++ b/README.config
@@ -70,11 +70,14 @@ Exceptional settings:
   ipif
      Command to run to create and communicate with local network
      interface.  Passed to sh -c.  Must speak SLIP on stdin/stdout.
-     The following additional interpolations aare substituted:
-                       %(local)s  %(peer)s  %(rnet)s    %(ifname)s
+     The following interpolations aare substituted:
+                       %{local}   %{peer}   %{rnets}    %{ifname}
           on server    <vaddr>    <vrelay>  <vnetwork>  <ifname_server>
           on client    <client>   <vaddr>   <vroutes>   <ifname_client>
-     ["userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s"]
+     Plus %{mtu} and %% to indicate a literal %.
+     (For compatibility with older hippotat, %(var)s is supported too
+     but this is deprecated since the extra `s` is confusing.)
+     ["userv root ipif %{local},%{peer},%{mtu},slip '%{rnets}'"]
 
      On server: applies to all clients; not looked up in
       client-specific sections.
@@ -86,7 +89,11 @@ Capped settings:
      those from the other sections (including COMMON).
 
   max_batch_down
-     Size limit for response payloads (used by server only)
+     Size limit for response payloads.
+     On client, incoming response bodies are limited to this plus
+     a fixed constant metadata overhead of 10000 bytes.
+     Server uses minim of client and server value (old servers
+     just uses server's value).
      [65536 bytes; LIMIT: 262144 bytes]
 
   max_queue_time
@@ -103,8 +110,10 @@ Capped settings:
       for this long
      On client: give up on any http request outstanding for
       for this long plus http_timeout_grace
+     Warning messages about link problems, printed by the client,
+     are rate limited to no more than one per effective timeout.
      Client's effective timeout must be at least server's (checked).
-     [30 s; LIMIT: 121]
+     [30 s; LIMIT: 121s]
 
   target_requests_outstanding   
      On server: whenever number of outstanding requests for
@@ -130,6 +139,7 @@ Ordinary settings, used by both, not client-specific:
 
   vaddr
      Address of server's virtual interface.
+     [first host entry in <vnetwork>, so 172.24.230.193]
 
   vrelay
      Virtual point-to-point address used for tunnel routing
@@ -143,7 +153,8 @@ Ordinary settings, used by both, not client-specific:
      On client: used only to construct default url.
 
   mtu
-     Must match exactly.  (UNCHECKED) [1500 bytes]
+     Of virtual interface.  Must match exactly at each end.
+     (UNCHECKED) [1500 bytes]
 
   ifname_server
      Virtual interface name on the server.  [shippo%d]
@@ -173,6 +184,10 @@ Ordinary settings, used by client only:
   max_batch_up
      Size limit for request payloads. [4000 bytes]
 
+  success_report_interval
+     If nonzero, report success periodically.  Otherwise just
+     report it when we first have success.  [3600 s]
+
   http_retry
      If a request fails, wait this long before considering it
      "finished" - to limit rate of futile requests.  [5 s]