EasyWiki is a all-in-a-file wiki web application for Rubyists. What that means is that the entire web application is written into a single file that's ~400 lines of code. It's meant to be easy to deploy, maintain and extend.

Now you can install EasyWiki into Heroku in just 3 steps!

1. Sign up for a Heroku account
2. Register a Facebook app
3. Run the installation script and follow the instructions

Here's the list of Easy apps in the same suite:

• EasyBlog - http://github.com/sausheong/easyblog
• EasyWiki - http://github.com/sausheong/easywiki
• EasyForum - http://github.com/sausheong/easyforum

• Authentication through Facebook sign in
• Only authenticated users can contribute to EasyWiki
• Only the author of a page can delete the page
• Has a sitemap of all pages
• Write wiki pages using Creole wiki syntax
• Editing a page creates new version of the page
• Keeps a revision history of all versions to any page ** Can view any past revision ** Can set the page back to any past revision
• Easy 3-step installation script

You need these few things.

You will need to sign up for a Heroku account. If you are using the installation script, you will need to get the Heroku API key from https://dashboard.heroku.com/account before you start using the script.

EasyWiki integrates with Facebook for authentication. Create a Facebook app through http://developers.facebook.com. Then look out for the App ID and App Secret. If you are using the installation script, you will be asked for these two pieces of information. Please remember to set your Facebook app to integrate with your wiki through 'Website with Facebook Login', with the Site URL set to http://[your app name].herokuapp.com:80/

If you have entered the wrong ID and secret, you can set them again. Use the values to set the environment variables FACEBOOK_APP_ID and FACEBOOK_APP_SECRET accordingly.

Don't like Facebook? Deal with it, or modify it to integrate with what you like or write your own authentication mechanism. Simply change the /auth/login route and there you go.

By default anyone can write in the wiki, as long as they authenticate themselves first (with Facebook). Optionally you can set it such that only certain people in your whitelist of authors can write. Set the environment variable WHITELIST to a comma-delimited list of Facebook usernames (no spaces before or after the comma please). If you want to be the only one who can write, just put in your Facebook username. For eg. my Facebook username is 'sausheong' so that's the WHITELIST setting for me if I want only myself to write to the wiki. Once you have done that, only people in the whitelist can write into the wiki.

Only the Facebook account is really needed, everything else is optional. Here are some other environment variables you might want to set:

• BOOTSTRAP_THEME - A URL to the Bootstrap CSS stylesheet you want to use instead of the default. I used the Journal theme from Bootswatch. The default is the default Bootstrap stylesheet
• WIKI_NAME - A string to name your wiki. The default is 'EasyWiki'

Add the configuration settings using heroku config:add <env variable>=<value>. For a fuller explanation please refer to https://devcenter.heroku.com/articles/config-vars

The fastest way to install is to run the installation script and follow the instructions.

> ruby ./install.rb

Then enter the Heroku API key, Facebook App ID and App Secret when asked. At the end of the script you will be provided with your new wiki!