innernet/doc/innernet-server.8

66 lines
1.6 KiB
Groff
Raw Normal View History

2022-01-11 20:18:19 +00:00
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
2022-01-12 22:31:31 +00:00
.TH INNERNET-SERVER "8" "January 2022" "innernet-server 1.5.3-beta.2" "System Administration Utilities"
2021-04-09 13:47:33 +00:00
.SH NAME
2022-01-12 22:31:31 +00:00
innernet-server \- manual page for innernet-server 1.5.3-beta.2
2021-04-09 13:47:33 +00:00
.SH DESCRIPTION
2022-01-12 22:31:31 +00:00
innernet\-server 1.5.3\-beta.2
2022-01-11 20:18:19 +00:00
Jake McGinty <me@jake.su>
2021-04-09 13:47:33 +00:00
A server to coordinate innernet networks.
.SS "USAGE:"
.IP
2021-05-31 15:23:14 +00:00
innernet\-server [OPTIONS] <SUBCOMMAND>
.SS "OPTIONS:"
.TP
2022-01-11 20:18:19 +00:00
\fB\-c\fR, \fB\-\-config\-dir\fR <CONFIG_DIR>
2021-12-05 17:35:18 +00:00
[default: /etc/innernet\-server]
.TP
2022-01-11 20:18:19 +00:00
\fB\-d\fR, \fB\-\-data\-dir\fR <DATA_DIR>
2021-12-05 17:35:18 +00:00
[default: /var/lib/innernet\-server]
.TP
2021-05-31 15:23:14 +00:00
\fB\-\-no\-routing\fR
2022-01-11 20:18:19 +00:00
Whether the routing should be done by innernet or is done by an
external tool like e.g. babeld
2021-05-31 15:23:14 +00:00
.TP
2022-01-11 20:18:19 +00:00
\fB\-\-backend\fR <BACKEND>
Specify a WireGuard backend to use. If not set, innernet will
auto\-select based on availability [default: kernel] [possible
values: kernel, userspace]
2021-04-09 13:47:33 +00:00
.TP
2022-01-11 20:18:19 +00:00
\fB\-\-mtu\fR <MTU>
Specify the desired MTU for your interface (default: 1420 for
IPv4 and 1400 for IPv6)
2021-06-14 14:53:02 +00:00
.TP
2021-04-09 13:47:33 +00:00
\fB\-h\fR, \fB\-\-help\fR
2022-01-11 20:18:19 +00:00
Print help information
2021-04-09 13:47:33 +00:00
.TP
\fB\-V\fR, \fB\-\-version\fR
2022-01-11 20:18:19 +00:00
Print version information
2021-04-09 13:47:33 +00:00
.SS "SUBCOMMANDS:"
.TP
2021-05-31 15:23:14 +00:00
new
Create a new network
.TP
uninstall
Permanently uninstall a created network, rendering it unusable. Use with care
.TP
serve
Serve the coordinating server for an existing network
2021-04-09 13:47:33 +00:00
.TP
add\-peer
Add a peer to an existing network
.TP
2021-05-31 15:23:14 +00:00
rename\-peer
Rename an existing peer
.TP
add\-cidr
Add a new CIDR to an existing network
.TP
2021-05-21 05:46:30 +00:00
delete\-cidr
Delete a CIDR
.TP
2021-05-31 15:23:14 +00:00
completions
Generate shell completion scripts
.TP
2021-04-09 13:47:33 +00:00
help
2022-01-11 20:18:19 +00:00
Print this message or the help of the given subcommand(s)