New upstream version 3.1.1
This commit is contained in:
parent
4e9934e5ec
commit
e7b41df57b
229 changed files with 57000 additions and 12055 deletions
109
supernode.1
109
supernode.1
|
|
@ -1,8 +1,12 @@
|
|||
.TH supernode 1 "Jan 3, 2009" "revision 3679" "USER COMMANDS"
|
||||
.TH supernode 1 "Jul 16, 2021" "version 3" "USER COMMANDS"
|
||||
.SH NAME
|
||||
supernode \- n2n supernode daemon
|
||||
.SH SYNOPSIS
|
||||
.B supernode \-l <port> [\-v]
|
||||
.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
|
||||
|
|
@ -16,20 +20,105 @@ Supernode can service a number of n2n communities concurrently. Traffic does not
|
|||
cross between communities.
|
||||
.PP
|
||||
All logging goes to stdout.
|
||||
.SH OPTIONS
|
||||
.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
|
||||
\-l <port>
|
||||
listen on the given UDP port
|
||||
\fB\-p \fR<\fIlocal_port\fR>, \fB\-\-local-port\fR=<\fIlocal_port\fR>
|
||||
listen on this fixed local UDP port, defaults to 7654
|
||||
.TP
|
||||
\-v
|
||||
\fB\-F \fR<\fIfed_name\fR>
|
||||
name of the supernode's federation, defaults to '*Federation' (see also N2N_FEDERATION in ENVIRONMENT)
|
||||
.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
|
||||
.TP
|
||||
\fB\-V \fR<\fIversion_string\fR>
|
||||
modify the supernode version string which is distributed to the
|
||||
edges and shown at their management port output, up to 19 characters
|
||||
.TP
|
||||
.SH TAP DEVICE AND OVERLAY NETWORK CONFIGURATION
|
||||
.TP
|
||||
\fB\-c \fR<\fIpath\fR>, \fB\-\-communities\fR=<\fIpath\fR>
|
||||
file containing the allowed communities and any User / Password based authentication
|
||||
details (See ALLOWED COMMUNITIES FILE section)
|
||||
.TP
|
||||
\fB\-a \fR<\fInet-net/n\fR>, \fB\-\-autoip\fR=<net-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
|
||||
\fB\-f\fR, \fB\-\-foreground\fR
|
||||
disable daemon mode (UNIX) and run in foreground.
|
||||
.TP
|
||||
\fB\-t \fR<\fIport\fR>, \fB\-\-mgmt-port\fR=<\fIport\fR>
|
||||
management UDP port, for multiple supernodes on a machine, defaults to 5645
|
||||
.TP
|
||||
\fB\-\-management-password \fR<\fIpassword\fR>
|
||||
sets the password for access to JSON API at the management port, defaults to 'n2n'. The password
|
||||
has to be provided for relevant access to JSON API at the management port.
|
||||
.TP
|
||||
\fB\-v\fR, \fB\-\-verbose\fR
|
||||
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 ALLOWED COMMUNITIES 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.
|
||||
.PP
|
||||
Example community file:
|
||||
.PP
|
||||
.nf
|
||||
.RS
|
||||
# List of allowed communities
|
||||
mynetwork
|
||||
netleo
|
||||
* logan nHWum+r42k1qDXdIeH-WFKeylK5UyLStRzxofRNAgpG
|
||||
* sister HwHpPrdMft+38tFDDiunUds6927t0+zhCMMkQdJafcC
|
||||
.RE
|
||||
.fi
|
||||
.PP
|
||||
More details on creating the allowed communities file are found in the Communities.md and Authentication.md documentation included with this package.
|
||||
.SH ENVIRONMENT
|
||||
.TP
|
||||
.B N2N_FEDERATION
|
||||
set the federation name so it is not visible at the command line
|
||||
.SH EXAMPLES
|
||||
.TP
|
||||
.B supernode -l 7654 -v
|
||||
.B supernode -p 7654 -v
|
||||
Start supernode listening on UDP port 7654 with verbose output.
|
||||
.TP
|
||||
.B echo | nc -w1 -u 127.0.0.1 5645
|
||||
Shows the management status of a running supernode.
|
||||
.PP
|
||||
.SH RESTART
|
||||
When suprenode restarts it loses all registration information from associated
|
||||
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
|
||||
|
|
@ -38,3 +127,7 @@ supernode is a daemon and any exit is an error
|
|||
Luca Deri ( deri (at) ntop.org ), Richard Andrews ( andrews (at) ntop.org ), Don Bindner
|
||||
.SH SEE ALSO
|
||||
ifconfig(8) edge(8)
|
||||
.br
|
||||
the documentation contained in the source code
|
||||
.br
|
||||
the extensive documentation found in n2n's \fBdoc/\fR folder
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue