mirror of
https://git.in.rschanz.org/ryan77627/guix.git
synced 2024-12-25 22:08:16 -05:00
doc: Document 'guix-publish-service-type' instead of 'guix-publish-service'.
* doc/guix.texi (Base Services): Document 'guix-publish-service-type' and 'guix-configuration'. Remove 'guix-publish-service'. (Invoking guix publish): Mention 'guix-publish-service-type'. * gnu/services/base.scm (guix-publish-service): Mark as deprecated. (<guix-configuration>): Export getters.
This commit is contained in:
parent
183303b3ef
commit
f1e900a3b8
2 changed files with 29 additions and 8 deletions
|
@ -6551,9 +6551,9 @@ primarily for debugging a running @command{guix publish} server.
|
||||||
@end table
|
@end table
|
||||||
|
|
||||||
Enabling @command{guix publish} on a GuixSD system is a one-liner: just
|
Enabling @command{guix publish} on a GuixSD system is a one-liner: just
|
||||||
add a call to @code{guix-publish-service} in the @code{services} field
|
instantiate a @code{guix-publish-service-type} service in the @code{services} field
|
||||||
of the @code{operating-system} declaration (@pxref{guix-publish-service,
|
of the @code{operating-system} declaration (@pxref{guix-publish-service-type,
|
||||||
@code{guix-publish-service}}).
|
@code{guix-publish-service-type}}).
|
||||||
|
|
||||||
If you are instead running Guix on a ``foreign distro'', follow these
|
If you are instead running Guix on a ``foreign distro'', follow these
|
||||||
instructions:”
|
instructions:”
|
||||||
|
@ -9007,17 +9007,34 @@ uses the @code{ps2} protocol, which works for both USB and PS/2 mice.
|
||||||
This service is not part of @var{%base-services}.
|
This service is not part of @var{%base-services}.
|
||||||
@end deffn
|
@end deffn
|
||||||
|
|
||||||
@anchor{guix-publish-service}
|
@anchor{guix-publish-service-type}
|
||||||
@deffn {Scheme Procedure} guix-publish-service [#:guix @var{guix}] @
|
@deffn {Scheme Variable} guix-publish-service-type @var{config}
|
||||||
[#:port 80] [#:host "localhost"]
|
This is the service type for @command{guix publish} (@pxref{Invoking
|
||||||
Return a service that runs @command{guix publish} listening on @var{host}
|
guix publish}). @var{config} must be a @code{guix-configuration}
|
||||||
and @var{port} (@pxref{Invoking guix publish}).
|
object, as described below.
|
||||||
|
|
||||||
This assumes that @file{/etc/guix} already contains a signing key pair as
|
This assumes that @file{/etc/guix} already contains a signing key pair as
|
||||||
created by @command{guix archive --generate-key} (@pxref{Invoking guix
|
created by @command{guix archive --generate-key} (@pxref{Invoking guix
|
||||||
archive}). If that is not the case, the service will fail to start.
|
archive}). If that is not the case, the service will fail to start.
|
||||||
@end deffn
|
@end deffn
|
||||||
|
|
||||||
|
@deftp {Data Type} guix-publish-configuration
|
||||||
|
Data type representing the configuration of the @code{guix publish}
|
||||||
|
service.
|
||||||
|
|
||||||
|
@table @asis
|
||||||
|
@item @code{guix} (default: @code{guix})
|
||||||
|
The Guix package to use.
|
||||||
|
|
||||||
|
@item @code{port} (default: @code{80})
|
||||||
|
The TCP port to listen for connections.
|
||||||
|
|
||||||
|
@item @code{host} (default: @code{"localhost"})
|
||||||
|
The host (and thus, network interface) to listen to. Use
|
||||||
|
@code{"0.0.0.0"} to listen on all the network interfaces.
|
||||||
|
@end table
|
||||||
|
@end deftp
|
||||||
|
|
||||||
@anchor{rngd-service}
|
@anchor{rngd-service}
|
||||||
@deffn {Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @
|
@deffn {Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @
|
||||||
[#:device "/dev/hwrng"]
|
[#:device "/dev/hwrng"]
|
||||||
|
|
|
@ -124,6 +124,9 @@ (define-module (gnu services base)
|
||||||
guix-service-type
|
guix-service-type
|
||||||
guix-publish-configuration
|
guix-publish-configuration
|
||||||
guix-publish-configuration?
|
guix-publish-configuration?
|
||||||
|
guix-publish-configuration-guix
|
||||||
|
guix-publish-configuration-port
|
||||||
|
guix-publish-configuration-host
|
||||||
guix-publish-service
|
guix-publish-service
|
||||||
guix-publish-service-type
|
guix-publish-service-type
|
||||||
|
|
||||||
|
@ -1475,6 +1478,7 @@ (define* (guix-publish-service #:key (guix guix) (port 80) (host "localhost"))
|
||||||
This assumes that @file{/etc/guix} already contains a signing key pair as
|
This assumes that @file{/etc/guix} already contains a signing key pair as
|
||||||
created by @command{guix archive --generate-key} (@pxref{Invoking guix
|
created by @command{guix archive --generate-key} (@pxref{Invoking guix
|
||||||
archive}). If that is not the case, the service will fail to start."
|
archive}). If that is not the case, the service will fail to start."
|
||||||
|
;; Deprecated.
|
||||||
(service guix-publish-service-type
|
(service guix-publish-service-type
|
||||||
(guix-publish-configuration (guix guix) (port port) (host host))))
|
(guix-publish-configuration (guix guix) (port port) (host host))))
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue