mirror of
https://codeberg.org/cunicu/cunicu.git
synced 2025-10-26 18:21:22 +08:00
daemon: use per-interface features
Signed-off-by: Steffen Vogel <post@steffenvogel.de>
This commit is contained in:
Steffen Vogel
49
docs/usage/man/cunicu-config-reload.1
Normal file
49
docs/usage/man/cunicu-config-reload.1
Normal file
@@ -0,0 +1,49 @@
|
||||
.nh
|
||||
.TH "cunīcu" "1" "Sep 2022" "https://github.com/stv0g/cunicu" ""
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
cunicu-config-reload - Reload the configuration of the cunīcu daemon
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBcunicu config reload [flags]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Reload the configuration of the cunīcu daemon
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB-h\fP, \fB--help\fP[=false]
|
||||
help for reload
|
||||
|
||||
|
||||
.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-s\fP, \fB--rpc-socket\fP="/var/run/cunicu.sock"
|
||||
Unix control and monitoring socket
|
||||
|
||||
.PP
|
||||
\fB-v\fP, \fB--verbose\fP=0
|
||||
verbosity level
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBcunicu-config(1)\fP
|
||||
@@ -43,4 +43,4 @@ cunicu-config - Manage configuration of a running cunīcu daemon.
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBcunicu(1)\fP, \fBcunicu-config-get(1)\fP, \fBcunicu-config-set(1)\fP
|
||||
\fBcunicu(1)\fP, \fBcunicu-config-get(1)\fP, \fBcunicu-config-reload(1)\fP, \fBcunicu-config-set(1)\fP
|
||||
|
||||
@@ -33,24 +33,16 @@ Start the daemon
|
||||
\fB-c\fP, \fB--config\fP=[]
|
||||
One or more \fB\fCfilename\fRs of configuration files
|
||||
|
||||
.PP
|
||||
\fB-w\fP, \fB--config-path\fP=""
|
||||
The \fB\fCdirectory\fR of WireGuard wg/wg-quick configuration files
|
||||
|
||||
.PP
|
||||
\fB-S\fP, \fB--config-sync\fP[=true]
|
||||
Enable synchronization of WireGuard configuration files
|
||||
|
||||
.PP
|
||||
\fB-W\fP, \fB--config-watch\fP[=false]
|
||||
Watch and synchronize changes to the WireGuard configuration files
|
||||
|
||||
.PP
|
||||
\fB-D\fP, \fB--domain\fP=[]
|
||||
A DNS \fB\fCdomain\fR name used for DNS auto-configuration
|
||||
|
||||
.PP
|
||||
\fB-I\fP, \fB--endpoint-disc\fP[=true]
|
||||
\fB-E\fP, \fB--endpoint-disc\fP[=true]
|
||||
Enable ICE endpoint discovery
|
||||
|
||||
.PP
|
||||
@@ -66,12 +58,12 @@ Start the daemon
|
||||
Usable \fB\fCnetwork-type\fRs (one of udp4, udp6, tcp4, tcp6)
|
||||
|
||||
.PP
|
||||
\fB-f\fP, \fB--interface-filter\fP="\fI"
|
||||
A glob(7) \fB\fCpattern\fR for filtering WireGuard interfaces which this daemon will manage (e.g. "wg\fP")
|
||||
\fB-p\fP, \fB--password\fP=""
|
||||
The \fB\fCpassword\fR for STUN/TURN credentials
|
||||
|
||||
.PP
|
||||
\fB-P\fP, \fB--password\fP=""
|
||||
The \fB\fCpassword\fR for STUN/TURN credentials
|
||||
\fB-P\fP, \fB--peer-sync\fP[=true]
|
||||
Enable peer discovery
|
||||
|
||||
.PP
|
||||
\fB-R\fP, \fB--route-sync\fP[=true]
|
||||
@@ -94,15 +86,19 @@ Start the daemon
|
||||
One or more \fB\fCURL\fRs of STUN and/or TURN servers
|
||||
|
||||
.PP
|
||||
\fB-U\fP, \fB--username\fP=""
|
||||
\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]
|
||||
\fB-U\fP, \fB--wg-userspace\fP[=false]
|
||||
Use user-space WireGuard implementation for newly created interfaces
|
||||
|
||||
.PP
|
||||
|
||||
@@ -59,4 +59,4 @@ in which WireGuard kernel support has not landed yet.
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBcunicu-addresses(1)\fP, \fBcunicu-completion(1)\fP, \fBcunicu-config(1)\fP, \fBcunicu-daemon(1)\fP, \fBcunicu-monitor(1)\fP, \fBcunicu-relay(1)\fP, \fBcunicu-reload(1)\fP, \fBcunicu-restart(1)\fP, \fBcunicu-selfupdate(1)\fP, \fBcunicu-signal(1)\fP, \fBcunicu-status(1)\fP, \fBcunicu-stop(1)\fP, \fBcunicu-sync(1)\fP, \fBcunicu-version(1)\fP, \fBcunicu-wg(1)\fP
|
||||
\fBcunicu-addresses(1)\fP, \fBcunicu-completion(1)\fP, \fBcunicu-config(1)\fP, \fBcunicu-daemon(1)\fP, \fBcunicu-monitor(1)\fP, \fBcunicu-relay(1)\fP, \fBcunicu-restart(1)\fP, \fBcunicu-selfupdate(1)\fP, \fBcunicu-signal(1)\fP, \fBcunicu-status(1)\fP, \fBcunicu-stop(1)\fP, \fBcunicu-sync(1)\fP, \fBcunicu-version(1)\fP, \fBcunicu-wg(1)\fP
|
||||
|
||||
@@ -45,7 +45,6 @@ in which WireGuard kernel support has not landed yet.
|
||||
* [cunicu daemon](cunicu_daemon.md) - Start the daemon
|
||||
* [cunicu monitor](cunicu_monitor.md) - Monitor the cunīcu daemon for events
|
||||
* [cunicu relay](cunicu_relay.md) - Start relay API server
|
||||
* [cunicu reload](cunicu_reload.md) - Reload the configuration of the cunīcu daemon
|
||||
* [cunicu restart](cunicu_restart.md) - Restart the cunīcu daemon
|
||||
* [cunicu selfupdate](cunicu_selfupdate.md) - Update the cunīcu binary
|
||||
* [cunicu signal](cunicu_signal.md) - Start gRPC signaling server
|
||||
|
||||
@@ -37,5 +37,6 @@ Manage configuration of a running cunīcu daemon.
|
||||
|
||||
* [cunicu](cunicu.md) - cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.
|
||||
* [cunicu config get](cunicu_config_get.md) - Get current value of a configuration setting
|
||||
* [cunicu config reload](cunicu_config_reload.md) - Reload the configuration of the cunīcu daemon
|
||||
* [cunicu config set](cunicu_config_set.md) - Update the value of a configuration setting
|
||||
|
||||
|
||||
38
docs/usage/md/cunicu_config_reload.md
Normal file
38
docs/usage/md/cunicu_config_reload.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: cunicu config reload
|
||||
sidebar_label: config reload
|
||||
sidebar_class_name: command-name
|
||||
slug: /usage/man/config/reload
|
||||
hide_title: true
|
||||
keywords:
|
||||
- manpage
|
||||
---
|
||||
|
||||
## cunicu config reload
|
||||
|
||||
Reload the configuration of the cunīcu daemon
|
||||
|
||||
```
|
||||
cunicu config reload [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for reload
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-C, --color string Enable colorization of output (one of: auto, always, never) (default "auto")
|
||||
-l, --log-file string path of a file to write logs to
|
||||
-d, --log-level string log level (one of: debug, info, warn, error, dpanic, panic, and fatal) (default "info")
|
||||
-s, --rpc-socket string Unix control and monitoring socket (default "/var/run/cunicu.sock")
|
||||
-v, --verbose int verbosity level
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [cunicu config](cunicu_config.md) - Manage configuration of a running cunīcu daemon.
|
||||
|
||||
@@ -29,24 +29,23 @@ $ cunicu daemon -u -x mysecretpass wg0
|
||||
-b, --backend URL One or more URLs to signaling backends
|
||||
-x, --community passphrase A passphrase shared with other peers in the same community
|
||||
-c, --config filename One or more filenames of configuration files
|
||||
-w, --config-path directory The directory of WireGuard wg/wg-quick configuration files
|
||||
-S, --config-sync Enable synchronization of WireGuard configuration files (default true)
|
||||
-W, --config-watch Watch and synchronize changes to the WireGuard configuration files
|
||||
-D, --domain domain A DNS domain name used for DNS auto-configuration
|
||||
-I, --endpoint-disc Enable ICE endpoint discovery (default true)
|
||||
-E, --endpoint-disc Enable ICE endpoint discovery (default true)
|
||||
-H, --host-sync Enable synchronization of /etc/hosts file (default true)
|
||||
--ice-candidate-type candidate-type Usable candidate-types (one of host, srflx, prflx, relay)
|
||||
--ice-network-type network-type Usable network-types (one of udp4, udp6, tcp4, tcp6)
|
||||
-f, --interface-filter pattern A glob(7) pattern for filtering WireGuard interfaces which this daemon will manage (e.g. "wg*") (default "*")
|
||||
-P, --password password The password for STUN/TURN credentials
|
||||
-p, --password password The password for STUN/TURN credentials
|
||||
-P, --peer-sync Enable peer discovery (default true)
|
||||
-R, --route-sync Enable synchronization of AllowedIPs and Kernel routing table (default true)
|
||||
-T, --route-table int Kernel routing table to use (default 254)
|
||||
-s, --rpc-socket path The path of the unix socket used by other cunicu commands
|
||||
--rpc-wait Wait until first client connected to control socket before continuing start
|
||||
-a, --url URL One or more URLs of STUN and/or TURN servers
|
||||
-U, --username username The username for STUN/TURN credentials
|
||||
-u, --username username The username for STUN/TURN credentials
|
||||
-w, --watch Watch configuration files for changes and apply changes at runtime.
|
||||
-i, --watch-interval duration An interval at which we are periodically polling the kernel for updates on WireGuard interfaces
|
||||
-u, --wg-userspace Use user-space WireGuard implementation for newly created interfaces
|
||||
-U, --wg-userspace Use user-space WireGuard implementation for newly created interfaces
|
||||
-h, --help help for daemon
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user