fix spelling of cunicu

Signed-off-by: Steffen Vogel <post@steffenvogel.de>
This commit is contained in:
Steffen Vogel
2022-09-16 12:29:51 +02:00
parent 8960370411
commit fec86a9e12
3 changed files with 14 additions and 10 deletions

View File

@@ -138,7 +138,7 @@ jobs:
GOARCH: ${{ matrix.host_arch }} GOARCH: ${{ matrix.host_arch }}
run: make install-deps run: make install-deps
- name: Run cunicu build - name: Run cunīcu build
run: make cunicu run: make cunicu
- name: Run vet - name: Run vet

View File

@@ -4,7 +4,7 @@ sidebar_position: 7
# Configuration # Configuration
This page describes the ways of configuring the cunicu daemon (`cunicu daemon`). This page describes the ways of configuring the cunīcu daemon (`cunicu daemon`).
## Command Line Flags ## Command Line Flags
@@ -16,7 +16,7 @@ A full overview is available in its [manpage](./usage/md/cunicu_daemon.md).
Alternatively a configuration file can be used for a persistent configuration: Alternatively a configuration file can be used for a persistent configuration:
```yaml title="cunicu.yaml" ```yaml title="cunicu.yaml"
# An interval at which cunicu will periodically check for added, # An interval at which cunīcu will periodically check for added,
# removed or modified WireGuard interfaces. # removed or modified WireGuard interfaces.
watch_interval: 1s watch_interval: 1s
@@ -37,7 +37,7 @@ rpc:
# and monitoring of the cunicu daemon. # and monitoring of the cunicu daemon.
socket: /var/run/cunicu.sock socket: /var/run/cunicu.sock
# Start of cunicu daemon will block until # Start of cunīcu daemon will block until
# its unblocked via the control socket. # its unblocked via the control socket.
# Mostly useful for testing automation # Mostly useful for testing automation
wait: false wait: false
@@ -46,7 +46,7 @@ rpc:
## Hook callbacks ## Hook callbacks
# #
# Hook callback can be used to invoke subprocesses # Hook callback can be used to invoke subprocesses
# or web-hooks on certain events within cunicu. # or web-hooks on certain events within cunīcu.
hooks: hooks:
# An 'exec' hook spawn a subprocess for each event. # An 'exec' hook spawn a subprocess for each event.
@@ -99,7 +99,7 @@ wireguard:
# A range constraint for an automatically assigned # A range constraint for an automatically assigned
# selected listen port. # selected listen port.
# If the interface has no listen port specified, cunicu # If the interface has no listen port specified, cunīcu
# will use the first available port from this range. # will use the first available port from this range.
listen_port_range: listen_port_range:
min: 52820 min: 52820
@@ -131,6 +131,10 @@ wireguard:
# public-key cryptography, for post-quantum resistance. # public-key cryptography, for post-quantum resistance.
preshared_key: zu86NBVsWOU3cx4UKOQ6MgNj3gv8GXsV9ATzSemdqlI= preshared_key: zu86NBVsWOU3cx4UKOQ6MgNj3gv8GXsV9ATzSemdqlI=
# A preshared passphrase which is used to derive a preshared key.
# cunīcu is using Argon2id as the key derivation function.
preshared_key_passphrase:
# An endpoint IP or hostname, followed by a colon, # An endpoint IP or hostname, followed by a colon,
# and then a port number. This endpoint will be updated # and then a port number. This endpoint will be updated
# automatically to the most recent source IP address and # automatically to the most recent source IP address and

View File

@@ -1,4 +1,4 @@
# An interval at which cunicu will periodically check for added, # An interval at which cunīcu will periodically check for added,
# removed or modified WireGuard interfaces. # removed or modified WireGuard interfaces.
watch_interval: 1s watch_interval: 1s
@@ -19,7 +19,7 @@ rpc:
# and monitoring of the cunicu daemon. # and monitoring of the cunicu daemon.
socket: /var/run/cunicu.sock socket: /var/run/cunicu.sock
# Start of cunicu daemon will block until # Start of cunīcu daemon will block until
# its unblocked via the control socket. # its unblocked via the control socket.
# Mostly useful for testing automation # Mostly useful for testing automation
wait: false wait: false
@@ -28,7 +28,7 @@ rpc:
## Hook callbacks ## Hook callbacks
# #
# Hook callback can be used to invoke subprocesses # Hook callback can be used to invoke subprocesses
# or web-hooks on certain events within cunicu. # or web-hooks on certain events within cunīcu.
hooks: hooks:
# An 'exec' hook spawn a subprocess for each event. # An 'exec' hook spawn a subprocess for each event.
@@ -81,7 +81,7 @@ wireguard:
# A range constraint for an automatically assigned # A range constraint for an automatically assigned
# selected listen port. # selected listen port.
# If the interface has no listen port specified, cunicu # If the interface has no listen port specified, cunīcu
# will use the first available port from this range. # will use the first available port from this range.
listen_port_range: listen_port_range:
min: 52820 min: 52820