Next: , Previous: , Up: User manual  


Server part

Except for common -mtu, -stats options server has the following ones:

-bind

Address (host:port format) we must bind to.

-peers

Path to the directory containing peers information, database.

Peers directory must contain subdirectories with the names of client’s identities in hexadecimal notation. Each subdirectory has the following files:

verifier

Required. Contains corresponding verifier used to authenticate the client in hexadecimal notation. See Verifier for how to create it.

up.sh

Required. up-script executes each time connection with the client is established. It’s stdout output must contain TAP interface name on the first string. This script can be simple echo tap10, or maybe more advanced like this:

    #!/bin/sh
    $tap=$(ifconfig tap create)
    ifconfig $tap inet6 fc00::1/96 mtu 1412 up
    echo $tap
    
down.sh

Optional. Same as up.sh above, but executes when connection is lost.

name

Optional. Contains human readable username. Used to beauty output of Stats.

timeout

Optional. Contains Timeout setting (decimal notation) in seconds. Otherwise default minute timeout will be used.

noncediff

Optional. Contains allowable Nonce difference setting (decimal notation).

noise

Optional. Contains either "1" (enable Noise adding), or "0".

cpr

Optional. Contains CPR setting (decimal notation) in KiB/sec.

Each minute server refreshes peers directory contents and adds newly appeared identities, deletes an obsolete ones.

You can use convenient utils/newclient.sh script for new client creation:

% ./utils/newclient.sh Alice
Place verifier to peers/9b40701bdaf522f2b291cb039490312/verifier

9b40701bdaf522f2b291cb039490312 is client’s identification. peers/9b40701bdaf522f2b291cb039490312/name contains Alice, peers/9b40701bdaf522f2b291cb039490312/verifier contains dummy verifier and peers/9b40701bdaf522f2b291cb039490312/up.sh contains currently dummy empty up-script.


Next: , Previous: , Up: User manual