Installation

Henry Chang edited this page Nov 15, 2017 · 37 revisions

Ubuntu

Ubuntu 16.04 LTS

Install gollum system-wide:

sudo apt-get install ruby ruby-dev make zlib1g-dev libicu-dev build-essential git cmake
sudo gem install gollum

That will cover the most basic installation on a local machine. If you are planning to install Gollum on a server, you can follow the third party Gollum installation guide.

:information_source: On Ubuntu 14.04 LTS, the Ruby packages to install are ruby1.9.1 and ruby1.9.1-dev

:information_source: You might also need to manually install github-markdown (e.g. if markdown tables don't render properly. See this issue for more explanation):

sudo gem install github-markdown

Debian

Debian 9.0/8.8

Install gollum system-wide as root:

apt install ruby ruby-dev build-essential zlib1g-dev libicu-dev
gem install gollum

Debian legacy

Install gollum system-wide.

apt-get install build-essential make ruby1.9.3 rubygems ruby-dev \
    libicu-dev zlib1g-dev libicu-dev
gem1.9.3 install gollum

:information_source: Alternatively prefix each command with sudo if you've configured sudo on your debian machine.

CentOS 7

Install gollum system-wide.

sudo yum group install "Development Tools"
sudo yum install ruby ruby-devel libicu libicu-devel zlib zlib-devel git
sudo gem install gollum

Alpine

apk --update add alpine-sdk icu-dev 
gem install gollum 

Windows

Warning: Windows support is still in the works! Many things do not work right now, and many of the tests are currently failing. Proceed at your own risk!

First, install JRuby and then:

~$ gem install gollum

OS X

Install gollum system-wide.

Using Homebrew package manager

This is based on [https://github.com/brianmario/charlock_holmes#homebrew]. Last tested on a Snow Leopard machine.

brew install icu4c
gem install charlock_holmes -- --with-icu-dir=/usr/local/opt/icu4c
gem install gollum

On Yosemite (10.10), there seem to be additional problems installing nokogiri (more can be found here). Working fix seems to be:

sudo gem install nokogiri -v '1.6.6.2' -- --use-system-libraries \
     --with-xml2-include=/usr/include/libxml2 --with-xml2-lib=/usr/lib

macOS High Sierra

xcode-select --install
brew install icu4c
brew install libxml2
sudo gem update --system
sudo gem install charlock_holmes -- --with-icu-dir=/usr/local/opt/icu4c --with-cxxflags=\'-Wno-reserved-user-defined-literal -std=c++11\'
sudo gem install pkg-config
sudo gem install -n /usr/local/bin nokogiri -- --use-system-libraries
sudo gem install -n /usr/local/bin gollum

Use --no-ri with gem install to avoid the long waiting.

Using MacPorts package manager

First install Ruby. Replace <ruby-portname> for the Ruby you wish to install and use (e.g. ruby21 or jruby):

sudo port install ruby_select <ruby-portname>

Then set the installed Ruby as default so that commands like ruby --version can use it:

sudo port select --set ruby <ruby-portname>

Then install gem compilation dependency:

sudo port install icu

For CharlockHolmes, you might try this (assumes standard macports directory /opt/local)

sudo gem install charlock_holmes -- --with-icu-dir=/opt/local/lib/icu \
     --with-opt-include=/opt/local/include/ --with-opt-lib=/opt/local/lib/

And finally, install gollum:

sudo gem install gollum

Troubleshooting

If you get this error:

$ sudo gem install gollum
Fetching: posix-spawn-0.3.13.gem (100%)
Building native extensions.  This could take a while...
ERROR:  While executing gem ... (Errno::EPERM)
    Operation not permitted - /usr/bin/posix-spawn-benchmark

You could try this:

sudo gem install gollum --user-install

--user-install means that the gems (gollum and its dependencies) will be installed user your user home direcory, for example: ~/.gem/ruby/2.0.0/.

So in order to run gollum from that directory, do this:

~/.gem/ruby/2.0.0/bin/gollum

Using Ruby Version Manager (RVM)

Use RVM to install the current version of ruby and use this version as the default ruby command:

sudo rvm install current && rvm use current

Install gem compilation dependency:

sudo port install icu

Install gollum:

sudo gem install gollum
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.