Commit | Line | Data |
---|---|---|
e1cf4fd2 OP |
1 | ;;; GNU Guix --- Functional package management for GNU |
2 | ;;; Copyright © 2018 Oleg Pykhalov <go.wigust@gmail.com> | |
dde99782 | 3 | ;;; Copyright © 2018 Clément Lassieur <clement@lassieur.org> |
c3343d62 | 4 | ;;; Copyright © 2018 Christopher Baines <mail@cbaines.net> |
33667454 | 5 | ;;; Copyright © 2019 Arun Isaac <arunisaac@systemreboot.net> |
e1cf4fd2 OP |
6 | ;;; |
7 | ;;; This file is part of GNU Guix. | |
8 | ;;; | |
9 | ;;; GNU Guix is free software; you can redistribute it and/or modify it | |
10 | ;;; under the terms of the GNU General Public License as published by | |
11 | ;;; the Free Software Foundation; either version 3 of the License, or (at | |
12 | ;;; your option) any later version. | |
13 | ;;; | |
14 | ;;; GNU Guix is distributed in the hope that it will be useful, but | |
15 | ;;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | ;;; GNU General Public License for more details. | |
18 | ;;; | |
19 | ;;; You should have received a copy of the GNU General Public License | |
20 | ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. | |
21 | ||
22 | (define-module (gnu services cgit) | |
23 | #:use-module (gnu packages admin) | |
24 | #:use-module (gnu packages version-control) | |
25 | #:use-module (gnu services base) | |
26 | #:use-module (gnu services configuration) | |
27 | #:use-module (gnu services shepherd) | |
28 | #:use-module (gnu services web) | |
29 | #:use-module (gnu services) | |
30 | #:use-module (gnu system shadow) | |
31 | #:use-module (guix gexp) | |
32 | #:use-module (guix packages) | |
33 | #:use-module (guix records) | |
34 | #:use-module (guix store) | |
35 | #:use-module (ice-9 match) | |
36 | #:use-module (srfi srfi-1) | |
37 | #:use-module (srfi srfi-26) | |
38 | #:export (repository-cgit-configuration | |
39 | cgit-configuration | |
40 | %cgit-configuration-nginx | |
41 | cgit-configuration-nginx-config | |
42 | opaque-cgit-configuration | |
43 | cgit-service-type)) | |
44 | ||
45 | ;;; Commentary: | |
46 | ;;; | |
47 | ;;; This module provides a service definition for the Cgit a web frontend for | |
48 | ;;; Git repositories written in C. | |
49 | ;;; | |
50 | ;;; Note: fields of <cgit-configuration> and <repository-cgit-configuration> | |
51 | ;;; should be specified in the specific order. | |
52 | ;;; | |
53 | ;;; Code: | |
54 | ||
55 | (define %cgit-configuration-nginx | |
56 | (nginx-server-configuration | |
57 | (root cgit) | |
58 | (locations | |
59 | (list | |
60 | (nginx-location-configuration | |
61 | (uri "@cgit") | |
62 | (body '("fastcgi_param SCRIPT_FILENAME $document_root/lib/cgit/cgit.cgi;" | |
63 | "fastcgi_param PATH_INFO $uri;" | |
64 | "fastcgi_param QUERY_STRING $args;" | |
65 | "fastcgi_param HTTP_HOST $server_name;" | |
66 | "fastcgi_pass 127.0.0.1:9000;"))))) | |
67 | (try-files (list "$uri" "@cgit")) | |
68 | (listen '("80")) | |
69 | (ssl-certificate #f) | |
70 | (ssl-certificate-key #f))) | |
71 | ||
72 | \f | |
73 | ;;; | |
74 | ;;; Serialize <cgit-configuration> | |
75 | ;;; | |
76 | ||
77 | (define (uglify-field-name field-name) | |
dde99782 | 78 | (string-delete #\? (symbol->string field-name))) |
e1cf4fd2 OP |
79 | |
80 | (define (serialize-field field-name val) | |
ad05e96e | 81 | #~(format #f "~a=~a\n" #$(uglify-field-name field-name) #$val)) |
e1cf4fd2 OP |
82 | |
83 | (define (serialize-string field-name val) | |
ad05e96e CL |
84 | (if (and (string? val) (string=? val "")) |
85 | "" | |
86 | (serialize-field field-name val))) | |
e1cf4fd2 OP |
87 | |
88 | (define (serialize-list field-name val) | |
89 | (if (null? val) "" (serialize-field field-name (string-join val)))) | |
90 | ||
91 | (define robots-list? list?) | |
92 | ||
93 | (define (serialize-robots-list field-name val) | |
94 | (if (null? val) "" (serialize-field field-name (string-join val ", ")))) | |
95 | ||
96 | (define (integer? val) | |
97 | (exact-integer? val)) | |
98 | ||
99 | (define (serialize-integer field-name val) | |
ad05e96e CL |
100 | (serialize-field field-name (number->string val))) |
101 | ||
102 | (define (serialize-boolean field-name val) | |
103 | (serialize-integer field-name (if val 1 0))) | |
e1cf4fd2 OP |
104 | |
105 | (define (serialize-repository-cgit-configuration x) | |
106 | (serialize-configuration x repository-cgit-configuration-fields)) | |
107 | ||
108 | (define (repository-cgit-configuration-list? val) | |
109 | (list? val)) | |
110 | ||
111 | (define (serialize-repository-cgit-configuration-list field-name val) | |
ad05e96e CL |
112 | #~(string-append |
113 | #$@(map serialize-repository-cgit-configuration val))) | |
114 | ||
115 | (define (file-object? val) | |
116 | (or (file-like? val) (string? val))) | |
117 | (define (serialize-file-object field-name val) | |
118 | (serialize-string field-name val)) | |
e1cf4fd2 | 119 | |
6ee3f3de CB |
120 | (define (project-list? val) |
121 | (or (list? val) | |
122 | (file-object? val))) | |
123 | ||
e1cf4fd2 OP |
124 | \f |
125 | ;;; | |
126 | ;;; Serialize <nginx-server-configuration> | |
127 | ;;; | |
128 | ||
129 | (define (nginx-server-configuration-list? val) | |
130 | (and (list? val) (and-map nginx-server-configuration? val))) | |
131 | ||
132 | (define (serialize-nginx-server-configuration-list field-name val) | |
ad05e96e | 133 | "") |
e1cf4fd2 OP |
134 | |
135 | \f | |
136 | ;;; | |
137 | ;;; Serialize <repository-cgit-configuration> | |
138 | ;;; | |
139 | ||
140 | (define (serialize-repo-field field-name val) | |
ad05e96e | 141 | #~(format #f "repo.~a=~a\n" #$(uglify-field-name field-name) #$val)) |
e1cf4fd2 OP |
142 | |
143 | (define (serialize-repo-list field-name val) | |
144 | (if (null? val) "" (serialize-repo-field field-name (string-join val)))) | |
145 | ||
146 | (define repo-boolean? boolean?) | |
147 | ||
e1cf4fd2 | 148 | (define (serialize-repo-integer field-name val) |
ad05e96e CL |
149 | (serialize-repo-field field-name (number->string val))) |
150 | ||
151 | (define (serialize-repo-boolean field-name val) | |
152 | (serialize-repo-integer field-name (if val 1 0))) | |
efb22b47 | 153 | (define-maybe repo-boolean) |
e1cf4fd2 OP |
154 | |
155 | (define repo-list? list?) | |
156 | ||
157 | (define repo-string? string?) | |
158 | ||
159 | (define (serialize-repo-string field-name val) | |
160 | (if (string=? val "") "" (serialize-repo-field field-name val))) | |
161 | ||
ad05e96e CL |
162 | (define repo-file-object? file-object?) |
163 | (define serialize-repo-file-object serialize-repo-string) | |
164 | ||
e1cf4fd2 OP |
165 | (define module-link-path? list?) |
166 | ||
167 | (define (serialize-module-link-path field-name val) | |
168 | (if (null? val) "" | |
169 | (match val | |
170 | ((path text) | |
ad05e96e | 171 | (format #f "repo.module-link.~a=~a\n" path text))))) |
e1cf4fd2 | 172 | |
e5fe544e CL |
173 | (define (serialize-project-list _ val) |
174 | (if (null? val) "" | |
175 | (serialize-field | |
176 | 'project-list | |
6ee3f3de CB |
177 | (if (file-object? val) |
178 | val | |
179 | (plain-file "project-list" (string-join val "\n")))))) | |
e5fe544e | 180 | |
c3343d62 CB |
181 | (define (serialize-extra-options extra-options) |
182 | (string-join extra-options "\n" 'suffix)) | |
183 | ||
e1cf4fd2 OP |
184 | (define repository-directory? string?) |
185 | ||
186 | (define (serialize-repository-directory _ val) | |
ad05e96e | 187 | (if (string=? val "") "" (format #f "scan-path=~a\n" val))) |
e1cf4fd2 OP |
188 | |
189 | (define mimetype-alist? list?) | |
190 | ||
191 | (define (serialize-mimetype-alist field-name val) | |
ad05e96e | 192 | (format #f "# Mimetypes\n~a" |
e1cf4fd2 OP |
193 | (string-join |
194 | (map (match-lambda | |
195 | ((extension mimetype) | |
196 | (format #f "mimetype.~a=~a" | |
197 | (symbol->string extension) mimetype))) | |
198 | val) "\n"))) | |
199 | ||
200 | (define-configuration repository-cgit-configuration | |
201 | (snapshots | |
202 | (repo-list '()) | |
203 | "A mask of snapshot formats for this repo that cgit generates links for, | |
204 | restricted by the global @code{snapshots} setting.") | |
205 | (source-filter | |
ad05e96e | 206 | (repo-file-object "") |
e1cf4fd2 OP |
207 | "Override the default @code{source-filter}.") |
208 | (url | |
209 | (repo-string "") | |
210 | "The relative URL used to access the repository.") | |
211 | (about-filter | |
ad05e96e | 212 | (repo-file-object "") |
e1cf4fd2 OP |
213 | "Override the default @code{about-filter}.") |
214 | (branch-sort | |
215 | (repo-string "") | |
216 | "Flag which, when set to @samp{age}, enables date ordering in the branch | |
217 | ref list, and when set to @samp{name} enables ordering by branch name.") | |
218 | (clone-url | |
219 | (repo-list '()) | |
220 | "A list of URLs which can be used to clone repo.") | |
221 | (commit-filter | |
ad05e96e | 222 | (repo-file-object "") |
e1cf4fd2 OP |
223 | "Override the default @code{commit-filter}.") |
224 | (commit-sort | |
225 | (repo-string "") | |
226 | "Flag which, when set to @samp{date}, enables strict date ordering in the | |
227 | commit log, and when set to @samp{topo} enables strict topological ordering.") | |
228 | (defbranch | |
229 | (repo-string "") | |
230 | "The name of the default branch for this repository. If no such branch | |
231 | exists in the repository, the first branch name (when sorted) is used as | |
232 | default instead. By default branch pointed to by HEAD, or \"master\" if there | |
233 | is no suitable HEAD.") | |
234 | (desc | |
235 | (repo-string "") | |
236 | "The value to show as repository description.") | |
237 | (homepage | |
238 | (repo-string "") | |
239 | "The value to show as repository homepage.") | |
240 | (email-filter | |
ad05e96e | 241 | (repo-file-object "") |
e1cf4fd2 OP |
242 | "Override the default @code{email-filter}.") |
243 | (enable-commit-graph? | |
8cb1a49a | 244 | maybe-repo-boolean |
e1cf4fd2 OP |
245 | "A flag which can be used to disable the global setting |
246 | @code{enable-commit-graph?}.") | |
247 | (enable-log-filecount? | |
8cb1a49a | 248 | maybe-repo-boolean |
e1cf4fd2 OP |
249 | "A flag which can be used to disable the global setting |
250 | @code{enable-log-filecount?}.") | |
251 | (enable-log-linecount? | |
8cb1a49a | 252 | maybe-repo-boolean |
e1cf4fd2 OP |
253 | "A flag which can be used to disable the global setting |
254 | @code{enable-log-linecount?}.") | |
255 | (enable-remote-branches? | |
8cb1a49a | 256 | maybe-repo-boolean |
e1cf4fd2 OP |
257 | "Flag which, when set to @code{#t}, will make cgit display remote |
258 | branches in the summary and refs views.") | |
259 | (enable-subject-links? | |
8cb1a49a | 260 | maybe-repo-boolean |
e1cf4fd2 OP |
261 | "A flag which can be used to override the global setting |
262 | @code{enable-subject-links?}.") | |
263 | (enable-html-serving? | |
8cb1a49a | 264 | maybe-repo-boolean |
e1cf4fd2 OP |
265 | "A flag which can be used to override the global setting |
266 | @code{enable-html-serving?}.") | |
267 | (hide? | |
268 | (repo-boolean #f) | |
269 | "Flag which, when set to @code{#t}, hides the repository from the | |
270 | repository index.") | |
271 | (ignore? | |
272 | (repo-boolean #f) | |
273 | "Flag which, when set to @samp{#t}, ignores the repository.") | |
274 | (logo | |
ad05e96e | 275 | (repo-file-object "") |
e1cf4fd2 OP |
276 | "URL which specifies the source of an image which will be used as a |
277 | logo on this repo’s pages.") | |
278 | (logo-link | |
279 | (repo-string "") | |
280 | "URL loaded when clicking on the cgit logo image.") | |
281 | (owner-filter | |
ad05e96e | 282 | (repo-file-object "") |
e1cf4fd2 OP |
283 | "Override the default @code{owner-filter}.") |
284 | (module-link | |
285 | (repo-string "") | |
286 | "Text which will be used as the formatstring for a hyperlink when a | |
287 | submodule is printed in a directory listing. The arguments for the | |
288 | formatstring are the path and SHA1 of the submodule commit.") | |
289 | (module-link-path | |
290 | (module-link-path '()) | |
291 | "Text which will be used as the formatstring for a hyperlink when a | |
292 | submodule with the specified subdirectory path is printed in a directory | |
293 | listing.") | |
294 | (max-stats | |
295 | (repo-string "") | |
296 | "Override the default maximum statistics period.") | |
297 | (name | |
298 | (repo-string "") | |
299 | "The value to show as repository name.") | |
300 | (owner | |
301 | (repo-string "") | |
302 | "A value used to identify the owner of the repository.") | |
303 | (path | |
304 | (repo-string "") | |
305 | "An absolute path to the repository directory.") | |
306 | (readme | |
307 | (repo-string "") | |
308 | "A path (relative to repo) which specifies a file to include verbatim | |
309 | as the \"About\" page for this repo.") | |
310 | (section | |
311 | (repo-string "") | |
312 | "The name of the current repository section - all repositories defined | |
313 | after this option will inherit the current section name.") | |
314 | (extra-options | |
315 | (repo-list '()) | |
316 | "Extra options will be appended to cgitrc file.")) | |
317 | ||
318 | ;; Generate a <cgit-configuration> record, which may include a list of | |
319 | ;; <repository-cgit-configuration>, <nginx-server-configuration>, <package>. | |
320 | (define-configuration cgit-configuration | |
321 | (package | |
892f1b72 | 322 | (file-like cgit) |
e1cf4fd2 OP |
323 | "The CGIT package.") |
324 | (nginx | |
325 | (nginx-server-configuration-list (list %cgit-configuration-nginx)) | |
326 | "NGINX configuration.") | |
327 | (about-filter | |
ad05e96e | 328 | (file-object "") |
e1cf4fd2 OP |
329 | "Specifies a command which will be invoked to format the content of about |
330 | pages (both top-level and for each repository).") | |
331 | (agefile | |
332 | (string "") | |
333 | "Specifies a path, relative to each repository path, which can be used to | |
334 | specify the date and time of the youngest commit in the repository.") | |
335 | (auth-filter | |
ad05e96e | 336 | (file-object "") |
e1cf4fd2 OP |
337 | "Specifies a command that will be invoked for authenticating repository |
338 | access.") | |
339 | (branch-sort | |
340 | (string "name") | |
341 | "Flag which, when set to @samp{age}, enables date ordering in the branch | |
342 | ref list, and when set @samp{name} enables ordering by branch name.") | |
343 | (cache-root | |
344 | (string "/var/cache/cgit") | |
345 | "Path used to store the cgit cache entries.") | |
346 | (cache-static-ttl | |
347 | (integer -1) | |
348 | "Number which specifies the time-to-live, in minutes, for the cached | |
349 | version of repository pages accessed with a fixed SHA1.") | |
350 | (cache-dynamic-ttl | |
351 | (integer 5) | |
352 | "Number which specifies the time-to-live, in minutes, for the cached | |
353 | version of repository pages accessed without a fixed SHA1.") | |
354 | (cache-repo-ttl | |
355 | (integer 5) | |
356 | "Number which specifies the time-to-live, in minutes, for the cached | |
357 | version of the repository summary page.") | |
358 | (cache-root-ttl | |
359 | (integer 5) | |
360 | "Number which specifies the time-to-live, in minutes, for the cached | |
361 | version of the repository index page.") | |
362 | (cache-scanrc-ttl | |
363 | (integer 15) | |
364 | "Number which specifies the time-to-live, in minutes, for the result of | |
365 | scanning a path for Git repositories.") | |
366 | (cache-about-ttl | |
367 | (integer 15) | |
368 | "Number which specifies the time-to-live, in minutes, for the cached | |
369 | version of the repository about page.") | |
370 | (cache-snapshot-ttl | |
371 | (integer 5) | |
372 | "Number which specifies the time-to-live, in minutes, for the cached | |
373 | version of snapshots.") | |
374 | (cache-size | |
375 | (integer 0) | |
376 | "The maximum number of entries in the cgit cache. When set to | |
377 | @samp{0}, caching is disabled.") | |
378 | (case-sensitive-sort? | |
379 | (boolean #t) | |
380 | "Sort items in the repo list case sensitively.") | |
381 | (clone-prefix | |
382 | (list '()) | |
383 | "List of common prefixes which, when combined with a repository URL, | |
384 | generates valid clone URLs for the repository.") | |
385 | (clone-url | |
386 | (list '()) | |
387 | "List of @code{clone-url} templates.") | |
388 | (commit-filter | |
ad05e96e | 389 | (file-object "") |
e1cf4fd2 OP |
390 | "Command which will be invoked to format commit messages.") |
391 | (commit-sort | |
392 | (string "git log") | |
393 | "Flag which, when set to @samp{date}, enables strict date ordering in the | |
394 | commit log, and when set to @samp{topo} enables strict topological | |
395 | ordering.") | |
396 | (css | |
ad05e96e | 397 | (file-object "/share/cgit/cgit.css") |
e1cf4fd2 OP |
398 | "URL which specifies the css document to include in all cgit pages.") |
399 | (email-filter | |
ad05e96e | 400 | (file-object "") |
e1cf4fd2 OP |
401 | "Specifies a command which will be invoked to format names and email |
402 | address of committers, authors, and taggers, as represented in various | |
403 | places throughout the cgit interface.") | |
404 | (embedded? | |
405 | (boolean #f) | |
406 | "Flag which, when set to @samp{#t}, will make cgit generate a HTML | |
407 | fragment suitable for embedding in other HTML pages.") | |
408 | (enable-commit-graph? | |
409 | (boolean #f) | |
410 | "Flag which, when set to @samp{#t}, will make cgit print an ASCII-art | |
411 | commit history graph to the left of the commit messages in the | |
412 | repository log page.") | |
413 | (enable-filter-overrides? | |
414 | (boolean #f) | |
415 | "Flag which, when set to @samp{#t}, allows all filter settings to be | |
416 | overridden in repository-specific cgitrc files.") | |
417 | (enable-follow-links? | |
418 | (boolean #f) | |
419 | "Flag which, when set to @samp{#t}, allows users to follow a file in the | |
420 | log view.") | |
421 | (enable-http-clone? | |
422 | (boolean #t) | |
423 | "If set to @samp{#t}, cgit will act as an dumb HTTP endpoint for Git | |
424 | clones.") | |
425 | (enable-index-links? | |
426 | (boolean #f) | |
427 | "Flag which, when set to @samp{#t}, will make cgit generate extra links | |
428 | \"summary\", \"commit\", \"tree\" for each repo in the repository index.") | |
429 | (enable-index-owner? | |
430 | (boolean #t) | |
431 | "Flag which, when set to @samp{#t}, will make cgit display the owner of | |
432 | each repo in the repository index.") | |
433 | (enable-log-filecount? | |
434 | (boolean #f) | |
435 | "Flag which, when set to @samp{#t}, will make cgit print the number of | |
436 | modified files for each commit on the repository log page.") | |
437 | (enable-log-linecount? | |
438 | (boolean #f) | |
439 | "Flag which, when set to @samp{#t}, will make cgit print the number of | |
440 | added and removed lines for each commit on the repository log page.") | |
441 | (enable-remote-branches? | |
442 | (boolean #f) | |
443 | "Flag which, when set to @code{#t}, will make cgit display remote | |
444 | branches in the summary and refs views.") | |
445 | (enable-subject-links? | |
446 | (boolean #f) | |
447 | "Flag which, when set to @code{1}, will make cgit use the subject of | |
448 | the parent commit as link text when generating links to parent commits | |
449 | in commit view.") | |
450 | (enable-html-serving? | |
451 | (boolean #f) | |
452 | "Flag which, when set to @samp{#t}, will make cgit use the subject of the | |
453 | parent commit as link text when generating links to parent commits in | |
454 | commit view.") | |
455 | (enable-tree-linenumbers? | |
456 | (boolean #t) | |
457 | "Flag which, when set to @samp{#t}, will make cgit generate linenumber | |
458 | links for plaintext blobs printed in the tree view.") | |
459 | (enable-git-config? | |
460 | (boolean #f) | |
461 | "Flag which, when set to @samp{#f}, will allow cgit to use Git config to | |
462 | set any repo specific settings.") | |
463 | (favicon | |
ad05e96e | 464 | (file-object "/favicon.ico") |
e1cf4fd2 OP |
465 | "URL used as link to a shortcut icon for cgit.") |
466 | (footer | |
467 | (string "") | |
468 | "The content of the file specified with this option will be included | |
469 | verbatim at the bottom of all pages (i.e. it replaces the standard | |
470 | \"generated by...\" message).") | |
471 | (head-include | |
472 | (string "") | |
473 | "The content of the file specified with this option will be included | |
474 | verbatim in the HTML HEAD section on all pages.") | |
475 | (header | |
476 | (string "") | |
477 | "The content of the file specified with this option will be included | |
478 | verbatim at the top of all pages.") | |
479 | (include | |
ad05e96e | 480 | (file-object "") |
e1cf4fd2 OP |
481 | "Name of a configfile to include before the rest of the current config- |
482 | file is parsed.") | |
483 | (index-header | |
484 | (string "") | |
485 | "The content of the file specified with this option will be included | |
486 | verbatim above the repository index.") | |
487 | (index-info | |
488 | (string "") | |
489 | "The content of the file specified with this option will be included | |
490 | verbatim below the heading on the repository index page.") | |
491 | (local-time? | |
492 | (boolean #f) | |
493 | "Flag which, if set to @samp{#t}, makes cgit print commit and tag times | |
494 | in the servers timezone.") | |
495 | (logo | |
ad05e96e | 496 | (file-object "/share/cgit/cgit.png") |
e1cf4fd2 OP |
497 | "URL which specifies the source of an image which will be used as a logo |
498 | on all cgit pages.") | |
499 | (logo-link | |
500 | (string "") | |
501 | "URL loaded when clicking on the cgit logo image.") | |
502 | (owner-filter | |
ad05e96e | 503 | (file-object "") |
e1cf4fd2 OP |
504 | "Command which will be invoked to format the Owner column of the main |
505 | page.") | |
506 | (max-atom-items | |
507 | (integer 10) | |
508 | "Number of items to display in atom feeds view.") | |
509 | (max-commit-count | |
510 | (integer 50) | |
511 | "Number of entries to list per page in \"log\" view.") | |
512 | (max-message-length | |
513 | (integer 80) | |
514 | "Number of commit message characters to display in \"log\" view.") | |
515 | (max-repo-count | |
516 | (integer 50) | |
517 | "Specifies the number of entries to list per page on the repository index | |
518 | page.") | |
519 | (max-repodesc-length | |
520 | (integer 80) | |
521 | "Specifies the maximum number of repo description characters to display | |
522 | on the repository index page.") | |
523 | (max-blob-size | |
524 | (integer 0) | |
525 | "Specifies the maximum size of a blob to display HTML for in KBytes.") | |
526 | (max-stats | |
527 | (string "") | |
528 | "Maximum statistics period. Valid values are @samp{week},@samp{month}, | |
529 | @samp{quarter} and @samp{year}.") | |
530 | (mimetype | |
531 | (mimetype-alist '((gif "image/gif") | |
532 | (html "text/html") | |
533 | (jpg "image/jpeg") | |
534 | (jpeg "image/jpeg") | |
535 | (pdf "application/pdf") | |
536 | (png "image/png") | |
537 | (svg "image/svg+xml"))) | |
538 | "Mimetype for the specified filename extension.") | |
539 | (mimetype-file | |
ad05e96e | 540 | (file-object "") |
e1cf4fd2 OP |
541 | "Specifies the file to use for automatic mimetype lookup.") |
542 | (module-link | |
543 | (string "") | |
544 | "Text which will be used as the formatstring for a hyperlink when a | |
545 | submodule is printed in a directory listing.") | |
546 | (nocache? | |
547 | (boolean #f) | |
548 | "If set to the value @samp{#t} caching will be disabled.") | |
549 | (noplainemail? | |
550 | (boolean #f) | |
551 | "If set to @samp{#t} showing full author email addresses will be | |
552 | disabled.") | |
553 | (noheader? | |
554 | (boolean #f) | |
555 | "Flag which, when set to @samp{#t}, will make cgit omit the standard | |
556 | header on all pages.") | |
e5fe544e | 557 | (project-list |
6ee3f3de | 558 | (project-list '()) |
e5fe544e CL |
559 | "A list of subdirectories inside of @code{repository-directory}, relative |
560 | to it, that should loaded as Git repositories. An empty list means that all | |
561 | subdirectories will be loaded.") | |
e1cf4fd2 | 562 | (readme |
ad05e96e | 563 | (file-object "") |
e1cf4fd2 OP |
564 | "Text which will be used as default value for @code{cgit-repo-readme}.") |
565 | (remove-suffix? | |
566 | (boolean #f) | |
567 | "If set to @code{#t} and @code{repository-directory} is enabled, if any | |
568 | repositories are found with a suffix of @code{.git}, this suffix will be | |
569 | removed for the URL and name.") | |
570 | (renamelimit | |
571 | (integer -1) | |
572 | "Maximum number of files to consider when detecting renames.") | |
573 | (repository-sort | |
574 | (string "") | |
575 | "The way in which repositories in each section are sorted.") | |
576 | (robots | |
577 | (robots-list (list "noindex" "nofollow")) | |
578 | "Text used as content for the @code{robots} meta-tag.") | |
579 | (root-desc | |
580 | (string "a fast webinterface for the git dscm") | |
581 | "Text printed below the heading on the repository index page.") | |
582 | (root-readme | |
583 | (string "") | |
584 | "The content of the file specified with this option will be included | |
33667454 | 585 | verbatim below the \"about\" link on the repository index page.") |
e1cf4fd2 OP |
586 | (root-title |
587 | (string "") | |
588 | "Text printed as heading on the repository index page.") | |
589 | (scan-hidden-path | |
590 | (boolean #f) | |
591 | "If set to @samp{#t} and repository-directory is enabled, | |
592 | repository-directory will recurse into directories whose name starts with a | |
593 | period. Otherwise, repository-directory will stay away from such directories, | |
594 | considered as \"hidden\". Note that this does not apply to the \".git\" | |
595 | directory in non-bare repos.") | |
596 | (snapshots | |
597 | (list '()) | |
598 | "Text which specifies the default set of snapshot formats that cgit | |
599 | generates links for.") | |
600 | (repository-directory | |
601 | (repository-directory "/srv/git") | |
602 | "Name of the directory to scan for repositories (represents | |
603 | @code{scan-path}).") | |
604 | (section | |
605 | (string "") | |
606 | "The name of the current repository section - all repositories defined | |
607 | after this option will inherit the current section name.") | |
608 | (section-sort | |
609 | (string "") | |
610 | "Flag which, when set to @samp{1}, will sort the sections on the repository | |
611 | listing by name.") | |
612 | (section-from-path | |
613 | (integer 0) | |
614 | "A number which, if defined prior to repository-directory, specifies how | |
615 | many path elements from each repo path to use as a default section name.") | |
616 | (side-by-side-diffs? | |
617 | (boolean #f) | |
618 | "If set to @samp{#t} shows side-by-side diffs instead of unidiffs per | |
619 | default.") | |
620 | (source-filter | |
ad05e96e | 621 | (file-object "") |
e1cf4fd2 OP |
622 | "Specifies a command which will be invoked to format plaintext blobs in the |
623 | tree view.") | |
624 | (summary-branches | |
625 | (integer 10) | |
626 | "Specifies the number of branches to display in the repository \"summary\" | |
627 | view.") | |
628 | (summary-log | |
629 | (integer 10) | |
630 | "Specifies the number of log entries to display in the repository | |
631 | \"summary\" view.") | |
632 | (summary-tags | |
633 | (integer 10) | |
634 | "Specifies the number of tags to display in the repository \"summary\" | |
635 | view.") | |
636 | (strict-export | |
637 | (string "") | |
638 | "Filename which, if specified, needs to be present within the repository | |
639 | for cgit to allow access to that repository.") | |
640 | (virtual-root | |
641 | (string "/") | |
642 | "URL which, if specified, will be used as root for all cgit links.") | |
643 | (repositories | |
644 | (repository-cgit-configuration-list '()) | |
645 | "A list of @dfn{cgit-repo} records to use with config.") | |
646 | (extra-options | |
647 | (list '()) | |
648 | "Extra options will be appended to cgitrc file.")) | |
649 | ||
80b76b93 CL |
650 | ;; This distinguishes fields whose order matters, and makes sure further |
651 | ;; changes won't inadvertently change the order. | |
652 | (define (serialize-cgit-configuration config) | |
653 | (define (rest? field) | |
654 | (not (memq (configuration-field-name field) | |
e5fe544e | 655 | '(project-list |
c3343d62 | 656 | extra-options |
e5fe544e CL |
657 | repository-directory |
658 | repositories)))) | |
80b76b93 CL |
659 | #~(string-append |
660 | #$(let ((rest (filter rest? cgit-configuration-fields))) | |
661 | (serialize-configuration config rest)) | |
e5fe544e CL |
662 | #$(serialize-project-list |
663 | 'project-list | |
664 | (cgit-configuration-project-list config)) | |
c3343d62 CB |
665 | #$(serialize-extra-options |
666 | (cgit-configuration-extra-options config)) | |
e5fe544e CL |
667 | #$(serialize-repository-directory |
668 | 'repository-directory | |
669 | (cgit-configuration-repository-directory config)) | |
80b76b93 CL |
670 | #$(serialize-repository-cgit-configuration-list |
671 | 'repositories | |
672 | (cgit-configuration-repositories config)))) | |
673 | ||
e1cf4fd2 OP |
674 | (define-configuration opaque-cgit-configuration |
675 | (cgit | |
892f1b72 | 676 | (file-like cgit) |
e1cf4fd2 OP |
677 | "The cgit package.") |
678 | (cgitrc | |
679 | (string (configuration-missing-field 'opaque-cgit-configuration 'cgitrc)) | |
680 | "The contents of the @code{cgitrc} to use.") | |
681 | (cache-root | |
682 | (string "/var/cache/cgit") | |
683 | "Path used to store the cgit cache entries.") | |
684 | (nginx | |
685 | (nginx-server-configuration-list (list %cgit-configuration-nginx)) | |
686 | "NGINX configuration.")) | |
687 | ||
688 | (define (cgit-activation config) | |
689 | "Return the activation gexp for CONFIG." | |
690 | (let* ((opaque-config? (opaque-cgit-configuration? config)) | |
691 | (config-str | |
692 | (if opaque-config? | |
693 | (opaque-cgit-configuration-cgitrc config) | |
80b76b93 | 694 | (serialize-cgit-configuration config)))) |
e1cf4fd2 OP |
695 | #~(begin |
696 | (use-modules (guix build utils)) | |
697 | (mkdir-p #$(if opaque-config? | |
698 | (opaque-cgit-configuration-cache-root config) | |
699 | (cgit-configuration-cache-root config))) | |
ad05e96e CL |
700 | (copy-file #$(mixed-text-file "cgitrc" config-str) |
701 | "/etc/cgitrc")))) | |
e1cf4fd2 OP |
702 | |
703 | (define (cgit-configuration-nginx-config config) | |
704 | (if (opaque-cgit-configuration? config) | |
705 | (opaque-cgit-configuration-nginx config) | |
706 | (cgit-configuration-nginx config))) | |
707 | ||
708 | (define cgit-service-type | |
709 | (service-type | |
710 | (name 'cgit) | |
711 | (extensions | |
712 | (list (service-extension activation-service-type | |
713 | cgit-activation) | |
714 | (service-extension nginx-service-type | |
715 | cgit-configuration-nginx-config) | |
716 | ||
717 | ;; Make sure fcgiwrap is instantiated. | |
718 | (service-extension fcgiwrap-service-type | |
719 | (const #t)))) | |
720 | (default-value (cgit-configuration)) | |
721 | (description | |
722 | "Run the cgit web interface, which allows users to browse Git | |
723 | repositories."))) | |
724 | ||
725 | (define (generate-cgit-documentation) | |
726 | (generate-documentation | |
727 | `((cgit-configuration | |
728 | ,cgit-configuration-fields | |
729 | (repositories repository-cgit-configuration)) | |
730 | (repository-cgit-configuration | |
731 | ,repository-cgit-configuration-fields)) | |
732 | 'cgit-configuration)) |