n3n-supernode(8)

NAME
n3n-supernode - n3n supernode daemon

SYNOPSIS
n3n-supernode [options..] [command] [command args]
n3n-supernode start [sessionname]
n3n-supernode --help

DESCRIPTION
N3N is a peer-to-peer VPN system - it is the LAN you have when you have noLAN. The Supernode is a node introduction registry, broadcast conduit and packet relay node for the n3n system. Once it has the full config loaded, the supernode begins listening on the specified UDP port for node registrations, and other packets to route. The supernode can service any number of communities and routes packets only between members of the same community. The supernode does not hold the community encryption key and so cannot snoop or inject packets into the community. Supernode can service a number of n3n communities concurrently. Traffic does not cross between communities. All logging goes to stdout.

OPTIONS
Some of the most common options also have a shortcut version and you can see all of them with:
    n3n-supernode help options

OPTIONS

-O <section>.<option>=<value>
    Sets any config option value.

-h, --help
    Show some quick usage notes.

-d, --daemon
    Fork and run as a daemon, instead of the default of running in foreground. This is ignored on windows.

-v, --verbose
    increase logging verbosity

ALLOWED COMMUNITIES FILE
Specified with -Osupernode.community_file= option (or in a config file) This file is a plain text file. Comments are introduced with a hash at the beginning of the line. A line that begins with an asterisk is a user authentication definition and adds an allowed user to the most recently defined community. Allowed communities can be specified with a regular expression.

Example community file:

    # List of allowed communities
    mynetwork
    netleo
    * logan nHWum+r42k1qDXdIeH-WFKeylK5UyLStRzxofRNAgpG
    * sister HwHpPrdMft+38tFDDiunUds6927t0+zhCMMkQdJafcC

More details on creating the allowed communities file are found in the Communities.md and Authentication.md documentation included with this package.

ENVIRONMENT

N3N_FEDERATION
    set the federation name so it is not visible at the command line

EXAMPLES

n3n-supernode start -v
    Start supernode listening on default UDP port (7654) with verbose output.

RESTART
When supernode restarts it loses all registration information from associated edge nodes. It can take up to five minutes for the edge nodes to re-register and normal traffic flow to resume.

EXIT STATUS
supernode is a daemon and any exit is an error

AUTHORS

Hamish Coleman
    hamish (at) zot.org - n3n maintainer

Luca Deri
    deri (at) ntop.org

Richard Andrews
    andrews (at) ntop.org

Don Bindner

SEE ALSO
ifconfig(8) edge(8)
the documentation contained in the source code
the extensive documentation found in n3n's doc/ folder