Gollum is a simple Git-powered wiki. It provides a Web front-end to view certain data stored in Git repositories. Refer to the Git page for more information about installing and configuring Git services.

• 1 Installing
• 2 Configuring
• 3 Hardening

Installing¶

sudo apt update                               # Update APT repository cache.
sudo apt install ruby ruby-dev libicu-dev     # Install Gollum's dependencies.
sudo -u git gem install --user-install gollum # Install the Gollum gem into the `git` user's home folder.

Configuring¶

Gollum is a single-repository wiki, which means each instance of it can only serve one repository’s files. Here is an example configuration:

#
# FILE: /etc/systemd/system/gollum.service
#
# Gollum wiki server boot-time startup script.
#
# This script is a systemd service unit that ensures
# the Gollum Wiki server is operational after Tor starts.
# Without this process running, the wiki service is
# not available over a Web connection. Tor handles all
# other parts of the network connection and connectivity.
#
[Unit]
Description=Gollum Wiki server
After=tor.service

[Service]
User=git
Group=git
UMask=0005
Type=simple
WorkingDirectory=/srv/git/PROJECT_FOLDER/REPOSITORY_NAME.git
ExecStart=/usr/bin/gollum --host 127.0.0.1 --port 4567 --no-edit --adapter grit --bare --ref master
Restart=on-abort

[Install]
WantedBy=multi-user.target

See also Gollum as a service on the Gollum project’s own wiki.

Hardening¶

Gollum will install and use WEBrick by default.

TK-TODO