diff --git a/README.md b/README.md index 314e31f..33d0018 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,12 @@ You **MUST** specify these options, or Lixonet will not work. * `network_address` - The *network* address to use. This is your Lixonet routing layer address: 172.xxx.0.0 (especially take note of the last two 0's: `0.0` -- it _MUST_ end with zeros corresponding to the network size) * `asn` - The BGP ASN to use. We usually follow the format `4206969XXX` where _XXX_ is the last octet of your `address`, zero-padded (i.e. 008 or 212) -#### Tinc options - * `tinc_bind_address` - OPTIONAL: The address that Tinc should bind to to _listen_ for incoming WAN-sided connections (i.e. 10.0.0.1). This is _not_ the tunnel IP. - * `tinc_connect_to` - OPTIONAL: A comma-separated list of well-known/pre-defined hosts to connect to (i.e. `denco_mane_lixo`). If not supplied, this is automatically set to all core routers that aren't yourself (`name`). - ## Non-required options: +#### Tinc options + * `tinc_bind_address` - The address that Tinc should bind to to _listen_ for incoming WAN-sided connections (i.e. 10.0.0.1). This is _not_ the tunnel IP. + * `tinc_connect_to` - A comma-separated list of well-known/pre-defined hosts to connect to (i.e. `denco_mane_lixo`). If not supplied, this is automatically set to all core routers that aren't yourself (`name`). Use this if you have an `eth1` that you _don't_ want to use for binding tinc to, and would prefer to bind tinc to `eth0` instead. + #### Network options * `global_prefix`: global network prefix: defaults to `16`. * `router_prefix`: router network prefix: defaults to `24`. If you change this you _SHOULD_ change `netmask` too.