Update README.md

This commit is contained in:
sump pump 2020-04-28 05:21:15 +00:00
parent 6013ea2934
commit f68f0389ff

View File

@ -14,8 +14,12 @@ Run: `tincd -n lixonet -K`
All options are supplied in the `name=value` format on individual lines, i.e. `name=test_name_lixo` All options are supplied in the `name=value` format on individual lines, i.e. `name=test_name_lixo`
* `name` - The global, local neighbor name. Tinc and Bird use this to identify a peer in the network. * `name` - The global neighbor name. Tinc and Bird use this to identify a peer in the network, and to exclude your own pre-packed config automagically from BIRD so you don't connect to yourself over and over again.
* `wan_interface` - The interface that Tinc should bind to to _listen_ for incoming connections (i.e. eth1). This is _not_ the tunnel interface. * `address` - The *router* address to use. This is your Lixonet routing layer address: 172.xxx.0.xxx
* `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)
* `netmask` - The routing layer netmask to use. This should be `255.255.255.0` in most cases as our routing layer has always been a ``/24` subnet. Used by Tinc and BIRD for the L2 mesh and route security ingress filtering respectively.
* `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.
**Setup** **Setup**