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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
{
config,
lib,
pkgs,
...
}: let
cfg = config.vhack.git-server;
cgitCss = import ./css.nix {
inherit pkgs;
cgitPkg =
config.services.cgit."${cfg.domain}".package;
};
/*
Until <https://github.com/NixOS/nixpkgs/pull/317293> is merged into
nixpkgs, we have to do the list to string conversion ourselves:
*/
toCgitRc = list: lib.strings.concatStringsSep " " list;
in {
options.vhack.git-server = {
enable = lib.mkEnableOption ''
a lightweight git-server, realised with cgit and gitolite.
'';
domain = lib.mkOption {
type = lib.types.str;
default = "git.vhack.eu";
description = ''
The domain this git instance will run under.
'';
};
gitolite = {
adminPubkey = lib.mkOption {
description = ''
The initial key to use for gitolite. This will only be used for the initial
clone of the `gitolite-admin` repository.
'';
type = lib.types.str;
default = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAe4o1PM6VasT3KZNl5NYvgkkBrPOg36dqsywd10FztS openpgp:0x21D20D6A";
};
};
};
config = lib.mkIf cfg.enable {
programs.git = {
enable = true;
config = {
init = {
defaultBranch = "main";
};
};
};
# Needed for the nginx proxy and the virtual host
vhack.nginx.enable = true;
services = {
fcgiwrap = {
# NOTE: This is needed as `cgit` otherwise fails to run `git` commands in the git
# repositories (for example, when cloning a repository over http). <2024-08-02>
# FIXME: Is there a way to not run _all_ wrapped cgi things as `git`? <2024-08-02>
user = "git";
group = "nginx";
};
gitolite = {
inherit (cfg.gitolite) adminPubkey;
enable = true;
dataDir = "/srv/gitolite";
user = "git";
group = "git";
extraGitoliteRc = ''
$RC{UMASK} = 0027; # Enable group access, important for cgit.
# Enable modifing git variables (for cgit.owner and such things)
$RC{GIT_CONFIG_KEYS} = 'cgit\.owner cgit\.desc cgit\.section cgit\.homepage gitweb\.owner gitweb\.description';
push( @{$RC{ENABLE}}, 'config' );
push( @{$RC{ENABLE}}, 'git-config' );
push( @{$RC{ENABLE}}, 'expand-deny-messages' );
push( @{$RC{ENABLE}}, 'Motd' );
push( @{$RC{ENABLE}}, 'cgit' );
'';
};
cgit."${cfg.domain}" = {
enable = true;
package = pkgs.cgit-pink;
scanPath = "${config.services.gitolite.dataDir}/repositories";
settings = {
branch-sort = "age";
# Allow users to download a repo checkout with these compression formats
snapshots = toCgitRc ["tar.gz" "zip"];
# The template used to generate the clone url for https clone.
clone-url = toCgitRc ["https://${cfg.domain}/$CGIT_REPO_URL" "ssh://git@${cfg.domain}/$CGIT_REPO_URL"];
enable-http-clone = true;
# TODO: We might want to add an logo and readme here <2024-07-31>
# logo = "<url>";
# root-readme = "/some/readme/file"
root-desc = "The cgit instance of ${cfg.domain}!";
root-title = "${
lib.strings.toUpper (builtins.substring 0 1 cfg.domain) + builtins.substring 1 (builtins.stringLength cfg.domain) cfg.domain
} cgit instace";
# Set the default maximum statistics period. Valid values are "week",
# "month", "quarter" and "year".
max-stats = "week";
readme = toCgitRc [
":README.md"
":readme.md"
":README.mkd"
":readme.mkd"
":README.rst"
":readme.rst"
":README.html"
":readme.html"
":README.htm"
":readme.htm"
":README.txt"
":readme.txt"
":README"
":readme"
":INSTALL.md"
":install.md"
":INSTALL.mkd"
":install.mkd"
":INSTALL.rst"
":install.rst"
":INSTALL.html"
":install.html"
":INSTALL.htm"
":install.htm"
":INSTALL.txt"
":install.txt"
":INSTALL"
":install"
];
enable-blame = true;
enable-commit-graph = true;
enable-subject-links = true;
enable-follow-links = true;
enable-index-links = true;
enable-index-owner = true;
# NOTE: This allows cgit to take configuration from the bare git repositories:
# eg. `cgit.section` should set the section, `cgit.homepage` the homepage,
# `gitweb.owner` the owner and `gitweb.description` the description of the repo. <2024-08-02>
enable-git-config = true;
# Remove the `.git` suffix from scanned repositories (this must be set _before_ `scan-path`)
remove-suffix = true;
css = "/custom_cgit.css";
# This is a number of path elements to treat as section.
# Set this to a big number to ensure all path elements are treated as sections.
section-from-path = 1000;
project-list = "${config.services.gitolite.dataDir}/projects.list";
# TODO: We might want to use the kernel.org `libravatar.lua` email-filter <2024-07-31>
source-filter = "${config.services.cgit."${cfg.domain}".package}/lib/cgit/filters/syntax-highlighting.py";
about-filter = "${config.services.cgit."${cfg.domain}".package}/lib/cgit/filters/about-formatting.sh";
};
};
nginx.virtualHosts."${cfg.domain}" = {
enableACME = true;
forceSSL = true;
locations = {
"= /custom_cgit.css" = {
alias = cgitCss.outPath;
};
};
};
};
};
}
|
