README.config

   1 -*- Fundamental -*-
   2
   3 Sections
   4
   5   [<servername> <client>]
   6   [<client>]
   7   [<servername>]      often [SERVER]
   8   [COMMON]
   9
  10 Keys are looked up in that order, unless otherwise specified.
  11 <client> is the client's virtual address.
  12 <servername> must be a valid lowercase DNS hostname and not look like
  13 an address, or be COMMON, DEFAULT or SERVER.
  14
  15 There are also:
  16
  17   [<servername> LIMIT]
  18   [LIMIT]
  19
  20 Things not in a section are an error.
  21
  22
  23 Both client and server read the files
  24   /etc/hippotat/main.cfg
  25   /etc/hippotat/config.d/*
  26   /etc/hippotat/secrets.d/*
  27 and in each case if it's a directory, all contained files whose
  28 names consists of only ascii alphanumerics plus '-' and '_'.
  29
  30 The ini file format sections from these files are all unioned.
  31 Later files (in the list above, or alphabetically later) can
  32 override settings from earlier ones.
  33
  34 Note that although it is conventional for information for a particular
  35 server or client to be in a file named after that endpoint, there is
  36 no semantic link: all the files are always read and the appropriate
  37 section from each is applied to every endpoint.
  38
  39 (If main.cfg does not exist, master.cfg will be tried for backward
  40 compatibility reasons.)
  41
  42
  43 Exceptional settings:
  44
  45   server
  46      Specifies <servername>.
  47      Is looked up in [SERVER] and [COMMON] only.
  48      If not specified there, it is SERVER.
  49
  50      Used by server to select the appropriate parts of the
  51      rest of the configuration.  Ignored by the client.
  52
  53   secret
  54      Looked up in the usual way, but used by client and server to
  55      determine which possible peerings to try to set up, and which to
  56      ignore.
  57
  58      We define the sets of putative clients and servers, as follows:
  59      all those, for which there is any section (even an empty one)
  60      whose name is based on <client> or <servername> (as applicable).
  61      (LIMIT sections do not count.)
  62
  63      The server queue packets for, and accept requests from, each
  64      putative client for which the config search yields a secret.
  65
  66      Each client will create a local interface, and try to communicate
  67      with the server, for each possible pair (putative server,
  68      putative client) for which the config search yields a secret.
  69
  70   ipif
  71      Command to run to create and communicate with local network
  72      interface.  Passed to sh -c.  Must speak SLIP on stdin/stdout.
  73      The following additional interpolations aare substituted:
  74                        %(local)s  %(peer)s  %(rnet)s    %(ifname)s
  75           on server    <vaddr>    <vrelay>  <vnetwork>  <ifname_server>
  76           on client    <client>   <vaddr>   <vroutes>   <ifname_client>
  77      ["userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s"]
  78
  79      On server: applies to all clients; not looked up in
  80       client-specific sections.
  81      On client: may be different for different servers.
  82
  83 Capped settings:
  84
  85      Values in [<server> LIMIT] and [LIMIT] are a cap (maximum) on
  86      those from the other sections (including COMMON).
  87
  88   max_batch_down
  89      Size limit for response payloads (used by server only)
  90      [65536 bytes; LIMIT: 262144 bytes]
  91
  92   max_queue_time
  93      Discard packets after they have been queued this long waiting
  94      for http.
  95      On server: setting applies to downward packets, and is capped
  96       by LIMIT values.
  97      On client: setting applies to upward packets, and is
  98       not affected by LIMIT values.
  99      [10 s; LIMIT: 121 s]
 100
 101   http_timeout
 102      On server: return with empty payload any http request oustanding
 103       for this long
 104      On client: give up on any http request outstanding for
 105       for this long plus http_timeout_grace
 106      Client's effective timeout must be at least server's (checked).
 107      [30 s; LIMIT: 121]
 108
 109   target_requests_outstanding
 110      On server: whenever number of outstanding requests for
 111       a client exceeds this, return oldest with empty payload
 112      On client: try to keep this many requests outstanding.
 113      Must match between client and server (checked).
 114      [3; LIMIT: 10]
 115
 116 Ordinary settings, used by both, not client-specific:
 117
 118     These are not looked up in the client-specific config sections.
 119
 120   addrs
 121      Public IP (v4 or v6) address(es) of the server;
 122      space-separated.
 123      On server: mandatory; used for bind.  No default.
 124      On client: used only to construct default url.
 125
 126   vnetwork
 127      Private network range (<prefix>/<length>).  Must contain all
 128      <client>s.  Must contain <vaddr> and <vrelay>, and used
 129      to compute their defaults.  [172.24.230.192/28]
 130
 131   vaddr
 132      Address of server's virtual interface.
 133
 134   vrelay
 135      Virtual point-to-point address used for tunnel routing
 136      (does not appear in packets).
 137      [first host entry in <vnetwork> other than <vaddr>,
 138       so 172.24.230.194]
 139
 140   port
 141      Public port number of the server.  [80]
 142      On server: used for bind.
 143      On client: used only to construct default url.
 144
 145   mtu
 146      Must match exactly.  (UNCHECKED) [1500 bytes]
 147
 148   ifname_server
 149      Virtual interface name on the server.  [shippo%d]
 150   ifname_client
 151      Virtual interface name on the client.  [hippo%d]
 152      Any %d is interpolated (by the kernel).
 153
 154 Ordinary settings, used by server only:
 155
 156   max_clock_skew
 157      Permissible clock skew between client and server.
 158      hippotat will not work if clock skew is more than this.
 159      Conversely: when moving client from one public network to
 160      another, the first network can deny service to the client for
 161      this period after the client leaves the first network.
 162      [300s]
 163
 164 Ordinary settings, used by client only:
 165
 166   http_timeout_grace
 167      See http_timeout.  [5 s]
 168
 169   max_requests_outstanding
 170      Client will hold off sending more requests than this to
 171      server even if it has data to send.  [6]
 172
 173   max_batch_up
 174      Size limit for request payloads. [4000 bytes]
 175
 176   http_retry
 177      If a request fails, wait this long before considering it
 178      "finished" - to limit rate of futile requests.  [5 s]
 179
 180   url
 181      Public url of server.
 182      [http://<first-entry-in-addrs>:<port>/]
 183
 184   vroutes
 185      Virtual addresses (in CIDR syntax) to be found at the server
 186      end, space-separated.  Routes to those will be created on
 187      the client.  [""]