services: vpn: Deprecate 'openvpn-client-service' & 'openvpn-server-service' procedures.
* doc/guix.texi (VPN Services): Replace 'openvpn-client-service' & 'openvpn-server-service' procedures with their service-type counterparts. * gnu/services/vpn.scm (openvpn-client-service, openvpn-server-service): Deprecate procedure. (openvpn-server-service-type, openvpn-client-service-type): Set default value. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
This commit is contained in:
parent
c6cbce9ad8
commit
eddd9b1240
@ -31859,20 +31859,22 @@ desktop-environment or should be run manually.
|
|||||||
|
|
||||||
It provides a @emph{client} service for your machine to connect to a
|
It provides a @emph{client} service for your machine to connect to a
|
||||||
VPN, and a @emph{server} service for your machine to host a VPN@.
|
VPN, and a @emph{server} service for your machine to host a VPN@.
|
||||||
|
Both @code{openvpn-client-service-type} and
|
||||||
|
@code{openvpn-server-service-type} can be run simultaneously.
|
||||||
|
|
||||||
@deffn {Scheme Procedure} openvpn-client-service @
|
@defvar openvpn-client-service-type
|
||||||
[#:config (openvpn-client-configuration)]
|
Type of the service that runs @command{openvpn}, a VPN daemon, as a client.
|
||||||
|
|
||||||
Return a service that runs @command{openvpn}, a VPN daemon, as a client.
|
The value for this service is a @code{<openvpn-client-configuration>}
|
||||||
@end deffn
|
object.
|
||||||
|
@end defvar
|
||||||
|
|
||||||
@deffn {Scheme Procedure} openvpn-server-service @
|
@defvar openvpn-server-service-type
|
||||||
[#:config (openvpn-server-configuration)]
|
Type of the service that runs @command{openvpn}, a VPN daemon, as a server.
|
||||||
|
|
||||||
Return a service that runs @command{openvpn}, a VPN daemon, as a server.
|
The value for this service is a @code{<openvpn-server-configuration>}
|
||||||
|
object.
|
||||||
Both can be run simultaneously.
|
@end defvar
|
||||||
@end deffn
|
|
||||||
|
|
||||||
@c %automatically generated documentation
|
@c %automatically generated documentation
|
||||||
|
|
||||||
|
@ -39,11 +39,12 @@
|
|||||||
#:use-module (guix records)
|
#:use-module (guix records)
|
||||||
#:use-module (guix gexp)
|
#:use-module (guix gexp)
|
||||||
#:use-module (guix i18n)
|
#:use-module (guix i18n)
|
||||||
|
#:use-module (guix deprecation)
|
||||||
#:use-module (srfi srfi-1)
|
#:use-module (srfi srfi-1)
|
||||||
#:use-module (ice-9 match)
|
#:use-module (ice-9 match)
|
||||||
#:use-module (ice-9 regex)
|
#:use-module (ice-9 regex)
|
||||||
#:export (openvpn-client-service
|
#:export (openvpn-client-service ; deprecated
|
||||||
openvpn-server-service
|
openvpn-server-service ; deprecated
|
||||||
openvpn-client-service-type
|
openvpn-client-service-type
|
||||||
openvpn-server-service-type
|
openvpn-server-service-type
|
||||||
openvpn-client-configuration
|
openvpn-client-configuration
|
||||||
@ -531,7 +532,8 @@ is truncated and rewritten every minute.")
|
|||||||
(service-extension activation-service-type
|
(service-extension activation-service-type
|
||||||
(const %openvpn-activation))))
|
(const %openvpn-activation))))
|
||||||
(description "Run the OpenVPN server, which allows you to
|
(description "Run the OpenVPN server, which allows you to
|
||||||
@emph{host} a @acronym{VPN, virtual private network}.")))
|
@emph{host} a @acronym{VPN, virtual private network}.")
|
||||||
|
(default-value (openvpn-server-configuration))))
|
||||||
|
|
||||||
(define openvpn-client-service-type
|
(define openvpn-client-service-type
|
||||||
(service-type (name 'openvpn-client)
|
(service-type (name 'openvpn-client)
|
||||||
@ -544,12 +546,17 @@ is truncated and rewritten every minute.")
|
|||||||
(const %openvpn-activation))))
|
(const %openvpn-activation))))
|
||||||
(description
|
(description
|
||||||
"Run the OpenVPN client service, which allows you to connect
|
"Run the OpenVPN client service, which allows you to connect
|
||||||
to an existing @acronym{VPN, virtual private network}.")))
|
to an existing @acronym{VPN, virtual private network}.")
|
||||||
|
(default-value (openvpn-client-configuration))))
|
||||||
|
|
||||||
(define* (openvpn-client-service #:key (config (openvpn-client-configuration)))
|
(define-deprecated
|
||||||
|
(openvpn-client-service #:key (config (openvpn-client-configuration)))
|
||||||
|
openvpn-client-service-type
|
||||||
(service openvpn-client-service-type config))
|
(service openvpn-client-service-type config))
|
||||||
|
|
||||||
(define* (openvpn-server-service #:key (config (openvpn-server-configuration)))
|
(define-deprecated
|
||||||
|
(openvpn-server-service #:key (config (openvpn-server-configuration)))
|
||||||
|
openvpn-server-service-type
|
||||||
(service openvpn-server-service-type config))
|
(service openvpn-server-service-type config))
|
||||||
|
|
||||||
(define (generate-openvpn-server-documentation)
|
(define (generate-openvpn-server-documentation)
|
||||||
|
Loading…
Reference in New Issue
Block a user