1. General Prerequisites

This version of Instiki requires Ruby 2.6 or later and Rubygems (1.3.6 or later). For instructions on using Instiki with some popular webhosting services, see here.


Ruby and Rubygems come installed with the commandline tools. Download from the App Store (a free download) and then install the commandline tools, either in the GUI or by typing

xcode-select --install

in a terminal window. You’ll probably want to do a

sudo gem update --system
sudo gem update

to update Rubygems to the latest version, before proceeding.

You can now skip to the next step.


On Debian and Ubuntu, you will need to:

$ sudo apt-get install ruby ruby-dev ri ruby-openssl ruby-sqlite3 rake libxslt1-dev ruby-libxml libsqlite3-dev libxml2-dev swig flex bison

On Fedora, that would be:

$ yum install make ruby ruby-devel rubygems sqlite sqlite-devel swig flex bison

though, apparently, you may need to supply the necessary soft link

$ ln -s /usr/lib/  /usr/lib/


N.b.: If you get a

 install_gem_spec_stubs': undefined method `loaded_specs' for Gem:Module (NoMethodError)

error, when you try to run Instiki, then the version of Rubygems that you installed is too old. See these instructions. In particular, you need to

 sudo gem install rubygems-update
 sudo update_rubygems

to update Rubygems to a sufficiently recent version. (See the discussion here for more insight.)

CentOS is a RedHat-like Linux distro, so you should follow the Fedora instructions above. There are some additional issues that may affect some CentOS installations. See here for details.


Using a Windows-native Ruby build

The RubyInstaller should get you the runtime prerequisites. Their Development kit provides the needed tools to install “native” Rubygems (like sqlite3-ruby and itextomml). It is strongly recommended that the entire path in which Instiki resides not contain any spaces in the directory names, as this will yield a warning message and potential problems.

2. Installing Instiki

Download and untar the latest release, or the current development version. The latter contains many bugfixes and improvements and is the version that is running on this site (so, if you can see this page, you know it’s working).

If you do opt for the development version, you can also get it using bzr:

bzr branch location-of-Instiki/

or Git:

git clone location-of-Instiki/

Then further updates are as easy as doing a `bzr pull` (or git pull).

Make sure that there are no spaces in the pathname leading to the directory where you install Instiki (i.e., that none of the parent directories have spaces in their names).

3. Running Bundler and starting Instiki

Now, from the main instiki directory, type the command

 ruby bundle install --path vendor/bundle

This will download and install the other prerequisites (the sqlite3-ruby bindings, itextomml, etc).


./instiki --daemon

will start up Instiki.

Point your web browser at http://localhost:2500 and start configuring your first wiki!

It’s really that simple.

4. Tikz

If you want the ability to use Tikz on your Instiki wiki, download and install the optional Tikz server. Then follow the instructions for enabling Tikz support.

5. Care and Feeding

You can stop Instiki by issuing a

% kill pid-of-Instiki

There are various Commandline Options that you might want to play with.

For tips on the day-to-day running of Instiki, see the Housekeeping page. For tips on security considerations, see the Security page.