git.meshlink.io Git - meshlink/blob - doc/FILES

   1 MeshLink is based on tinc, and tinc had the following structure for its
   2 directory with configuration files:
   3
   4 /tinc.conf       Main configuration file
   5 /tinc-up         Script to configure the virtual network interface
   6 /ecdsa_key.priv  This node's private key
   7 /hosts/node1     Host configuration file, containing the node's public key,
   8                  address, and perhaps other information.
   9 /hosts/node2     Another host's configuration file,
  10 /hosts/...       et cetera.
  11
  12 For MeshLink, we don't have any scripts, and neither the application nor the
  13 user is supposed to read or edit the configuration files in any way. Therefore,
  14 it might be a good idea to simplify them to the point that we are left
  15 with:
  16
  17 /meshlink.conf    Contains only the local node's Name and Port.
  18 /ecdsa_key.priv   Contains the private key, in binary.
  19 /nodes/node1      Contains only the public key and a list of known addresses.
  20 /nodes/node2      Another node's key and addresses,
  21 /nodes/...        et cetera.
  22
  23 Example /meshlink.conf:
  24
  25 Name = foo
  26 Port = 12345
  27
  28 Example /nodes/foo:
  29
  30 PublicKey = 19fj193f12d1m02dj12089cn
  31 Address = foo.example.com 18529
  32 Address = 93.184.216.119 18529
  33 Address = 2606:2800:220:6d:26bf:1447:1097:aa7 18529