From patchwork Thu Feb 16 15:53:55 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Janneke Nieuwenhuizen X-Patchwork-Id: 47005 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id D625F16919; Thu, 16 Feb 2023 15:55:32 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-3.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS, URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 982031690B for ; Thu, 16 Feb 2023 15:55:31 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pSgbB-0001cH-57; Thu, 16 Feb 2023 10:55:05 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pSgbA-0001br-EX for guix-patches@gnu.org; Thu, 16 Feb 2023 10:55:04 -0500 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pSgbA-00028f-5B for guix-patches@gnu.org; Thu, 16 Feb 2023 10:55:04 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pSgb9-0007rU-Qb for guix-patches@gnu.org; Thu, 16 Feb 2023 10:55:03 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#61483] [PATCH v2 5/5] DRAFT doc: Document Home Shepherd Services. Resent-From: "Jan (janneke) Nieuwenhuizen" Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Thu, 16 Feb 2023 15:55:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 61483 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 61483@debbugs.gnu.org Received: via spool by 61483-submit@debbugs.gnu.org id=B61483.167656285230129 (code B ref 61483); Thu, 16 Feb 2023 15:55:03 +0000 Received: (at 61483) by debbugs.gnu.org; 16 Feb 2023 15:54:12 +0000 Received: from localhost ([127.0.0.1]:37446 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pSgaJ-0007pq-Pp for submit@debbugs.gnu.org; Thu, 16 Feb 2023 10:54:12 -0500 Received: from eggs.gnu.org ([209.51.188.92]:45354) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pSgaF-0007oZ-Ib for 61483@debbugs.gnu.org; Thu, 16 Feb 2023 10:54:09 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pSga9-0001rO-3P; Thu, 16 Feb 2023 10:54:01 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:References:In-Reply-To:Date:Subject:To: From; bh=Nn7j/M8bUio0dzRQN4+NLfKH4ZNvCjPyZRnn3dgIYeI=; b=BN9cq9jhIbcgQ09fL78a npPojfd9LvJ0f9vNmE5+Xl7fsmfP6F5JoFcChNywcNCsqd0AkQ1KpL+SVvjAc4JLsgBO/StBuoIQJ ijU9GQepVP/iJWXzWSIPzRyqHSzrOLaW1EDQemoVnFtrP7bsadbVa51jBoBhSbYjCQeo2SGqXSB6G CPqJdvPNKPd1uqFqPl8Nkh5vTeZ98uAznq1x/otSX0c15ubWNDCU1l6NFNQ+d8UDuZoDqjt5zqggC QX/XwNf4dbvs7lJrXOGqG+Sf8B7F+JtrDmrwsv6r5RCcJFtdrwy8Bl0O4+ERIDjnEYYY8Im1KggeP yCW2X5VGmu8Ftw==; Received: from 2a02-a462-da03-1-2701-7f81-a736-4607.fixed6.kpn.net ([2a02:a462:da03:1:2701:7f81:a736:4607] helo=drakenpad.fritz.box) by fencepost.gnu.org with esmtpa (Exim 4.90_1) (envelope-from ) id 1pSga8-0005sK-Ma; Thu, 16 Feb 2023 10:54:00 -0500 From: "Jan (janneke) Nieuwenhuizen" Date: Thu, 16 Feb 2023 16:53:55 +0100 Message-Id: <20230216155355.11106-5-janneke@gnu.org> X-Mailer: git-send-email 2.38.1 In-Reply-To: <20230216155355.11106-1-janneke@gnu.org> References: <20230216155355.11106-1-janneke@gnu.org> MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * doc/guix.texi (Shepherd Home Services): New subsubsection. --- doc/guix.texi | 124 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 123 insertions(+), 1 deletion(-) diff --git a/doc/guix.texi b/doc/guix.texi index 784114f0bb..a5a62010b6 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -36,7 +36,7 @@ Copyright @copyright{} 2016, 2017, 2018, 2021 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021, 2022 Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright @copyright{} 2016, 2017 Nikita Gillmann@* -Copyright @copyright{} 2016, 2017, 2018, 2019, 2020 Jan Nieuwenhuizen@* +Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2023 Jan Nieuwenhuizen@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Julien Lepiller@* Copyright @copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Christopher Baines@* @@ -41285,6 +41285,128 @@ mechanism instead (@pxref{Shepherd Services}). @end table @end deftp +@menu +* Shepherd Home Services:: +@end menu + +@node Shepherd Home Services +@subsubsection e Shepherd Home Services + +The @code{(gnu home services shepherd-xyz)} module provides serveral +home shepherd services. + +@defvr {Scheme Variable} home-git-daemon-service-type +This is the type of the @code{git daemon} home service, whose value is an +@code{home-git-daemon-configuration} object. +@end defvr + +@deftp {Data Type} home-git-daemon-configuration +Available @code{home-git-daemon-configuration} fields are: + +@table @asis +@item @code{git} (default: @code{git}) (type: file-like) +The git package to use. + +@item @code{root} (default: @file{@env{XDG_DATA_HOME}/git-daemon}) (type: string) +The git deamon's base directory. + +@item @code{export-all?} (default: @code{#f}) +Whether to allow access for all Git repositories, even if they do not +have the @file{git-daemon-export-ok} file. + +@item @code{base-path} (default: @file{/srv/git}) +Whether to remap all the path requests as relative to the given path. +If you run @command{git daemon} with @code{(base-path "/srv/git")} on +@samp{example.com}, then if you later try to pull +@indicateurl{git://example.com/hello.git}, git daemon will interpret the +path as @file{/srv/git/hello.git}. + +@item @code{user-path} (default: @code{#f}) +Whether to allow @code{~user} notation to be used in requests. When +specified with empty string, requests to +@indicateurl{git://host/~alice/foo} is taken as a request to access +@code{foo} repository in the home directory of user @code{alice}. If +@code{(user-path "@var{path}")} is specified, the same request is taken +as a request to access @file{@var{path}/foo} repository in the home +directory of user @code{alice}. + +@item @code{listen} (default: @code{'()}) +Whether to listen on specific IP addresses or hostnames, defaults to +all. + +@item @code{port} (default: @code{#f}) +Whether to listen on an alternative port, which defaults to 9418. + +@item @code{whitelist} (default: @code{'()}) +If not empty, only allow access to this list of directories. + +@item @code{extra-options} (default: @code{'()}) +Extra options will be passed to @command{git daemon}, please run +@command{man git-daemon} for more information. + +@end table +@end deftp + +@defvr {Scheme Variable} home-kodi-service-type +This is the type of the @code{git daemon} home service, whose value is an +@code{home-kodi-configuration} object. +@end defvr + +@deftp {Data Type} home-kodi-configuration +Available @code{home-kodi-configuration} fields are: + +@table @asis +@item @code{git} (default: @code{git}) (type: file-like) +The git package to use. + +@item @code{extra-options} (default: @code{'()}) +Extra options will be passed to @command{kodi}, please run @command{man +kodi} for more information. + +@end table +@end deftp + +@defvr {Scheme Variable} home-ssh-agent-service-type +This is the type of the @code{git daemon} home service, whose value is an +@code{home-ssh-agent-configuration} object. +@end defvr + +@deftp {Data Type} home-ssh-agent-configuration +Available @code{home-ssh-agent-configuration} fields are: + +@table @asis +@item @code{git} (default: @code{git}) (type: file-like) +The git package to use. + +@item @code{socket-dir} (default: @code{@env{XDG_RUNTIME_DIR}/ssh-agent"}) (type: string) +The directory to write the ssh-agent's @file{socket} file. + +@item @code{extra-options} (default: @code{'()}) +Extra options will be passed to @command{ssh-agent}, please run +@command{man ssh-agent} for more information. + +@end table +@end deftp + +@defvr {Scheme Variable} home-znc-service-type +This is the type of the @code{git daemon} home service, whose value is an +@code{home-znc-configuration} object. +@end defvr + +@deftp {Data Type} home-znc-configuration +Available @code{home-znc-configuration} fields are: + +@table @asis +@item @code{git} (default: @code{git}) (type: file-like) +The git package to use. + +@item @code{extra-options} (default: @code{'()}) +Extra options will be passed to @command{znc}, please run @command{man +znc} for more information. + +@end table +@end deftp + @node Secure Shell @subsection Secure Shell