"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "supernode.1" between
n2n-2.8.tar.gz and n2n-3.0.tar.gz

About: n2n is a layer-two peer-to-peer virtual private network (VPN) which allows bypassing intermediate firewalls.

supernode.1  (n2n-2.8)	:	supernode.1  (n2n-3.0)
supernode(1) USER COMMANDS supernode(1)		supernode(1) USER COMMANDS supernode(1)
NAME		NAME
supernode - n2n supernode daemon		supernode - n2n supernode daemon
SYNOPSIS		SYNOPSIS
supernode -l <port> [-v]		supernode <config file>
		supernode [OPTION]...
DESCRIPTION		DESCRIPTION
N2N is a peer-to-peer VPN system. Supernode is a node introduction regist ry, broadcast conduit and packet		N2N is a peer-to-peer VPN system. Supernode is a node introduction regist ry, broadcast conduit and packet
relay node for the n2n system. On startup supernode begins listening on t he specified UDP port for node		relay node for the n2n system. On startup supernode begins listening on t he specified UDP port for node
registrations, and other packets to route. The supernode can service any number of communities and routes		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 no t hold the community encryption		packets only between members of the same community. The supernode does no t hold the community encryption
key and so cannot snoop or inject packets into the community.		key and so cannot snoop or inject packets into the community.
Supernode can service a number of n2n communities concurrently. Traffic does not cross between communi-		Supernode can service a number of n2n communities concurrently. Traffic does not cross between communi-
ties.		ties.
All logging goes to stdout.		All logging goes to stdout.
OPTIONS		The config file is similar to the command line, with one option per line.
-l <port>		Lines starting with a "#" are
listen on the given UDP port		ignored. An equal sign ('=') should be used between key and value. Examp
		le: -p=7777
-v use verbose logging		OPTIONS FOR THE UNDERLYING NETWORK CONNECTION
		-p <local_port>, --local-port=<local_port>
		listen on this fixed local UDP port, defaults to 7654
-f disable daemon mode (UNIX) and run in foreground.		-F <fed_name>
		name of the supernode's federation, defaults to '*Federation' (see
		also N2N_FEDERATION in ENVIRON-
		MENT)
		-l <host:port>
		ip address or name, and port of known supernode
		-m <mac_address>
		fixed MAC address for the supernode, e.g.
		'-m 10:20:30:40:50:60', random otherwise
		-M disable MAC and IP address spoofing protection for all non-usernam
		e-password-authenticating commu-
		nities
		-V <version_string>
		modify the supernode version string which is distributed to the
		edges and shown at their manage-
		ment port output, up to 19 characters
		TAP DEVICE AND OVERLAY NETWORK CONFIGURATION
		-c <path>, --communities=<path>
		file containing the allowed communities and any User / Password ba
		sed authentication details (See
		ALLOWED COMMUNITIES FILE section)
		-a <net-net/n>, --autoip=<net-net/n>
		subnet range for auto ip address service,
		e.g. '-a 192.168.0.0-192.168.255.0/24',
		defaults to '10.128.255.0-10.255.255.0/24'
		LOCAL OPTIONS
		-f, --foreground
		disable daemon mode (UNIX) and run in foreground.
		-t <port>, --mgmt-port=<port>
		management UDP port, for multiple supernodes on a machine, default
		s to 5645
		--management-password <password>
		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 manageme
		nt port.
		-v, --verbose
		use verbose logging
		-u <UID>
		numeric user ID to use when privileges are dropped
		-g <GID>
		numeric group ID to use when privileges are dropped
		-h shows a quick reference including all available options
		--help shows detailed parameter description
		ALLOWED COMMUNITIES FILE
		This file is a plain text file. Comments are introduced with a hash at t
		he 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 wi
		th 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 Authentica-
		tion.md documentation included with this package.
		ENVIRONMENT
		N2N_FEDERATION
		set the federation name so it is not visible at the command line
EXAMPLES		EXAMPLES
supernode -l 7654 -v		supernode -p 7654 -v
Start supernode listening on UDP port 7654 with verbose output.		Start supernode listening on UDP port 7654 with verbose output.
		echo | nc -w1 -u 127.0.0.1 5645
		Shows the management status of a running supernode.
RESTART		RESTART
When suprenode restarts it loses all registration information from associ ated edge nodes. It can take up		When supernode restarts it loses all registration information from assoc iated edge nodes. It can take up
to five minutes for the edge nodes to re-register and normal traffic flow to resume.		to five minutes for the edge nodes to re-register and normal traffic flow to resume.
EXIT STATUS		EXIT STATUS
supernode is a daemon and any exit is an error		supernode is a daemon and any exit is an error
AUTHOR		AUTHOR
Luca Deri ( deri (at) ntop.org ), Richard Andrews ( andrews (at) ntop.org ), Don Bindner		Luca Deri ( deri (at) ntop.org ), Richard Andrews ( andrews (at) ntop.org ), Don Bindner
SEE ALSO		SEE ALSO
ifconfig(8) edge(8)		ifconfig(8) edge(8)
		the documentation contained in the source code
		the extensive documentation found in n2n's doc/ folder
revision 3679 Jan 3, 2009 supernode(1)		version 3 Jul 16, 2021 supernode(1)
End of changes. 9 change blocks.
8 lines changed or deleted		99 lines changed or added

---