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