docs/settings.rst

   1 Configuration settings
   2 ======================
   3
   4 Exceptional settings
   5 --------------------
   6
   7 ``server``
   8   Specifies ``<servername>``.
   9   Is looked up in ``[SERVER]`` and ``[COMMON]`` only.
  10   If not specified there, it is ``SERVER``.
  11
  12   Used by server to select the appropriate parts of the
  13   rest of the configuration.  Ignored by the client.
  14
  15 ``secret``
  16   Looked up in the usual way, but used by client and server to
  17   determine which possible peerings to try to set up, and which to
  18   ignore.
  19
  20   We define the sets of putative clients and servers, as follows:
  21   all those, for which there is any section (even an empty one)
  22   whose name is based on ``<client>`` or ``<servername>`` (as applicable).
  23   (``LIMIT`` sections do not count.)
  24
  25   The server queue packets for, and accept requests from, each
  26   putative client for which the config search yields a secret.
  27
  28   Each client will create a local interface, and try to communicate
  29   with the server, for each possible pair (putative server,
  30   putative client) for which the config search yields a secret.
  31
  32   The value is a string, fed directly into HMAC.
  33
  34 ``ipif``
  35   Command to run to create and communicate with local network
  36   interface.  Passed to sh -c.  Must speak SLIP on stdin/stdout.
  37   The following interpolations aare substituted:
  38
  39   ============== ============ ============ =============== =================
  40   Input          ``%{local}``  ``%{peer}``   ``%{rnets}``    ``%{ifname}``
  41   ============== ============ ============ =============== =================
  42   **on server**  ``vaddr``    ``vrelay``   ``vnetwork``    ``ifname_server``
  43   **on client**  ``client``   ``vaddr``    ``vroutes``     ``ifname_client``
  44   ============== ============ ============ =============== =================
  45
  46   **Always:** ``%{mtu}``, and ``%%`` to indicate a literal ``%``.
  47
  48   (For compatibility with older hippotat, ``%(var)s`` is supported too
  49   but this is deprecated since the extra ``s`` is confusing.)
  50
  51   On server: applies to all clients; not looked up in client-specific sections.
  52   On client: may be different for different servers.
  53
  54   [string; ``userv root ipif %{local},%{peer},%{mtu},slip '%{rnets}'``]
  55
  56
  57 Capped settings
  58 ---------------
  59
  60 Values in ``[<server> LIMIT]`` and ``[LIMIT]`` are a cap (maximum) on
  61 those from the other sections (including ``COMMON``).  If a larger
  62 value is obtained, it is (silently) reduced to the limit value.
  63
  64
  65 ``max_batch_down``
  66   Size limit for response payloads.
  67
  68   On client, incoming response bodies are limited to this plus
  69   a fixed constant metadata overhead of 10000 bytes.
  70   Server uses minimum of client and server value (old servers
  71   just uses server's value).
  72
  73   [``65536`` (bytes); ``LIMIT``: ``262144``]
  74
  75 ``max_queue_time``
  76   Discard packets after they have been queued this long
  77   waiting for http.
  78
  79   On server: setting applies to downward packets.
  80   On client: setting applies to upward packets.
  81
  82   [``10`` (s); ``LIMIT``: ``121``]
  83
  84 ``http_timeout``
  85   On server: return with empty payload any http request oustanding
  86   for this long.
  87
  88   On client: give up on any http request outstanding for
  89   for this long plus ``http_timeout_grace``.
  90
  91   Warning messages about link problems, printed by the client,
  92   are rate limited to no more than one per effective timeout.
  93
  94   Client's effective timeout must be at least server's (checked).
  95
  96   [``30`` (s); ``LIMIT``: ``121``]
  97
  98 target_requests_outstanding
  99   On client: try to keep this many requests outstanding, to
 100   allow for downbound data transfer.
 101   On server: whenever number of outstanding requests for
 102   a client exceeds this, returns oldest with empty payload.
 103   Must match between client and server (checked).
 104   [``3``; ``LIMIT``: ``10``]
 105
 106
 107 Ordinary settings, used by both, not client-specific
 108 ----------------------------------------------------
 109
 110 On the server these are forbidden in the client-specific config
 111 sections.
 112
 113 ``addrs``
 114   Public IP (v4 or v6) address(es) of the server; space-separated.
 115   On server: mandatory; used for bind.
 116   On client: used only to construct default ``url``.
 117   No default.
 118
 119 ``vnetwork``
 120   Private network range.  Must contain all
 121   ``<client>``s.  Must contain ``vaddr`` and ``vrelay``, and is used
 122   to compute their defaults.  [CIDR syntax (``<prefix>/<length>``);
 123   ``172.24.230.192/28``]
 124
 125 ``vaddr``
 126   Address of server's virtual interface.
 127   [default: first host entry in ``vnetwork``, so ``172.24.230.193``]
 128
 129 ``vrelay``
 130   Virtual point-to-point address used for tunnel routing
 131   (does not appear in packets).
 132   [default: first host entry in ``vnetwork`` other than ``vaddr``,
 133   so ``172.24.230.194``]
 134
 135 ``port``
 136   Public port number of the server.
 137   On server: used for bind.
 138   On client: used only to construct default url.
 139   [``80``]
 140
 141 ``mtu``
 142   Of virtual interface.
 143   Must match exactly at each end - *this is not checked*.
 144   [``1500`` (bytes)]
 145
 146
 147 Ordinary settings, used by server only
 148 --------------------------------------
 149
 150 ``max_clock_skew``
 151   Permissible clock skew between client and server.
 152   Hippotat will not work if clock skew is more than this.
 153   Conversely: when moving client from one public network to
 154   another, the first network can deny service to the client for
 155   this period after the client leaves the first network.
 156   [``300`` (s)]
 157
 158 ``ifname_server``
 159   | Virtual interface name on the server.  [``shippo%d``]
 160   | Any ``%d`` is interpolated (by the kernel).
 161
 162
 163 Ordinary settings, used by client only
 164 --------------------------------------
 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 upbound payloads. [``4000`` (bytes)]
 175
 176 ``success_report_interval``
 177   If nonzero, report success periodically.  Otherwise just
 178   report it when we first have success.  [``3600`` (s)]
 179
 180 ``http_retry``
 181   If a request fails, wait this long before considering it
 182   "finished" - to limit rate of futile requests (and also
 183   to limit rate of moaning on stderr).  [``5`` s]
 184
 185 ``url``
 186   Public url of server.
 187   [``http://<first-entry-in-addrs>:<port>/``]
 188
 189 ``vroutes``
 190   Additional virtual addresses to be found at the server
 191   end, space-separated.  Routes to those will be created on
 192   the client.  ``vrelay`` is included implicitly.
 193   [CIDR syntax, space separated; default: none]
 194
 195 ``ifname_client``
 196   | Virtual interface name on the client.  [``hippo%d``]
 197   | Any ``%d`` is interpolated (by the kernel).