Skip to content


Repository files navigation


Instiki is a wiki clone so pretty and easy to set up, you'll wonder if it’s really a wiki. Runs on Rails and focuses on portability and stability. Supports file uploads, PDF export, RSS, multiple users and password protection. Some use Instiki as a CMS (Content Management System) because of its ability to export static pages.

Instiki lowers the barriers of interest for when you might consider using a wiki. It's so simple to get running that you'll find yourself using it for anything -- taking notes, brainstorming, organizing a gathering.

Supported Platforms

Instiki only requires a working Ruby installation (it includes all other dependencies). Any OS that can run Ruby can run Instiki - that includes Windows, Linux, Mac OS X and most known Unix flavors.

3 easy Steps to get the Instiki experience

Step 1. Get Instiki and run "ruby bundle install --path vendor/bundle" Step 2. Run "instiki" Step 3. Chuckle... "There's no step three!" (TM)


You need at least Ruby Version 2.0 installed on your System. Instiki is known to work well with Ruby 2.0-2.6. The second dependency is a Database System, but don't worry, the default sqlite3 will be installed for you, if it's not already installed. You can also use any other database system (MySQL, PostgreSQL, ...) supported by Rails.

Deploy to Heroku

  • git clone
  • cd instiki
  • heroku create [APPNAME]
  • mv Gemfile Gemfile.orig
  • git mv Gemfile.heroku Gemfile
  • git mv Gemfile.lock.heroku Gemfile.lock
  • git commit -m "Setup for heroku"
  • git push heroku master
  • heroku config:set RAILS_ENV=production
  • heroku run rake db:migrate

If you are on Windows

If you are on Mac OSX

On Snow Leopard (10.6) or later, you are all set.

  • run "sudo gem update --system" via the command-line.
  • run "ruby bundle install --path vendor/bundle" in the instiki directory.
  • run "ruby instiki" and there you go!

If you are on Linux

Any other System

  • get Ruby for your System, compile if necessary:

  • Depending on the version of Rubygems that came with your Ruby, you may need to

    sudo gem update --system

  • get SQLite or compile from (you can also use mysql or any other supported database system if you want)

  • run "ruby bundle install --path vendor/bundle"

  • run instiki

You're now running a perfectly suitable wiki on port 2500 that'll present you with one-step setup, followed by a textarea for the home page on http://localhost:2500


  • Regular expression search: Find deep stuff really fast
  • Revisions: Follow the changes on every page from birth. Rollback to an earlier rev
  • Export to HTML or markup in a zip: Take the entire wiki with you home or for reference
  • RSS feeds to track recently revised pages
  • Multiple webs: Create separate wikis with their own namespace
  • Password-protected webs: Keep it private
  • Authors: Each revision is associated with an author, so you can see who changed what
  • Reference tracker: Which other pages are pointing to the current?
  • Five markup choices: Markdown-based choices []: Markdown+itex2MML (the default; uses itex2MML) Markdown+BlahTeX/PNG (requires blahtex and a working TeX installation) Markdown Textile [] RDoc []
  • Support for Math (using itex syntax)
  • Support for WYSIWYG SVG editing -- embed SVG graphics right in your wiki page.
  • Embedded webserver: uses Mongrel (if installed), or the bundled WEBrick webserver (if not).
  • Internationalization: Wiki words in any latin, greek, cyrillian, or armenian characters
  • Color diffs: Track changes through revisions
  • Runs on SQLite3 per default, can be configured to run on PostgreSQL, MySQL, DB2, Firebird, Openbase, Oracle, SQL Server or Sybase
  • Optional support for Tikz pictures. Requires an optional install. See here for details.

Command-line options:

  • Run "ruby instiki --help"



Migrating from Instiki 0.11-0.19 to 0.20

ruby bundle install --path vendor/bundle
ruby bundle exec rake upgrade_instiki

Download the latest release from:

Visit the Instiki wiki:

Visit the Instiki users forum


  • same as Ruby's


Versions 0.0 to 0.9.1:: David Heinemeier Hansson Email:: david[AT] Weblog:: ([]

From 0.9.2 onwards:: Alexey Verkhovsky Email:: alex[AT]

From 0.11 onwards:: Matthias Tarasiewicz and Email:: parasew[AT] Website:: ([]

From 0.13 onwards:: Matthias Tarasiewicz and Jacques Distler Email:: jdistler-instiki[AT] Weblog Jacques: Weblog Parasew: