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 interpolations aare substituted:
  74                        %(local)s  %(peer)s  %(rnets)s   %(ifname)s
  75           on server    <vaddr>    <vrelay>  <vnetwork>  <ifname_server>
  76           on client    <client>   <vaddr>   <vroutes>   <ifname_client>
  77      Plus %(mtu)s (and %% to indicate a literal %).
  78      ["userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s"]
  79
  80      On server: applies to all clients; not looked up in
  81       client-specific sections.
  82      On client: may be different for different servers.
  83
  84 Capped settings:
  85
  86      Values in [<server> LIMIT] and [LIMIT] are a cap (maximum) on
  87      those from the other sections (including COMMON).
  88
  89   max_batch_down
  90      Size limit for response payloads (used by server only)
  91      [65536 bytes; LIMIT: 262144 bytes]
  92
  93   max_queue_time
  94      Discard packets after they have been queued this long waiting
  95      for http.
  96      On server: setting applies to downward packets, and is capped
  97       by LIMIT values.
  98      On client: setting applies to upward packets, and is
  99       not affected by LIMIT values.
 100      [10 s; LIMIT: 121 s]
 101
 102   http_timeout
 103      On server: return with empty payload any http request oustanding
 104       for this long
 105      On client: give up on any http request outstanding for
 106       for this long plus http_timeout_grace
 107      Client's effective timeout must be at least server's (checked).
 108      [30 s; LIMIT: 121]
 109
 110   target_requests_outstanding
 111      On server: whenever number of outstanding requests for
 112       a client exceeds this, return oldest with empty payload
 113      On client: try to keep this many requests outstanding.
 114      Must match between client and server (checked).
 115      [3; LIMIT: 10]
 116
 117 Ordinary settings, used by both, not client-specific:
 118
 119     These are not looked up in the client-specific config sections.
 120
 121   addrs
 122      Public IP (v4 or v6) address(es) of the server;
 123      space-separated.
 124      On server: mandatory; used for bind.  No default.
 125      On client: used only to construct default url.
 126
 127   vnetwork
 128      Private network range (<prefix>/<length>).  Must contain all
 129      <client>s.  Must contain <vaddr> and <vrelay>, and used
 130      to compute their defaults.  [172.24.230.192/28]
 131
 132   vaddr
 133      Address of server's virtual interface.
 134      [first host entry in <vnetwork>, so 172.24.230.193]
 135
 136   vrelay
 137      Virtual point-to-point address used for tunnel routing
 138      (does not appear in packets).
 139      [first host entry in <vnetwork> other than <vaddr>,
 140       so 172.24.230.194]
 141
 142   port
 143      Public port number of the server.  [80]
 144      On server: used for bind.
 145      On client: used only to construct default url.
 146
 147   mtu
 148      Of virtual interface.  Must match exactly at each end.
 149      (UNCHECKED) [1500 bytes]
 150
 151   ifname_server
 152      Virtual interface name on the server.  [shippo%d]
 153   ifname_client
 154      Virtual interface name on the client.  [hippo%d]
 155      Any %d is interpolated (by the kernel).
 156
 157 Ordinary settings, used by server only:
 158
 159   max_clock_skew
 160      Permissible clock skew between client and server.
 161      hippotat will not work if clock skew is more than this.
 162      Conversely: when moving client from one public network to
 163      another, the first network can deny service to the client for
 164      this period after the client leaves the first network.
 165      [300s]
 166
 167 Ordinary settings, used by client only:
 168
 169   http_timeout_grace
 170      See http_timeout.  [5 s]
 171
 172   max_requests_outstanding
 173      Client will hold off sending more requests than this to
 174      server even if it has data to send.  [6]
 175
 176   max_batch_up
 177      Size limit for request payloads. [4000 bytes]
 178
 179   http_retry
 180      If a request fails, wait this long before considering it
 181      "finished" - to limit rate of futile requests.  [5 s]
 182
 183   url
 184      Public url of server.
 185      [http://<first-entry-in-addrs>:<port>/]
 186
 187   vroutes
 188      Virtual addresses (in CIDR syntax) to be found at the server
 189      end, space-separated.  Routes to those will be created on
 190      the client.  [""]