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
|
cgit - CGI for Git
==================
This is an attempt to create a fast web interface for the Git SCM, using a
built-in cache to decrease server I/O pressure.
Repository layout
-----------------
source/ the C sources, the build fragment and the version script
libraries/ the bundled Git tree, tracked as a submodule
assets/ cgit.css, cgit.js and the images cgit serves
extensions/ optional runtime filter scripts
examples/ a commented cgitrc, git hooks and web server configs
tools/ developer tooling (preview server and release build)
tests/ the test suite
build/ everything the build generates, and not tracked in git
Installation
------------
Building cgit involves building a proper version of Git. How to do this depends
on how you obtained the cgit sources:
a) If you're working in a cloned cgit repository, you first need to initialize
and update the Git submodule:
$ git submodule init # register the Git submodule in .git/config
$ $EDITOR .git/config # if you want to specify a different url for git
$ git submodule update # clone/fetch and checkout correct git version
b) If you're building from a cgit tarball, you can download a proper git version
like this:
$ make get-git
When either a) or b) has been performed, you can build and install cgit like
this:
$ make
$ sudo make install
This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You can
configure this location (and a few other things) by providing a `cgit.conf` file
(see the Makefile for details).
Lua is optional and only powers the lua: filter extensions (authentication,
email and commit-message filters in extensions/). A plain build auto-detects a
Lua through pkg-config, preferring LuaJIT, and falls back to a Lua-less binary
when none is found. Acceptable values are generally "luajit", "lua", "lua5.4",
"lua5.3", "lua5.2" and "lua5.1".
To pin an implementation:
$ make LUA_PKGCONFIG=lua5.4
To build without Lua, so the binary needs no Lua at runtime:
$ make NO_LUA=1
Previewing locally
------------------
cgit is a CGI program, so trying it out normally means configuring a web server.
For development there is a small dependency-free preview server at
`tools/serve.py` that runs the built binary and serves the static assets. It
needs only Python 3.
$ python3 tools/serve.py --config /path/to/cgitrc --port 8080
It is a development aid and is not meant to face the internet.
Dependencies
------------
* zlib
* optional: luajit or lua, most reliably used when pkg-config is available
cgit builds without OpenSSL or libcurl, so no development packages for those are
needed.
Filter extensions
-----------------
The optional Lua filters in `extensions/` need extra Lua modules. Each script's
header lists the exact install commands for its own dependencies.
* The auth filters (`auth-file.lua`, `auth-inline.lua`) need `luaossl` and
`luaposix`.
* The email filters (`email-gravatar.lua`, `email-libravatar.lua`) need
`luaossl`.
* The syntax highlighter (`syntax-highlight.lua`) needs `lpeg` and a Scintillua
lexer set.
* The about-page renderer (`about-render.lua`) needs `lpeg` for markdown and
man pages. Plain text needs only Lua.
These filters target Lua 5.1 through 5.4 and LuaJIT. `luaossl` has no Lua 5.5
build, so build cgit against 5.1 to 5.4 if you use the auth or email filters.
`link-commits.lua` needs nothing beyond Lua itself.
Web server configuration
------------------------
cgit is a CGI program. Complete, commented configurations for nginx, Apache and
lighttpd live in `examples/servers/`, each explaining how that server routes
requests to the binary and serves the static assets off disk.
Runtime configuration
---------------------
The file `/etc/cgitrc` is read by cgit before handling a request. In addition to
runtime parameters, this file may also contain a list of repositories displayed
by cgit (see `cgitrc.5.txt` for further details). A fully commented starting
point with every option at its default is in `examples/cgitrc`.
Securing an instance
--------------------
A public instance needs a few deliberate choices, all set in cgitrc and
documented in `cgitrc.5.txt`.
* Keep private repositories out of `scan-path`, or set `strict-export` to a
marker filename so only repositories that contain it are published.
* Gate the whole instance behind a login with `auth-filter`. Two example filters
ship in `extensions/`, `auth-inline.lua` and `auth-file.lua`.
* Terminate TLS at the web server in front of cgit.
* The example configs in `examples/servers/` set a Content-Security-Policy and
related headers at the web server, where they also cover the static assets.
* `max-blob-size` bounds how much a single request reads into memory, and
defaults to 10 MB.
* Leave `enable-cache-list` off, since it exposes the cache path and the URLs
other visitors requested.
* Build the deployed binary with the hardening flags via
`tools/release-build.sh`.
The cache
---------
When cgit is invoked it looks for a cache file matching the request and returns
it to the client. If no such cache file exists (or if it has expired), the
content for the request is written into the proper cache file before the file is
returned.
If the cache file has expired but cgit is unable to obtain a lock for it, the
stale cache file is returned to the client. This is done to favour page
throughput over page freshness.
The generated content contains the complete response to the client, including
the HTTP headers `Modified` and `Expires`.
|
