chiark / gitweb /
config: Drop mention of DEFAULT
[hippotat.git] / README.config
index cc921c1ceef71ce188b834957eaafc62f715128f..122526257d250d01529860b8b6d47d93ea8e9e06 100644 (file)
@@ -10,7 +10,7 @@ Sections
 Keys are looked up in that order, unless otherwise specified.
 <client> is the client's virtual address.
 <servername> must be a valid lowercase DNS hostname and not look like 
-an address, or be COMMON, DEFAULT or SERVER.
+an address, or be COMMON or SERVER.
 
 There are also:
 
@@ -89,16 +89,18 @@ 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
      Discard packets after they have been queued this long waiting
      for http.
-     On server: setting applies to downward packets, and is capped
-      by LIMIT values.
-     On client: setting applies to upward packets, and is
-      not affected by LIMIT values.
+     On server: setting applies to downward packets.
+     On client: setting applies to upward packets.
      [10 s; LIMIT: 121 s]
 
   http_timeout
@@ -106,8 +108,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
@@ -178,6 +182,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]