silviof/docker-gollum-wuki repository overview

⁠Introduction

Gollum⁠ with authentication

⁠How to use

You have to mount a external directory to /wiki which holds the git repository for the wiki and a configuration fragment gollum_wiki.yml to configure some wiki settings.

This docker container create a default gollum_wiki.yml and an initialized empty wiki.git repository and user access database.

Per default the running gollum is listening on port 5555. It can be changed via -e PORTNUMBER=xyz.

Gollum doesn't support pushing of commits to the origin repository. We simulate this with a simple git pull && git push at every PULLNPUSHINTERVAL seconds, if PULLNPUSHACTIVATE is set to 1. To activate this feature set -e PULLNPUSHINTERVAL=60 -e PULLNPUSHACTIVATE=1 as environment variable. This feature is disabled per default.

⁠gollum_wiki.yml

gollum_wiki.yml is a configuration file for the wiki system. The wiki_options: are described at gollum-rack-config⁠ page.

wiki_path, wiki_repo describe the position of the wiki. For this docker image wiki_path must be set to /wiki.

default_markup set the default markup interpreter. You can find the default markup interpreters via gollum-formats-and-extensions⁠ page.

⁠start

mkdir /data/wiki  # for newly installations
docker run -v /data/wiki:/wiki \
           -u ${UID}:${GID} \
           --name wuki \
           -d \
           silviof/docker-gollum-wuki

Now point your webprowser to your docker container with port address 5555.