about summary refs log tree commit diff
path: root/guix/forge/klaus.scm
blob: 7a0bff6b993c1b378b7ea6e9f9fb4e99a3d5a915 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
;;; guix-forge --- Guix software forge meta-service
;;; Copyright © 2023–2025 Arun Isaac <arunisaac@systemreboot.net>
;;; Copyright © 2024 jgart <jgart@dismail.de>
;;;
;;; This file is part of guix-forge.
;;;
;;; guix-forge 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.
;;;
;;; guix-forge 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 guix-forge.  If not, see
;;; <https://www.gnu.org/licenses/>.

(define-module (forge klaus)
  #:use-module (forge environment)
  #:use-module ((forge git) #:select (git-without-safe-directory-check))
  #:use-module (forge gunicorn)
  #:use-module (forge socket)
  #:use-module ((gnu packages version-control)
                #:select (python-klaus)
                #:prefix guix:)
  #:use-module (gnu system file-systems)
  #:use-module (guix packages)
  #:export (klaus-gunicorn-app))

(define-public python-klaus
  (package
    (inherit guix:python-klaus)
    (inputs
     ;; We use klaus to serve shared repositories. But, git's safe directory
     ;; check does not permit us to use shared repositories. Disable it. The
     ;; more long term solution is to rewrite klaus to not use the git CLI at
     ;; all. See https://github.com/jonashaag/klaus/issues/322
     (modify-inputs (package-inputs guix:python-klaus)
       (replace "git" git-without-safe-directory-check)))))

(define* (klaus-gunicorn-app repository-directory
                             #:key
                             (klaus python-klaus)
                             (sockets (list (forge-unix-socket
                                             (path "/var/run/gunicorn/klaus/socket"))))
                             site-name)
  "Return a @code{<gunicorn-app>} object to deploy klaus.

@var{repository-directory} is the path to the directory containing git
repositories to serve.

@var{klaus} is the klaus package to use.

@var{sockets} is a list of @code{<forge-ip-socket>} or
@code{<forge-unix-socket>} objects describing sockets to listen on.

@var{site-name} is the name of the klaus site to be displayed in the
banner."
  (gunicorn-app
   (name "klaus")
   (package klaus)
   (wsgi-app-module "klaus.contrib.wsgi_autoreload")
   (sockets sockets)
   (environment-variables (cons (environment-variable
                                 (name "KLAUS_REPOS_ROOT")
                                 (value repository-directory))
                                (if site-name
                                    (list (environment-variable
                                           (name "KLAUS_SITE_NAME")
                                           (value site-name)))
                                    (list))))
   (mappings (list (file-system-mapping
                    (source repository-directory)
                    (target source))))))