gollum
A simple wiki system built on top of Git. Pages are editable text files in a Git repository, with built-in web interface and version control.
Smart Download
Visit Project Homepage
No installer available yet — head to the source repository
A Git-backed wiki system that stores pages as text files with built-in web editing and version control.
Core Features
- Git-based: Every page is a file in a Git repository, providing full version history, rollback, and branching
- Multiple markup languages: Supports Markdown, RDoc, AsciiDoc, MediaWiki, Textile, and more
- GitHub/GitLab compatible: Clone remote wikis, edit locally, then push changes
- Built-in web editor: Create and edit pages directly in the browser
- Advanced features: Mermaid/PlantUML diagrams, math equations, BibTeX citations, CriticMarkup, macros, redirects, RSS feeds
What It Can't Do
- •Windows requires JRuby (not MRI Ruby); ensure Git is installed and configured before running; some markup renderers (e.g., AsciiDoc, MediaWiki) need additional gems or dependencies; default port is 4567 (check firewall); refer to official wiki for configuration details.
Use Cases
- Team internal knowledge base: Self-hosted wiki with Git server integration
- Personal notes: Manage notes in Git with full history and sync
- Project documentation: Host technical docs and API references as a Git-based wiki
- Offline editing: Clone remote wiki for editing without internet
Detailed Introduction
Gollum is a lightweight wiki system powered by Git. Instead of a database, it stores all pages as plain text or markup files inside a Git repository. You can edit pages using your favorite editor or the built-in web interface, and every change is automatically versioned. Gollum supports Markdown, RDoc, AsciiDoc, Creole, MediaWiki, Org, Pod, ReStructuredText, Textile, and more. It is compatible with GitHub and GitLab wikis, so you can clone a remote wiki, work locally, and push back. Advanced features include Mermaid/PlantUML diagrams, BibTeX citations, CriticMarkup annotations, mathematics (KaTeX/MathJax), macros, redirects, and RSS feeds. Gollum runs on Unix-like systems and Windows (via JRuby), and can be deployed as a Ruby gem, Docker container, or Java WAR file.
Troubleshooting & FAQ (1)
TroubleshootingWhy does Gollum render my code block with angle brackets as a macro, and how can I fix it?
Gollum may misinterpret inline code blocks containing angle brackets (e.g., <address>[;<options>]) as Gollum macros. To prevent this, place the code block on separate lines using triple backticks on their own lines:
[<device>][=<mac-address>]:<address>[;<options>]
This stops Gollum from parsing the content as a macro. If using a Docker image, no gem change is needed; this is a formatting workaround.
Tags
Getting Started
Download installer
Click the button above to download the installer for your system
Install the software
Double-click the downloaded installer and follow the prompts
Step 1: Install Ruby 2.5+ or Docker/Java (choose one method)
Step 2: Install Gollum: gem install gollum (Ruby) or docker pull gollumwiki/gollum
Step 3: cd into an initialized Git repository and run gollum .
- Step 1: Install Ruby 2.5+ or Docker/Java (choose one method)
- Step 2: Install Gollum: gem install gollum (Ruby) or docker pull gollumwiki/gollum
- Step 3: cd into an initialized Git repository and run gollum .
Checksum not available
This project has not published a SHA-256 checksum on its GitHub Release page
SHA256 Checksum
No checksum available
Download directly from GitHub Releases and verify file integrity yourself
All SHA-256 checksums on this platform are extracted from the project's official GitHub Release page, without any modification. You can independently verify them on the GitHub Releases page.
Open Source Transparency
View GitHub SourceUninstall Info
For gem installation: gem uninstall gollum. For Docker: docker rmi gollumwiki/gollum and remove containers. For WAR: delete the .war file.
No Extra Dependencies
Ready to use after download. No additional runtime required.
Having issues? Check the FAQ below
1 FAQ
Similar Projects
lazygit
A simple terminal UI for git commands
Git
Fast, scalable, distributed revision control system with a rich command set for version control and collaboration.
Visual Studio Code (Code - OSS)
A free, open-source code editor by Microsoft with rich extensions, debugging, and Git integration. The most popular developer tool worldwide.