satangos/gollum repository overview

⁠Gollum tips

⁠About Gollum

Gollum version 5.0 is out! See here for a list of changes and new features compared to Gollum version 4.x, and see some Screenshots of Gollum's features.

• A Gollum repository's contents are human-editable text or markup files;
• Pages may be organized into directories any way you choose;
• Other content can also be included, for example, images, PDFs, and headers/footers for your pages;
• Gollum pages:
  • Maybe written in a variety of markups⁠;
  • Can be edited with your favorite system editor or IDE (changes will be visible after committing) or with the built-in web interface;
  • Can be displayed in all versions, reverted, etc;
• Gollum strives to be compatible with GitHub wikis (see --lenient-tag-lookup)
• Gollum supports advanced functionality like:
  • UML diagrams;
  • BibTeX and Citation support;
  • Annotations using CriticMarkup;
  • Mathematics via MathJax;
  • Macros;
  • Redirects;
  • RSS Feed of latest changes;
  • ...and more

⁠Installing

[user@hostname ~/] $: docker pull satangos/gollum

⁠Running the service

[user@hostname ~/] $: docker run \ 
    -p 4567:4567 \
    --name gollum-srv \
    --hostname pimp-gollum \
    --restart=always \
    --network=host \
    -v /srv/gollum/wiki:/wiki \
    -d satangos/gollum

⁠Enter in the matrix:

[user@hostname ~/] $: docker exec -it gollum-srv bash

⁠Install requirements

[root@cead-gollum ~/] $: apt update && apt install -y python3-pip cpanminus 

[root@cead-gollum ~/] $: gem install commonmarker

[root@cead-gollum ~/] $: gem install RedCloth

[root@cead-gollum ~/] $: gem install rdoc

[root@cead-gollum ~/] $: gem install org-ruby

[root@cead-gollum ~/] $: gem install creole

[root@cead-gollum ~/] $: gem install wikicloth

[root@cead-gollum ~/] $: pip3 install --upgrade pip setuptools 

[root@cead-gollum ~/] $: pip3 install docutils

[root@cead-gollum ~/] $:  gem install asciidoctor

[root@cead-gollum ~/] $:cpan 

cpan[1]: install local::lib

cpan[2]: install Pod::Simple

cpan[3]: CTRL+D

[root@cead-gollum ~/] $: gem install github-markup 

⁠Exit the matrix

[root@cead-gollum ~/] $: CTRL+D 

⁠Accessing the service

Use the browser: http://server-name.net:4567⁠

⁠Configuration

⁠Notes

1. The 0.0.0.0 IP address remote access. Should you wish for Gollum to turn into a personal Wiki, use 127.0.0.1;
2. Before using --adapter, you should probably read this⁠ first;
3. When --css or --js is used, respective files must be committed to your git repository or you will get a 302 redirect to the create a page;
4. Files can be uploaded simply by dragging and dropping them onto the editor's text area when --allow-uploads is used;

⁠Config file

When --config option is used, certain inner parts of Gollum can be customized. This is used throughout our wiki for certain user-level alterations, among which customizing supported markups⁠ will probably stand out.

All of the mentioned alterations work both for Gollum's config file (config.rb) and hack's config file (config.ru).

⁠CONTRIBUTING

Please consider helping out! See CONTRIBUTING⁠ for information on how to submit issues, and how to start hacking on gollum.

Oficial Gollum source code⁠