mirror of https://github.com/ntop/n2n.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
93 lines
2.8 KiB
93 lines
2.8 KiB
.TH supernode 1 "Jul 16, 2021" "version 3" "USER COMMANDS"
|
|
.SH NAME
|
|
supernode \- n2n supernode daemon
|
|
.SH SYNOPSIS
|
|
.B supernode
|
|
<config file>
|
|
.br
|
|
.B supernode
|
|
[OPTION]...
|
|
.SH DESCRIPTION
|
|
N2N is a peer-to-peer VPN system. Supernode is a node introduction registry,
|
|
broadcast conduit and packet relay node for the n2n system. On startup 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.
|
|
.PP
|
|
Supernode can service a number of n2n communities concurrently. Traffic does not
|
|
cross between communities.
|
|
.PP
|
|
All logging goes to stdout.
|
|
.PP
|
|
The config file is similar to the command line, with one option per line.
|
|
Lines starting with a "#" are ignored.
|
|
An equal sign ('=') should be used between key and value. Example: -p=7777
|
|
.SH OPTIONS FOR THE UNDERLYING NETWORK CONNECTION
|
|
.TP
|
|
\fB\-p \fR<\fIlocal port\fR>
|
|
listen on this fixed local UDP port, defaults to 7654
|
|
.TP
|
|
\fB\-F \fR<\fIfed name\fR>
|
|
name of the supernode's federation, defaults to '*Federation'
|
|
.TP
|
|
\fB\-l \fR<\fIhost:port\fR>
|
|
ip address or name, and port of known supernode
|
|
.TP
|
|
\fB\-m \fR<\fImac address\fR>
|
|
fixed MAC address for the supernode, e.g.
|
|
'-m 10:20:30:40:50:60', random otherwise
|
|
.TP
|
|
\fB\-M\fR
|
|
disable MAC and IP address spoofing protection for all
|
|
non-username-password-authenticating communities
|
|
.SH TAP DEVICE AND OVERLAY NETWORK CONFIGURATION
|
|
.TP
|
|
\fB\-c \fR<\fIpath\fR>
|
|
file containing the allowed communities
|
|
.TP
|
|
\fB\-a \fR<\fInet-net/n\fR>
|
|
subnet range for auto ip address service,
|
|
.br
|
|
e.g. '-a 192.168.0.0-192.168.255.0/24',
|
|
.br
|
|
defaults to '10.128.255.0-10.255.255.0/24'
|
|
.SH LOCAL OPTIONS
|
|
.TP
|
|
\-f
|
|
disable daemon mode (UNIX) and run in foreground.
|
|
.TP
|
|
\fB\-t \fR<\fIport\fR>
|
|
management UDP port, for multiple supernodes on a machine, defaults to 5645
|
|
.TP
|
|
\-v
|
|
use verbose logging
|
|
.TP
|
|
\fB\-u \fR<\fIUID\fR>
|
|
numeric user ID to use when privileges are dropped
|
|
.TP
|
|
\fB\-g \fR<\fIGID\fR>
|
|
numeric group ID to use when privileges are dropped
|
|
.TP
|
|
\fB-h\fR
|
|
shows a quick reference including all available options
|
|
.TP
|
|
\fB--help\fR
|
|
shows detailed parameter description
|
|
|
|
.SH EXAMPLES
|
|
.TP
|
|
.B supernode -p 7654 -v
|
|
Start supernode listening on UDP port 7654 with verbose output.
|
|
.PP
|
|
.SH 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.
|
|
.SH EXIT STATUS
|
|
supernode is a daemon and any exit is an error
|
|
.SH AUTHOR
|
|
Luca Deri ( deri (at) ntop.org ), Richard Andrews ( andrews (at) ntop.org ), Don Bindner
|
|
.SH SEE ALSO
|
|
ifconfig(8) edge(8)
|
|
|