innernet/doc/innernet-server.8

69 lines
1.5 KiB
Groff
Raw Normal View History

.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH INNERNET-SERVER "8" "December 2023" "innernet-server 1.6.1" "System Administration Utilities"
2021-04-09 21:47:33 +08:00
.SH NAME
innernet-server \- manual page for innernet-server 1.6.1
.SH SYNOPSIS
.B innernet-server
[\fI\,OPTIONS\/\fR] \fI\,<COMMAND>\/\fR
2021-04-09 21:47:33 +08:00
.SH DESCRIPTION
A server to coordinate innernet networks.
.SS "Commands:"
2021-04-09 21:47:33 +08:00
.TP
2021-05-31 23:23:14 +08:00
new
Create a new network
.TP
uninstall
Permanently uninstall a created network, rendering it unusable. Use with care
2021-05-31 23:23:14 +08:00
.TP
serve
Serve the coordinating server for an existing network
2021-04-09 21:47:33 +08:00
.TP
add\-peer
Add a peer to an existing network
.TP
2022-09-24 12:16:35 +08:00
disable\-peer
Disable an enabled peer
.TP
enable\-peer
Enable a disabled peer
.TP
2021-05-31 23:23:14 +08:00
rename\-peer
Rename an existing peer
.TP
add\-cidr
Add a new CIDR to an existing network
.TP
2021-05-21 13:46:30 +08:00
delete\-cidr
Delete a CIDR
.TP
2021-05-31 23:23:14 +08:00
completions
Generate shell completion scripts
.TP
2021-04-09 21:47:33 +08:00
help
2022-01-12 04:18:19 +08:00
Print this message or the help of the given subcommand(s)
.SH OPTIONS
.TP
\fB\-c\fR, \fB\-\-config\-dir\fR <CONFIG_DIR>
[default: /etc/innernet\-server]
.TP
\fB\-d\fR, \fB\-\-data\-dir\fR <DATA_DIR>
[default: /var/lib/innernet\-server]
.TP
\fB\-\-no\-routing\fR
Whether the routing should be done by innernet or is done by an
external tool like e.g. babeld
.TP
\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]
.TP
\fB\-\-mtu\fR <MTU>
Specify the desired MTU for your interface (default: 1280)
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version