Create your own Wiki

Tutorial Update, 15.08.2020:
A new version of gollum (version 5.1.1) is avilable. If you want to upgrade now, check our update process.
 
The following tutorial has been updated as needed.

 


Tutorial Update, 09.04.2020:
A new version of gollum (version 5) is avilable. If you want to upgrade now, check our update process.
 
The following tutorial has been updated as needed.

 


Tutorial Update, 08.01.2020:

New version of ruby 2.7.0 is available. The following tutorial has been updated as needed.

You can delete the old directory ~/.gem/ruby/2.6.0
rm -r ~/.gem/ruby/2.6.0


 

Gollum

The Wiki called gollum and is based on git.

Packages

sudo pacman -S ruby ruby-rdoc cmake git
mkdir -p ~/your/wiki/path
git init ~/your/wiki/path
gem install gollum
gem install github-markdown

Update gollum

gem update

 

Copy config files

Copy config.rb, public and the templates into your wiki.

cp ~/.gem/ruby/2.7.0/gems/gollum-5.*/config.rb ~/your/wiki/path/config.rb
cp -r ~/.gem/ruby/2.7.0/gems/gollum-5.*/lib/gollum/public/gollum ~/your/wiki/path/public
cp -r ~/.gem/ruby/2.7.0/gems/gollum-5.*/lib/gollum/templates ~/your/wiki/path/public/templates

 

gollum.service

Create a service to run it on every boot.

Change USER

sudo nano /lib/systemd/system/gollum.service
[Unit]
Description=Gollum wiki server
After=network.target

[Service]
Type=simple
User=USER
Group=USER
WorkingDirectory=/home/USER/your/wiki/path
ExecStart=/bin/bash -c "PATH=/home/USER/.gem/ruby/2.7.0/bin:$PATH exec gollum --config /home/USER/your/wiki/path/config.rb --template-dir /home/USER/your/wiki/path/public/templates/ --css" 
Restart=on-abort

[Install]
WantedBy=multi-user.target
sudo systemctl enable gollum.service && sudo systemctl start gollum.service

 

Push from local desktop folder to git

Create a file, add images, etc. and add your description.

After you have added your content, you need to run the following commands in your Wiki root directory:

git add .
git commit -m "your explanation about the content, changes ..."

 
For more information and options see our wiki.