mirror of
https://codeberg.org/cunicu/cunicu.git
synced 2025-09-27 21:22:18 +08:00
141 lines
2.7 KiB
Groff
141 lines
2.7 KiB
Groff
.nh
|
|
.TH "cunīcu" "1" "Sep 2022" "https://github.com/stv0g/cunicu" ""
|
|
|
|
.SH NAME
|
|
.PP
|
|
cunicu-daemon - Start the daemon
|
|
|
|
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\fBcunicu daemon [interface-names...] [flags]\fP
|
|
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
Start the daemon
|
|
|
|
|
|
.SH OPTIONS
|
|
.PP
|
|
\fB-A\fP, \fB--auto-config\fP[=true]
|
|
Enable setup of link-local addresses and missing interface options
|
|
|
|
.PP
|
|
\fB-b\fP, \fB--backend\fP=[]
|
|
One or more \fB\fCURL\fRs to signaling backends
|
|
|
|
.PP
|
|
\fB-x\fP, \fB--community\fP=""
|
|
A \fB\fCpassphrase\fR shared with other peers in the same community
|
|
|
|
.PP
|
|
\fB-c\fP, \fB--config\fP=[]
|
|
One or more \fB\fCfilename\fRs of configuration files
|
|
|
|
.PP
|
|
\fB-S\fP, \fB--config-sync\fP[=true]
|
|
Enable synchronization of WireGuard configuration files
|
|
|
|
.PP
|
|
\fB-D\fP, \fB--domain\fP=[]
|
|
A DNS \fB\fCdomain\fR name used for DNS auto-configuration
|
|
|
|
.PP
|
|
\fB-E\fP, \fB--endpoint-disc\fP[=true]
|
|
Enable ICE endpoint discovery
|
|
|
|
.PP
|
|
\fB-H\fP, \fB--host-sync\fP[=true]
|
|
Enable synchronization of /etc/hosts file
|
|
|
|
.PP
|
|
\fB--ice-candidate-type\fP=[]
|
|
Usable \fB\fCcandidate-type\fRs (one of host, srflx, prflx, relay)
|
|
|
|
.PP
|
|
\fB--ice-network-type\fP=[]
|
|
Usable \fB\fCnetwork-type\fRs (one of udp4, udp6, tcp4, tcp6)
|
|
|
|
.PP
|
|
\fB-p\fP, \fB--password\fP=""
|
|
The \fB\fCpassword\fR for STUN/TURN credentials
|
|
|
|
.PP
|
|
\fB-P\fP, \fB--peer-sync\fP[=true]
|
|
Enable peer discovery
|
|
|
|
.PP
|
|
\fB-R\fP, \fB--route-sync\fP[=true]
|
|
Enable synchronization of AllowedIPs and Kernel routing table
|
|
|
|
.PP
|
|
\fB-T\fP, \fB--route-table\fP=254
|
|
Kernel routing table to use
|
|
|
|
.PP
|
|
\fB-s\fP, \fB--rpc-socket\fP=""
|
|
The \fB\fCpath\fR of the unix socket used by other cunicu commands
|
|
|
|
.PP
|
|
\fB--rpc-wait\fP[=false]
|
|
Wait until first client connected to control socket before continuing start
|
|
|
|
.PP
|
|
\fB-a\fP, \fB--url\fP=[]
|
|
One or more \fB\fCURL\fRs of STUN and/or TURN servers
|
|
|
|
.PP
|
|
\fB-u\fP, \fB--username\fP=""
|
|
The \fB\fCusername\fR for STUN/TURN credentials
|
|
|
|
.PP
|
|
\fB-w\fP, \fB--watch\fP[=false]
|
|
Watch configuration files for changes and apply changes at runtime.
|
|
|
|
.PP
|
|
\fB-i\fP, \fB--watch-interval\fP=0s
|
|
An interval at which we are periodically polling the kernel for updates on WireGuard interfaces
|
|
|
|
.PP
|
|
\fB-U\fP, \fB--wg-userspace\fP[=false]
|
|
Use user-space WireGuard implementation for newly created interfaces
|
|
|
|
.PP
|
|
\fB-h\fP, \fB--help\fP[=false]
|
|
help for daemon
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
.PP
|
|
\fB-C\fP, \fB--color\fP="auto"
|
|
Enable colorization of output (one of: auto, always, never)
|
|
|
|
.PP
|
|
\fB-l\fP, \fB--log-file\fP=""
|
|
path of a file to write logs to
|
|
|
|
.PP
|
|
\fB-d\fP, \fB--log-level\fP="info"
|
|
log level (one of: debug, info, warn, error, dpanic, panic, and fatal)
|
|
|
|
.PP
|
|
\fB-v\fP, \fB--verbose\fP=0
|
|
verbosity level
|
|
|
|
|
|
.SH EXAMPLE
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
$ cunicu daemon -u -x mysecretpass wg0
|
|
|
|
.fi
|
|
.RE
|
|
|
|
|
|
.SH SEE ALSO
|
|
.PP
|
|
\fBcunicu(1)\fP
|