Commit 58d99f00 authored by Guillaume Bury's avatar Guillaume Bury

Doc + TODO update

parent e2fa6495
To be done :
Male sure the re6stnet ip address is added on only one interface
Update the USAGE > OPTION > Tunnel & Peers options section of the re6stnet
man page ( about how tunnel options are treated ).
Do a 'real' test, on one ( or more ) real machine(s) preferably :
- package re6stnet
- install re6stnet
- follow the HOW TO section of the man page to setup a network
- see if it works....
Put more information in the token mail ( registry ), such as :
- the ip address of the network being built
- the creator of the network ( add option in registry ? )
Make sure the re6stnet ip address is added on only one interface
( tweak the ovpn-server script ), else duplicate addresses appears in routing
tables.
......@@ -8,3 +21,5 @@ To be done :
number of routes / tunnel
Warn babeld about the tunnels wich are about to be deleted. Maybe we could just increase the cost.
~~~ => Complete and upgrade the Routing with babel presentation (web page on tiolive.com/nexedi)
......@@ -57,6 +57,9 @@ obtained with the re6st-conf tool.
Options
-------
Generic options
~~~~~~~~~~~~~~~
-h, --help Display a summary help about the options
@file
......@@ -74,14 +77,6 @@ Options
support ipv6 addresses.
Proto should be either udp or tcp-client
-i, ``--interface`` `interface`
Give one interface name for each use of the argument. The interface
will be used to detect other nodes on the local network.
--peers-db-refresh duration
Duration in seconds of the peers DB refresh interval.
Default : 3600 ( 1 hour )
-l, ``--log`` `directory`
Path to the directory used for log files. Will create one file
for babel logging and one file for each openvpn server and client
......@@ -102,9 +97,16 @@ Options
level for now, except an increased number means more log messages.
This parameter is also given to babel for its log.
To adjust verbose level for openvpn, add an openvpn optional
arguments at the end of the command line
arguments at the end of the command line.
Default : 0
Babel options
~~~~~~~~~~~~~
-i, ``--interface`` `interface`
Give one interface name for each use of the argument. The interface
will be used to detect other nodes on the local network.
--hello duration
Set hello interval, in seconds, for both wired and wireless
connections. Openvpn ping-exit option is set to 4 times the hello
......@@ -119,7 +121,18 @@ Options
-w, --wireless
Consider all interfaces as being wireless interfaces. Argument
directly passed down to the babeld daemon
directly passed down to the babeld daemon.
Tunnel & Peers options
~~~~~~~~~~~~~~~~~~~~~~
--peers-db-refresh duration
Duration in seconds of the peers DB refresh interval. At each
refresh, a re6st node will declare itself to the re6st-registry,
and request a list of peers to connect to. A list of peers is also
queried when tying to make a connection and no peers is available
in the database.
Default : 3600 ( 1 hour )
--pp port proto
Port and protocol used by the openvpn server(s). Start one openvpn
......@@ -133,15 +146,16 @@ Options
--tunnel-refresh duration
Interval in seconds between two tunnel refresh. Refreshing tunnels
mean :
- killing all dead tunnels ( detected via the ping-exit option
if openvpn )
if openvpn )
- killing the 'worst' tunnels, so that at least the ratio of
tunnels set by the --refresh-rate option have been killed
tunnels set by the --refresh-rate option have been killed
- creating new tunnels to other clients randomly choosen in the
peers database, to reach the number of connection specified by
the connection-count option ( There can be less tunnels if the
peers DB does not contain enough peers )
Default : 300
peers database, to reach the number of connection specified by
the connection-count option ( There can be less tunnels if the
peers DB does not contain enough peers )
Default : 300
--connection-count number
The maximum number of openvpn clients to start.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment