>From 80d872ae8362b5e769c463599b03ddb0fb7482d2 Mon Sep 17 00:00:00 2001 From: Andy Wingo Date: Thu, 27 Apr 2017 10:59:44 +0200 Subject: [PATCH 4/5] doc: Create Version Control Services section. * doc/guix.texi (Version Control Services): Move to its own node. --- doc/guix.texi | 124 ++++++++++++++++++++++++++++++---------------------------- 1 file changed, 64 insertions(+), 60 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index eeacf8833..cae497df3 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -220,6 +220,7 @@ Services * Network File System:: NFS related services. * Continuous Integration:: The Cuirass service. * Power management Services:: The TLP tool. +* Version Control Services:: Providing remote access to Git repositories. * Miscellaneous Services:: Other services. Defining Services @@ -8611,6 +8612,7 @@ declaration. * Network File System:: NFS related services. * Continuous Integration:: The Cuirass service. * Power management Services:: The TLP tool. +* Version Control Services:: Providing remote access to Git repositories. * Miscellaneous Services:: Other services. @end menu @@ -14639,6 +14641,68 @@ Defaults to @samp{#f}. @end deftypevr address@hidden Version Control Services address@hidden Version Control Services + +The @code{(gnu services version-control)} module provides a service to +allow remote access to local Git repositories. + address@hidden {Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)] + +Return a service that runs @command{git daemon}, a simple TCP server to +expose repositories over the Git protocol for anonymous access. + +The optional @var{config} argument should be a address@hidden} object, by default it allows read-only +access to address@hidden creating the magic file +"git-daemon-export-ok" in the repository directory.} repositories under address@hidden/srv/git}. + address@hidden deffn + address@hidden {Data Type} git-daemon-configuration +Data type representing the configuration for @code{git-daemon-service}. + address@hidden @asis address@hidden @code{package} (default: @var{git}) +Package object of the Git distributed version control system. + address@hidden @code{export-all?} (default: @var{#f}) +Whether to allow access for all Git repositories, even if they do not +have the @file{git-daemon-export-ok} file. + address@hidden @code{base-path} (default: @file{/srv/git}) +Whether to remap all the path requests as relative to the given path. +If you run git daemon with @var{(base-path "/srv/git")} on example.com, +then if you later try to pull @code{git://example.com/hello.git}, git +daemon will interpret the path as @code{/srv/git/hello.git}. + address@hidden @code{user-path} (default: @var{#f}) +Whether to allow @code{~user} notation to be used in requests. When +specified with empty string, requests to @code{git://host/~alice/foo} is +taken as a request to access @code{foo} repository in the home directory +of user @code{alice}. If @var{(user-path "path")} is specified, the +same request is taken as a request to access @code{path/foo} repository +in the home directory of user @code{alice}. + address@hidden @code{listen} (default: @var{'()}) +Whether to listen on specific IP addresses or hostnames, defaults to +all. + address@hidden @code{port} (default: @var{#f}) +Whether to listen on an alternative port, which defaults to 9418. + address@hidden @code{whitelist} (default: @var{'()}) +If not empty, only allow access to this list of directories. + address@hidden @code{extra-options} (default: @var{'()}) +Extra options will be passed to @code{git daemon}, please run address@hidden git-daemon} for more information. + address@hidden table address@hidden deftp + + @node Miscellaneous Services @subsubsection Miscellaneous Services @@ -14771,66 +14835,6 @@ The following is an example @code{dicod-service} configuration. %dicod-database:gcide)))) @end example address@hidden Version Control - -The @code{(gnu services version-control)} module provides the following services: - address@hidden Git daemon service - address@hidden {Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)] - -Return a service that runs @command{git daemon}, a simple TCP server to -expose repositories over the Git protocol for anonymous access. - -The optional @var{config} argument should be a address@hidden} object, by default it allows read-only -access to address@hidden creating the magic file -"git-daemon-export-ok" in the repository directory.} repositories under address@hidden/srv/git}. - address@hidden deffn - address@hidden {Data Type} git-daemon-configuration -Data type representing the configuration for @code{git-daemon-service}. - address@hidden @asis address@hidden @code{package} (default: @var{git}) -Package object of the Git distributed version control system. - address@hidden @code{export-all?} (default: @var{#f}) -Whether to allow access for all Git repositories, even if they do not -have the @file{git-daemon-export-ok} file. - address@hidden @code{base-path} (default: @file{/srv/git}) -Whether to remap all the path requests as relative to the given path. -If you run git daemon with @var{(base-path "/srv/git")} on example.com, -then if you later try to pull @code{git://example.com/hello.git}, git -daemon will interpret the path as @code{/srv/git/hello.git}. - address@hidden @code{user-path} (default: @var{#f}) -Whether to allow @code{~user} notation to be used in requests. When -specified with empty string, requests to @code{git://host/~alice/foo} is -taken as a request to access @code{foo} repository in the home directory -of user @code{alice}. If @var{(user-path "path")} is specified, the -same request is taken as a request to access @code{path/foo} repository -in the home directory of user @code{alice}. - address@hidden @code{listen} (default: @var{'()}) -Whether to listen on specific IP addresses or hostnames, defaults to -all. - address@hidden @code{port} (default: @var{#f}) -Whether to listen on an alternative port, which defaults to 9418. - address@hidden @code{whitelist} (default: @var{'()}) -If not empty, only allow access to this list of directories. - address@hidden @code{extra-options} (default: @var{'()}) -Extra options will be passed to @code{git daemon}, please run address@hidden git-daemon} for more information. - address@hidden table address@hidden deftp @node Setuid Programs @subsection Setuid Programs -- 2.12.2