cGit-UI: A Web Interface for Git Repositories
Check out cGit-UI, which provides a helpful web interface for your Git repo.
Join the DZone community and get the full member experience.
Join For FreecGit-UI is a web interface for Git repositories. cGit-UI is based on CGI script written in С.
This article covers installing and configuring cGit-UI to work using Nginx + uWsgi. Setting up server components is quite simple and practically does not differ from setting up cGit.
cGit-UI supports Markdown files that are processed on the server side using the md4c library, which has proven itself in the KDE Plasma project. cGit-UI provides the ability to add site verification codes and scripts from systems such as Google Analytics and Yandex.Metrika for traffic analysis. Users who want to receive donations for projects can create and import custom donation modal dialogs.
Instead of looking at screenshots, it is better to look at the working site to decide whether to install cGit-UI on your own server.
Required Packages
cGit-UI depends of following libraries: libpcre2, libmd4c, libmd4c-html, libmagic, and libgit2.
Also, cGit-UI depends on the cScm package. Therefore, before installing cGit-UI, you have to install and configure the cScm Configuration Daemon.
To use cGit-UI, a web server must be installed and configured on the system. We recommend the Nginx with uWsgi application server. Of course, Git SCM system should be installed too.
Installation
To obtain sources, we have to check it out from the SVN repository:
Shell
x
1
svn checkout svn://radix.pro/cgit-ui/tags/cgit-ui-0.1.5 cgit-ui-0.1.5
Then, run the bootstrap script:
Shell
xxxxxxxxxx
1
1
cd csvn-0.1.5
2
./bootstrap
Also, the cGit-UI source packages are available for download on the Radix.pro FTP-server.
Bootstrap Script
The bootstrap script was created for Autotools install automation. To install Autotools into the source directory on the build machine (i.e. when build == host), the bootstrap script can be run without arguments.
Shell
xxxxxxxxxx
1
1
./bootstrap
In this case, Autotools will be installed from current root file system.
For the cross environment, the --target-dest-dir option allows us to install some stuff from the development root file system:
Shell
xxxxxxxxxx
1
1
TARGET_DEST_DIR=/home/developer/prog/trunk-672/dist/.s9xx-glibc/enybox-x2 \
2
./bootstrap --target-dest-dir=${TARGET_DEST_DIR}
For example, in this case, the aclocal.m4 script will be collected from the
${TARGET_DEST_DIR}/usr/share/aclocal directory.
Configuring Sources
Shell
xxxxxxxxxx
1
1
./configure --prefix=/usr \
2
--with-scriptdir=/var/www/htdocs/cgit
Install on the Build Machine
Shell
xxxxxxxxxx
1
1
make
2
make install
Cross Compilation Example
Shell
xxxxxxxxxx
1
20
1
2
3
TARGET_DEST_DIR=/home/developer/prog/trunk-672/dist/.s9xx-glibc/enybox-x2
4
TOOLCHAIN_PATH=/opt/toolchains/aarch64-S9XX-linux-glibc/1.1.4/bin
5
TARGET=aarch64-s9xx-linux-gnu
6
7
./bootstrap --target-dest-dir=${TARGET_DEST_DIR}
8
9
PKG_CONFIG=/usr/bin/pkg-config \
10
PKG_CONFIG_PATH=${TARGET_DEST_DIR}/usr/lib${LIBDIRSUFFIX}/pkgconfig:${TARGET_DEST_DIR}/usr/share/pkgconfig \
11
PKG_CONFIG_LIBDIR=${TARGET_DEST_DIR}/usr/lib${LIBDIRSUFFIX}/pkgconfig:${TARGET_DEST_DIR}/usr/share/pkgconfig \
12
STRIP="${TOOLCHAIN_PATH}/${TARGET}-strip" \
13
CC="${TOOLCHAIN_PATH}/${TARGET}-gcc --sysroot=${TARGET_DEST_DIR}" \
14
./configure --prefix=/usr
15
--build=x86_64-pc-linux-gnu \
16
--host=${TARGET} \
17
--with-scriptdir=/var/www/htdocs/cgit
18
19
make
20
make install DESTDIR=${TARGET_DEST_DIR}
Also, we can make use of additional variables, such as CFLAGS, LDFLAGS:
Properties files
xxxxxxxxxx
1
1
LDFLAGS="-L${TARGET_DEST_DIR}/lib -L${TARGET_DEST_DIR}/usr/lib"
2
TARGET_INCPATH="-L${TARGET_DEST_DIR}/usr/include"
3
CFLAGS="${TARGET_INCPATH}"
4
CPPFLAGS="${TARGET_INCPATH}"
Post Install
The system user, on whose behalf the Nginx server is launched, must have permission to access the directory in which the cGit-UI CGI script was installed:
Shell
xxxxxxxxxx
1
1
chown -R nginx:nginx /var/www/htdocs/cgit
Additionally, if the Nginx user doesn't have permission to access repositories, we have to changethe owner of the /var/www/htdocs/cgit/cgit-ui.cgi script and set the SUID or SGID bit:
Shell
xxxxxxxxxx
1
1
chown -R 0:0 /var/www/htdocs/cgit/cgit-ui.cgi
2
chmod 4755 /var/www/htdocs/cgit/cgit-ui.cgi
uWsgi
Since we used the --with-scriptdir=/var/www/htdocs/cgit option on the configuring stage, the cGit-UI CGI script installed in the /var/www/htdocs/cgit/ directory. In this case, the /etc/uwsgi/cgit-ui.ini file should look like this:
/etc/uwsgi/cgit-ui.ini:
Properties files
xxxxxxxxxx
1
10
1
[uwsgi]
2
master = true
3
plugins = cgi
4
socket = /run/uwsgi/%n.sock
5
uid = nginx
6
gid = nginx
7
procname-master = uwsgi cgit-ui
8
processes = 1
9
threads = 2
10
cgi = /var/www/htdocs/cgit/cgit-ui.cgi
/var/www/htdocs/cgit/cgit-ui.cgi is the full name of installed cGit-UI CGI script.
To run the uWSGI daemon for the cGit-UI, backend we can make use following start/stop script:
/ets/rc.d/rc.cgit-ui-uwsgi:
Shell
xxxxxxxxxx
1
64
1
2
#
3
# uWSGI daemon control script.
4
#
5
6
CONF=cgit-ui
7
BIN=/usr/bin/uwsgi
8
CONFDIR=/etc/uwsgi
9
PID=/var/run/$CONF-uwsgi.pid
10
11
uwsgi_start() {
12
# Sanity checks.
13
if [ ! -r $CONFDIR/cgit-ui.ini ]; then # no config files, exit:
14
echo "There are config files in $CONFDIR directory. Abort."
15
exit 1
16
fi
17
18
if [ -s $PID ]; then
19
echo "uWSGI for cGit-ui appears to already be running?"
20
exit 1
21
fi
22
23
echo "Starting uWSGI for cGit-ui server daemon..."
24
if [ -x $BIN ]; then
25
/bin/mkdir -p /run/uwsgi
26
/bin/chown nginx:nginx /run/uwsgi
27
/bin/chmod 0755 /run/uwsgi
28
$BIN --thunder-lock --pidfile $PID --daemonize /var/log/cgit-ui-uwsgi.log --ini $CONFDIR/$CONF.ini
29
fi
30
}
31
32
uwsgi_stop() {
33
echo "Shutdown uWSGI for cGit-ui gracefully..."
34
/bin/kill -INT $(cat $PID)
35
/bin/rm -f $PID
36
}
37
38
uwsgi_reload() {
39
echo "Reloading uWSGI for cGit-ui configuration..."
40
kill -HUP $(cat $PID)
41
}
42
43
uwsgi_restart() {
44
uwsgi_stop
45
sleep 3
46
uwsgi_start
47
}
48
49
case "$1" in
50
start)
51
uwsgi_start
52
;;
53
stop)
54
uwsgi_stop
55
;;
56
reload)
57
uwsgi_reload
58
;;
59
restart)
60
uwsgi_restart
61
;;
62
*)
63
echo "usage: `basename $0` {start|stop|reload|restart}"
64
esac
To run this daemon on systems with BSD-like initialization, such as Slackware, we have to add the following lines to the /etc/rc.d/rc.M and /etc/rc.d/rc.6 scripts correspondingly.
/etc/rc.d/rc.M:
Shell
xxxxxxxxxx
1
1
# Start uWSGI for cGit-ui server:
2
if [ -x /etc/rc.d/rc.cgit-ui-uwsgi ]; then
3
/etc/rc.d/rc.cgit-ui-uwsgi start
4
fi
/etc/rc.d/rc.6:
Shell
xxxxxxxxxx
1
1
# Stop uWSGI for cGit-ui server:
2
if [ -x /etc/rc.d/rc.cgit-ui-uwsgi ]; then
3
/etc/rc.d/rc.cgit-ui-uwsgi stop
4
fi
Nginx
First, we have to add a virtual server to the main Nginx config file:
/etc/nginx/nginx.conf:
Properties files
xxxxxxxxxx
1
1
include /etc/nginx/vhosts/cgit.example.org.conf;
The following configuration used uWsgi and will serve cGit-UI on a subdomain like cgit.example.org:
/etc/nginx/vhosts/cgit.example.org.conf:
Properties files
xxxxxxxxxx
1
72
1
#
2
# cGit server:
3
#
4
5
server {
6
listen 80;
7
server_name cgit.example.org;
8
return 301 https://cgit.example.org$request_uri;
9
}
10
11
server {
12
listen 443 ssl;
13
server_name cgit.example.org;
14
root /var/www/htdocs/cgit;
15
16
charset UTF-8;
17
18
#
19
# see:
20
# https://developer.mozilla.org/en-US/docs/Web/Security/HTTP_strict_transport_security ,
21
# https://raymii.org/s/tutorials/HTTP_Strict_Transport_Security_for_Apache_NGINX_and_Lighttpd.html
22
#
23
# see also: http://classically.me/blogs/how-clear-hsts-settings-major-browsers
24
# and do not include includeSubdomains; parameter into line:
25
#
26
add_header Strict-Transport-Security "max-age=63072000; preload";
27
28
error_log /var/log/nginx/cgit.example.org-error.log;
29
access_log /var/log/nginx/cgit.example.org-access.log;
30
31
keepalive_timeout 60;
32
ssl_certificate /etc/letsencrypt/live/cgit.example.org/fullchain.pem;
33
ssl_certificate_key /etc/letsencrypt/live/cgit.example.org/privkey.pem;
34
ssl_trusted_certificate /etc/letsencrypt/live/cgit.example.org/chain.pem;
35
ssl_protocols SSLv3 TLSv1 TLSv1.1 TLSv1.2;
36
ssl_ciphers "RC4:HIGH:!aNULL:!MD5:!kEDH";
37
38
gzip on;
39
gzip_disable "msie6";
40
gzip_comp_level 6;
41
gzip_min_length 1100;
42
gzip_buffers 16 8k;
43
gzip_proxied any;
44
gzip_types text/plain text/css text/js text/xml text/javascript
45
image/svg+xml image/gif image/jpeg image/png
46
application/json application/x-javascript application/xml application/xml+rss application/javascript
47
font/truetype font/opentype application/font-woff application/font-woff2
48
application/x-font-ttf application/x-font-opentype application/vnd.ms-fontobject application/font-sfnt;
49
50
51
location ~* ^.+(favicon.ico|robots.txt) {
52
root /var/www/htdocs/cgit;
53
expires 30d;
54
}
55
56
location = /robots.txt {
57
allow all;
58
log_not_found off;
59
access_log off;
60
}
61
62
location / {
63
try_files $uri @cgit-ui;
64
}
65
66
location @cgit-ui {
67
gzip off;
68
include uwsgi_params;
69
uwsgi_modifier1 9;
70
uwsgi_pass unix:/run/uwsgi/cgit-ui.sock;
71
}
72
}
Configuring Git Repositories
A detailed description of the configuration file format can be found in the cgit-ui.rc(5) manual page:
Shell
xxxxxxxxxx
1
1
man 5 cgit-ui.rc
Working Example
As an example, we will look at a working configuration file in which the pkgtools.git repository is presented.
Properties files
xxxxxxxxxx
1
41
1
git-utc-offset = +0300;
2
3
clone-prefix-readonly = 'git://radix.pro';
4
clone-prefix = 'git://git@radix.pro:pub';
5
6
trunk = 'master';
7
8
snapshots = 'tar.xz';
9
10
css = '/.cgit/css/cgit.css';
11
logo = '/.cgit/pixmaps/cgit-banner-280x280.png';
12
logo-alt = "Radix.pro";
13
logo-link = "https://radix.pro";
14
main-menu-logo = '/.cgit/pixmaps/logo/git-logo-white-256x256.svg';
15
favicon-path = '/.cgit/pixmaps/favicon';
16
syntax-highlight-css = '_cgit.css';
17
header = '/.cgit/html/header.html';
18
footer = '/.cgit/html/footer.html';
19
page-size = 200;
20
21
owner = "Andrey V.Kosteltsev";
22
author = "Andrey V.Kosteltsev";
23
title = "Radix.pro Git Repositories";
24
description = "Git repositories hosted at radix.pro (St.-Petersburg)";
25
keywords = "cGit repositories cgit-ui web web-ui user interface Git";
26
copyright = "© Andrey V. Kosteltsev, 2019 – 2020.";
27
copyright-notice = "Where any material of this site is being reproduced, published or issued to others the reference to the source is obligatory.";
28
29
home-page = "https://radix.pro/";
30
31
section "Tools" {
32
repo 'pkgtools.git' {
33
owner = "Andrey V.Kosteltsev";
34
title = "Package Tools Utilities";
35
description = "Pkgtools – is a set of utilities to create, install, remove and update packages";
36
home-page = "https://radix.pro/";
37
git-root = '/u3/scm/git';
38
clone-prefix-readonly = 'git://git@radix.pro:git';
39
clone-prefix = 'git://git@radix.pro:git';
40
}
41
}
See Also
README, cscmd(8), cgit-ui.rc(5)
Enjoy.
Topics:
git,
web interface,
scm,
cgi scripts,
open source
Opinions expressed by DZone contributors are their own.
Comments