mirror of
https://git.in.rschanz.org/ryan77627/guix.git
synced 2024-11-14 19:05:10 -05:00
a222b734b3
* gnu/services/version-control.scm (git-daemon-service-type) [description, default-value]: New fields. (cgit-service-type)[default-value]: New field. * po/packages/POTFILES.in: Add version-control.scm.
315 lines
12 KiB
Scheme
315 lines
12 KiB
Scheme
;;; GNU Guix --- Functional package management for GNU
|
||
;;; Copyright © 2016 ng0 <ng0@we.make.ritual.n0.is>
|
||
;;; Copyright © 2016 Sou Bunnbu <iyzsong@member.fsf.org>
|
||
;;; Copyright © 2017 Oleg Pykhalov <go.wigust@gmail.com>
|
||
;;;
|
||
;;; This file is part of GNU Guix.
|
||
;;;
|
||
;;; GNU Guix is free software; you can redistribute it and/or modify it
|
||
;;; under the terms of the GNU General Public License as published by
|
||
;;; the Free Software Foundation; either version 3 of the License, or (at
|
||
;;; your option) any later version.
|
||
;;;
|
||
;;; GNU Guix is distributed in the hope that it will be useful, but
|
||
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
;;; GNU General Public License for more details.
|
||
;;;
|
||
;;; You should have received a copy of the GNU General Public License
|
||
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
|
||
|
||
(define-module (gnu services version-control)
|
||
#:use-module (gnu services)
|
||
#:use-module (gnu services base)
|
||
#:use-module (gnu services shepherd)
|
||
#:use-module (gnu services web)
|
||
#:use-module (gnu system shadow)
|
||
#:use-module (gnu packages version-control)
|
||
#:use-module (gnu packages admin)
|
||
#:use-module (guix records)
|
||
#:use-module (guix gexp)
|
||
#:use-module (guix store)
|
||
#:use-module (srfi srfi-1)
|
||
#:use-module (srfi srfi-26)
|
||
#:use-module (ice-9 match)
|
||
#:export (git-daemon-service
|
||
git-daemon-service-type
|
||
git-daemon-configuration
|
||
git-daemon-configuration?
|
||
|
||
<cgit-configuration-file>
|
||
cgit-configuration-file
|
||
cgit-configuration-file?
|
||
cgit-configuration-file-css
|
||
cgit-configuration-file-logo
|
||
cgit-configuration-file-robots
|
||
cgit-configuration-file-virtual-root
|
||
cgit-configuration-file-repository-directory
|
||
|
||
<cgit-configuration>
|
||
cgit-configuration
|
||
cgit-configuration?
|
||
cgit-configuration-config-file
|
||
cgit-configuration-package
|
||
|
||
%cgit-configuration-nginx
|
||
cgit-configuration-nginx-config
|
||
|
||
cgit-service-type
|
||
|
||
git-http-configuration
|
||
git-http-configuration?
|
||
git-http-nginx-location-configuration))
|
||
|
||
;;; Commentary:
|
||
;;;
|
||
;;; Version Control related services.
|
||
;;;
|
||
;;; Code:
|
||
|
||
|
||
;;;
|
||
;;; Git daemon.
|
||
;;;
|
||
|
||
(define-record-type* <git-daemon-configuration>
|
||
git-daemon-configuration
|
||
make-git-daemon-configuration
|
||
git-daemon-configuration?
|
||
(package git-daemon-configuration-package ;package
|
||
(default git))
|
||
(export-all? git-daemon-configuration-export-all ;boolean
|
||
(default #f))
|
||
(base-path git-daemon-configuration-base-path ;string | #f
|
||
(default "/srv/git"))
|
||
(user-path git-daemon-configuration-user-path ;string | #f
|
||
(default #f))
|
||
(listen git-daemon-configuration-listen ;list of string
|
||
(default '()))
|
||
(port git-daemon-configuration-port ;number | #f
|
||
(default #f))
|
||
(whitelist git-daemon-configuration-whitelist ;list of string
|
||
(default '()))
|
||
(extra-options git-daemon-configuration-extra-options ;list of string
|
||
(default '())))
|
||
|
||
(define git-daemon-shepherd-service
|
||
(match-lambda
|
||
(($ <git-daemon-configuration>
|
||
package export-all? base-path user-path
|
||
listen port whitelist extra-options)
|
||
(let* ((git (file-append package "/bin/git"))
|
||
(command `(,git
|
||
"daemon" "--syslog" "--reuseaddr"
|
||
,@(if export-all?
|
||
'("--export-all")
|
||
'())
|
||
,@(if base-path
|
||
`(,(string-append "--base-path=" base-path))
|
||
'())
|
||
,@(if user-path
|
||
`(,(string-append "--user-path=" user-path))
|
||
'())
|
||
,@(map (cut string-append "--listen=" <>) listen)
|
||
,@(if port
|
||
`(,(string-append
|
||
"--port=" (number->string port)))
|
||
'())
|
||
,@extra-options
|
||
,@whitelist)))
|
||
(list (shepherd-service
|
||
(documentation "Run the git-daemon.")
|
||
(requirement '(networking))
|
||
(provision '(git-daemon))
|
||
(start #~(make-forkexec-constructor '#$command
|
||
#:user "git-daemon"
|
||
#:group "git-daemon"))
|
||
(stop #~(make-kill-destructor))))))))
|
||
|
||
(define %git-daemon-accounts
|
||
;; User account and group for git-daemon.
|
||
(list (user-group
|
||
(name "git-daemon")
|
||
(system? #t))
|
||
(user-account
|
||
(name "git-daemon")
|
||
(system? #t)
|
||
(group "git-daemon")
|
||
(comment "Git daemon user")
|
||
(home-directory "/var/empty")
|
||
(shell (file-append shadow "/sbin/nologin")))))
|
||
|
||
(define (git-daemon-activation config)
|
||
"Return the activation gexp for git-daemon using CONFIG."
|
||
(let ((base-path (git-daemon-configuration-base-path config)))
|
||
#~(begin
|
||
(use-modules (guix build utils))
|
||
;; Create the 'base-path' directory when it's not '#f'.
|
||
(and=> #$base-path mkdir-p))))
|
||
|
||
(define git-daemon-service-type
|
||
(service-type
|
||
(name 'git-daemon)
|
||
(extensions
|
||
(list (service-extension shepherd-root-service-type
|
||
git-daemon-shepherd-service)
|
||
(service-extension account-service-type
|
||
(const %git-daemon-accounts))
|
||
(service-extension activation-service-type
|
||
git-daemon-activation)))
|
||
(description
|
||
"Expose Git respositories over the insecure @code{git://} TCP-based
|
||
protocol.")
|
||
(default-value (git-daemon-configuration))))
|
||
|
||
(define* (git-daemon-service #:key (config (git-daemon-configuration)))
|
||
"Return a service that runs @command{git daemon}, a simple TCP server to
|
||
expose repositories over the Git protocol for annoymous access.
|
||
|
||
The optional @var{config} argument should be a
|
||
@code{<git-daemon-configuration>} object, by default it allows read-only
|
||
access to exported repositories under @file{/srv/git}."
|
||
(service git-daemon-service-type config))
|
||
|
||
|
||
;;;
|
||
;;; Cgit
|
||
;;;
|
||
|
||
(define-record-type* <cgit-configuration-file>
|
||
cgit-configuration-file
|
||
make-cgit-configuration-file
|
||
cgit-configuration-file?
|
||
(css cgit-configuration-file-css ; string
|
||
(default "/share/cgit/cgit.css"))
|
||
(logo cgit-configuration-file-logo ; string
|
||
(default "/share/cgit/cgit.png"))
|
||
(robots cgit-configuration-file-robots ; list
|
||
(default '("noindex" "nofollow")))
|
||
(virtual-root cgit-configuration-file-virtual-root ; string
|
||
(default "/"))
|
||
(repository-directory cgit-configuration-file-repository-directory ; string
|
||
(default "/srv/git")))
|
||
|
||
(define (cgit-configuration-robots-string robots)
|
||
(string-join robots ", "))
|
||
|
||
(define-gexp-compiler (cgit-configuration-file-compiler
|
||
(file <cgit-configuration-file>) system target)
|
||
(match file
|
||
(($ <cgit-configuration-file> css logo
|
||
robots virtual-root repository-directory)
|
||
(apply text-file* "cgitrc"
|
||
(letrec-syntax ((option (syntax-rules ()
|
||
((_ key value)
|
||
(if value
|
||
`(,key "=" ,value "\n")
|
||
'()))))
|
||
(key/value (syntax-rules ()
|
||
((_ (key value) rest ...)
|
||
(append (option key value)
|
||
(key/value rest ...)))
|
||
((_)
|
||
'()))))
|
||
(key/value ("css" css)
|
||
("logo" logo)
|
||
("robots" (cgit-configuration-robots-string robots))
|
||
("virtual-root" virtual-root)
|
||
("scan-path" repository-directory)))))))
|
||
|
||
(define %cgit-configuration-nginx
|
||
(list
|
||
(nginx-server-configuration
|
||
(root cgit)
|
||
(locations
|
||
(list
|
||
(nginx-location-configuration
|
||
(uri "@cgit")
|
||
(body '("fastcgi_param SCRIPT_FILENAME $document_root/lib/cgit/cgit.cgi;"
|
||
"fastcgi_param PATH_INFO $uri;"
|
||
"fastcgi_param QUERY_STRING $args;"
|
||
"fastcgi_param HTTP_HOST $server_name;"
|
||
"fastcgi_pass 127.0.0.1:9000;")))))
|
||
(try-files (list "$uri" "@cgit"))
|
||
(https-port #f)
|
||
(ssl-certificate #f)
|
||
(ssl-certificate-key #f))))
|
||
|
||
(define-record-type* <cgit-configuration>
|
||
cgit-configuration make-cgit-configuration
|
||
cgit-configuration?
|
||
(config-file cgit-configuration-config-file
|
||
(default (cgit-configuration-file)))
|
||
(package cgit-configuration-package
|
||
(default cgit))
|
||
(nginx cgit-configuration-nginx
|
||
(default %cgit-configuration-nginx)))
|
||
|
||
(define (cgit-activation config)
|
||
;; Cgit compiled with default configuration path
|
||
#~(begin
|
||
(use-modules (guix build utils))
|
||
(mkdir-p "/var/cache/cgit")
|
||
(copy-file #$(cgit-configuration-config-file config) "/etc/cgitrc")))
|
||
|
||
(define (cgit-configuration-nginx-config config)
|
||
(cgit-configuration-nginx config))
|
||
|
||
(define cgit-service-type
|
||
(service-type
|
||
(name 'cgit)
|
||
(extensions
|
||
(list (service-extension activation-service-type
|
||
cgit-activation)
|
||
(service-extension nginx-service-type
|
||
cgit-configuration-nginx-config)))
|
||
(default-value (cgit-configuration))
|
||
(description
|
||
"Run the Cgit web interface, which allows users to browse Git
|
||
repositories.")))
|
||
|
||
|
||
;;;
|
||
;;; HTTP access. Add the result of calling
|
||
;;; git-http-nginx-location-configuration to an nginx-server-configuration's
|
||
;;; "locations" field.
|
||
;;;
|
||
|
||
(define-record-type* <git-http-configuration>
|
||
git-http-configuration
|
||
make-git-http-configuration
|
||
git-http-configuration?
|
||
(package git-http-configuration-package ;package
|
||
(default git))
|
||
(git-root git-http-configuration-git-root ;string
|
||
(default "/srv/git"))
|
||
(export-all? git-http-configuration-export-all? ;boolean
|
||
(default #f))
|
||
(uri-path git-http-configuration-uri-path ;string
|
||
(default "/git/"))
|
||
(fcgiwrap-socket git-http-configuration-fcgiwrap-socket ;string
|
||
(default "127.0.0.1:9000")))
|
||
|
||
(define* (git-http-nginx-location-configuration #:optional
|
||
(config
|
||
(git-http-configuration)))
|
||
(match config
|
||
(($ <git-http-configuration> package git-root export-all?
|
||
uri-path fcgiwrap-socket)
|
||
(nginx-location-configuration
|
||
(uri (string-append "~ /" (string-trim-both uri-path #\/) "(/.*)"))
|
||
(body
|
||
(list
|
||
(list "fastcgi_pass " fcgiwrap-socket ";")
|
||
(list "fastcgi_param SCRIPT_FILENAME "
|
||
package "/libexec/git-core/git-http-backend"
|
||
";")
|
||
"fastcgi_param QUERY_STRING $query_string;"
|
||
"fastcgi_param REQUEST_METHOD $request_method;"
|
||
"fastcgi_param CONTENT_TYPE $content_type;"
|
||
"fastcgi_param CONTENT_LENGTH $content_length;"
|
||
(if export-all?
|
||
"fastcgi_param GIT_HTTP_EXPORT_ALL \"\";"
|
||
"")
|
||
(list "fastcgi_param GIT_PROJECT_ROOT " git-root ";")
|
||
"fastcgi_param PATH_INFO $1;"))))))
|