nixo
/
guix-devel
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: Re-generate openvpn service documentation. 

* doc/guix.texi (VPN Services): Generate documentation with
generate-openvpn-server-documentation and
generate-openvpn-client-documentation helpers and guile 2.1.7.

Signed-off-by: Clément Lassieur <clement@lassieur.org>
This commit is contained in:
Mathieu Othacehe 2017-03-24 11:00:17 +01:00 committed by Clément Lassieur
parent 85ac401acf
commit 1c17a863f6
No known key found for this signature in database
GPG Key ID: 89F96D4808F359C7
1 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
doc/guix.texi
View File

@ -13113,19 +13113,19 @@ Both can be run simultaneously.
Available @code{openvpn-client-configuration} fields are: Available @code{openvpn-client-configuration} fields are:
@deftypevr @code{openvpn-client-configuration} parameter package openvpn @deftypevr {@code{openvpn-client-configuration} parameter} package openvpn
The OpenVPN package. The OpenVPN package.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter string pid-file @deftypevr {@code{openvpn-client-configuration} parameter} string pid-file
The OpenVPN pid file. The OpenVPN pid file.
Defaults to @samp{"/var/run/openvpn/openvpn.pid"}. Defaults to @samp{"/var/run/openvpn/openvpn.pid"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter proto proto @deftypevr {@code{openvpn-client-configuration} parameter} proto proto
The protocol (UDP or TCP) used to open a channel between clients and The protocol (UDP or TCP) used to open a channel between clients and
servers. servers.
@ -13133,21 +13133,21 @@ Defaults to @samp{udp}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter dev dev @deftypevr {@code{openvpn-client-configuration} parameter} dev dev
The device type used to represent the VPN connection. The device type used to represent the VPN connection.
Defaults to @samp{tun}. Defaults to @samp{tun}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter string ca @deftypevr {@code{openvpn-client-configuration} parameter} string ca
The certificate authority to check connections against. The certificate authority to check connections against.
Defaults to @samp{"/etc/openvpn/ca.crt"}. Defaults to @samp{"/etc/openvpn/ca.crt"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter string cert @deftypevr {@code{openvpn-client-configuration} parameter} string cert
The certificate of the machine the daemon is running on. It should be The certificate of the machine the daemon is running on. It should be
signed by the authority given in @code{ca}. signed by the authority given in @code{ca}.
@ -13155,7 +13155,7 @@ Defaults to @samp{"/etc/openvpn/client.crt"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter string key @deftypevr {@code{openvpn-client-configuration} parameter} string key
The key of the machine the daemon is running on. It must be the key whose The key of the machine the daemon is running on. It must be the key whose
certificate is @code{cert}. certificate is @code{cert}.
@ -13163,21 +13163,21 @@ Defaults to @samp{"/etc/openvpn/client.key"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter boolean comp-lzo? @deftypevr {@code{openvpn-client-configuration} parameter} boolean comp-lzo?
Whether to use the lzo compression algorithm. Whether to use the lzo compression algorithm.
Defaults to @samp{#t}. Defaults to @samp{#t}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter boolean persist-key? @deftypevr {@code{openvpn-client-configuration} parameter} boolean persist-key?
Don't re-read key files across SIGUSR1 or --ping-restart. Don't re-read key files across SIGUSR1 or --ping-restart.
Defaults to @samp{#t}. Defaults to @samp{#t}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter boolean persist-tun? @deftypevr {@code{openvpn-client-configuration} parameter} boolean persist-tun?
Don't close and reopen TUN/TAP device or run up/down scripts across Don't close and reopen TUN/TAP device or run up/down scripts across
SIGUSR1 or --ping-restart restarts. SIGUSR1 or --ping-restart restarts.
@ -13185,14 +13185,14 @@ Defaults to @samp{#t}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter number verbosity @deftypevr {@code{openvpn-client-configuration} parameter} number verbosity
Verbosity level. Verbosity level.
Defaults to @samp{3}. Defaults to @samp{3}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter tls-auth-client tls-auth @deftypevr {@code{openvpn-client-configuration} parameter} tls-auth-client tls-auth
Add an additional layer of HMAC authentication on top of the TLS control Add an additional layer of HMAC authentication on top of the TLS control
channel to protect against DoS attacks. channel to protect against DoS attacks.
@ -13200,42 +13200,42 @@ Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter key-usage verify-key-usage? @deftypevr {@code{openvpn-client-configuration} parameter} key-usage verify-key-usage?
Whether to check the server certificate has server usage extension. Whether to check the server certificate has server usage extension.
Defaults to @samp{#t}. Defaults to @samp{#t}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter bind bind? @deftypevr {@code{openvpn-client-configuration} parameter} bind bind?
Bind to a specific local port number. Bind to a specific local port number.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter resolv-retry resolv-retry? @deftypevr {@code{openvpn-client-configuration} parameter} resolv-retry resolv-retry?
Retry resolving server address. Retry resolving server address.
Defaults to @samp{#t}. Defaults to @samp{#t}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-client-configuration} parameter openvpn-remote-list remote @deftypevr {@code{openvpn-client-configuration} parameter} openvpn-remote-list remote
A list of remote servers to connect to. A list of remote servers to connect to.
Defaults to @samp{()}. Defaults to @samp{()}.
Available @code{openvpn-remote-configuration} fields are: Available @code{openvpn-remote-configuration} fields are:
@deftypevr @code{openvpn-remote-configuration} parameter string name @deftypevr {@code{openvpn-remote-configuration} parameter} string name
Server name. Server name.
Defaults to @samp{"my-server"}. Defaults to @samp{"my-server"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-remote-configuration} parameter number port @deftypevr {@code{openvpn-remote-configuration} parameter} number port
Port number the server listens to. Port number the server listens to.
Defaults to @samp{1194}. Defaults to @samp{1194}.
@ -13249,19 +13249,19 @@ Defaults to @samp{1194}.
Available @code{openvpn-server-configuration} fields are: Available @code{openvpn-server-configuration} fields are:
@deftypevr @code{openvpn-server-configuration} parameter package openvpn @deftypevr {@code{openvpn-server-configuration} parameter} package openvpn
The OpenVPN package. The OpenVPN package.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter string pid-file @deftypevr {@code{openvpn-server-configuration} parameter} string pid-file
The OpenVPN pid file. The OpenVPN pid file.
Defaults to @samp{"/var/run/openvpn/openvpn.pid"}. Defaults to @samp{"/var/run/openvpn/openvpn.pid"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter proto proto @deftypevr {@code{openvpn-server-configuration} parameter} proto proto
The protocol (UDP or TCP) used to open a channel between clients and The protocol (UDP or TCP) used to open a channel between clients and
servers. servers.
@ -13269,21 +13269,21 @@ Defaults to @samp{udp}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter dev dev @deftypevr {@code{openvpn-server-configuration} parameter} dev dev
The device type used to represent the VPN connection. The device type used to represent the VPN connection.
Defaults to @samp{tun}. Defaults to @samp{tun}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter string ca @deftypevr {@code{openvpn-server-configuration} parameter} string ca
The certificate authority to check connections against. The certificate authority to check connections against.
Defaults to @samp{"/etc/openvpn/ca.crt"}. Defaults to @samp{"/etc/openvpn/ca.crt"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter string cert @deftypevr {@code{openvpn-server-configuration} parameter} string cert
The certificate of the machine the daemon is running on. It should be The certificate of the machine the daemon is running on. It should be
signed by the authority given in @code{ca}. signed by the authority given in @code{ca}.
@ -13291,7 +13291,7 @@ Defaults to @samp{"/etc/openvpn/client.crt"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter string key @deftypevr {@code{openvpn-server-configuration} parameter} string key
The key of the machine the daemon is running on. It must be the key whose The key of the machine the daemon is running on. It must be the key whose
certificate is @code{cert}. certificate is @code{cert}.
@ -13299,21 +13299,21 @@ Defaults to @samp{"/etc/openvpn/client.key"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter boolean comp-lzo? @deftypevr {@code{openvpn-server-configuration} parameter} boolean comp-lzo?
Whether to use the lzo compression algorithm. Whether to use the lzo compression algorithm.
Defaults to @samp{#t}. Defaults to @samp{#t}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter boolean persist-key? @deftypevr {@code{openvpn-server-configuration} parameter} boolean persist-key?
Don't re-read key files across SIGUSR1 or --ping-restart. Don't re-read key files across SIGUSR1 or --ping-restart.
Defaults to @samp{#t}. Defaults to @samp{#t}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter boolean persist-tun? @deftypevr {@code{openvpn-server-configuration} parameter} boolean persist-tun?
Don't close and reopen TUN/TAP device or run up/down scripts across Don't close and reopen TUN/TAP device or run up/down scripts across
SIGUSR1 or --ping-restart restarts. SIGUSR1 or --ping-restart restarts.
@ -13321,14 +13321,14 @@ Defaults to @samp{#t}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter number verbosity @deftypevr {@code{openvpn-server-configuration} parameter} number verbosity
Verbosity level. Verbosity level.
Defaults to @samp{3}. Defaults to @samp{3}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter tls-auth-server tls-auth @deftypevr {@code{openvpn-server-configuration} parameter} tls-auth-server tls-auth
Add an additional layer of HMAC authentication on top of the TLS control Add an additional layer of HMAC authentication on top of the TLS control
channel to protect against DoS attacks. channel to protect against DoS attacks.
@ -13336,56 +13336,56 @@ Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter number port @deftypevr {@code{openvpn-server-configuration} parameter} number port
Specifies the port number on which the server listens. Specifies the port number on which the server listens.
Defaults to @samp{1194}. Defaults to @samp{1194}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter ip-mask server @deftypevr {@code{openvpn-server-configuration} parameter} ip-mask server
An ip and mask specifying the subnet inside the virtual network. An ip and mask specifying the subnet inside the virtual network.
Defaults to @samp{"10.8.0.0 255.255.255.0"}. Defaults to @samp{"10.8.0.0 255.255.255.0"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter cidr6 server-ipv6 @deftypevr {@code{openvpn-server-configuration} parameter} cidr6 server-ipv6
A CIDR notation specifying the IPv6 subnet inside the virtual network. A CIDR notation specifying the IPv6 subnet inside the virtual network.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter string dh @deftypevr {@code{openvpn-server-configuration} parameter} string dh
The Diffie-Hellman parameters file. The Diffie-Hellman parameters file.
Defaults to @samp{"/etc/openvpn/dh2048.pem"}. Defaults to @samp{"/etc/openvpn/dh2048.pem"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter string ifconfig-pool-persist @deftypevr {@code{openvpn-server-configuration} parameter} string ifconfig-pool-persist
The file that records client IPs. The file that records client IPs.
Defaults to @samp{"/etc/openvpn/ipp.txt"}. Defaults to @samp{"/etc/openvpn/ipp.txt"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter gateway redirect-gateway? @deftypevr {@code{openvpn-server-configuration} parameter} gateway redirect-gateway?
When true, the server will act as a gateway for its clients. When true, the server will act as a gateway for its clients.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter boolean client-to-client? @deftypevr {@code{openvpn-server-configuration} parameter} boolean client-to-client?
When true, clients are alowed to talk to each other inside the VPN. When true, clients are alowed to talk to each other inside the VPN.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter keepalive keepalive @deftypevr {@code{openvpn-server-configuration} parameter} keepalive keepalive
Causes ping-like messages to be sent back and forth over the link so Causes ping-like messages to be sent back and forth over the link so
that each side knows when the other side has gone down. @code{keepalive} that each side knows when the other side has gone down. @code{keepalive}
requires a pair. The first element is the period of the ping sending, requires a pair. The first element is the period of the ping sending,
@ -13394,14 +13394,14 @@ down.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter number max-clients @deftypevr {@code{openvpn-server-configuration} parameter} number max-clients
The maximum number of clients. The maximum number of clients.
Defaults to @samp{100}. Defaults to @samp{100}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter string status @deftypevr {@code{openvpn-server-configuration} parameter} string status
The status file. This file shows a small report on current connection. The status file. This file shows a small report on current connection.
It is trunkated and rewritten every minute. It is trunkated and rewritten every minute.
@ -13409,28 +13409,28 @@ Defaults to @samp{"/var/run/openvpn/status"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-server-configuration} parameter openvpn-ccd-list client-config-dir @deftypevr {@code{openvpn-server-configuration} parameter} openvpn-ccd-list client-config-dir
The list of configuration for some clients. The list of configuration for some clients.
Defaults to @samp{()}. Defaults to @samp{()}.
Available @code{openvpn-ccd-configuration} fields are: Available @code{openvpn-ccd-configuration} fields are:
@deftypevr @code{openvpn-ccd-configuration} parameter string name @deftypevr {@code{openvpn-ccd-configuration} parameter} string name
Client name. Client name.
Defaults to @samp{"client"}. Defaults to @samp{"client"}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-ccd-configuration} parameter ip-mask iroute @deftypevr {@code{openvpn-ccd-configuration} parameter} ip-mask iroute
Client own network Client own network
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@deftypevr @code{openvpn-ccd-configuration} parameter ip-mask ifconfig-push @deftypevr {@code{openvpn-ccd-configuration} parameter} ip-mask ifconfig-push
Client VPN IP. Client VPN IP.
Defaults to @samp{#f}. Defaults to @samp{#f}.