Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.58 KB

README.rdoc

File metadata and controls

55 lines (40 loc) · 1.58 KB
Raw

Raki ↑

Raki is a extensible wiki written using the Ruby on Rails framework. It can use different backends to store pages and attachments or multiple backends for different namespaces. It can also have a namespace-specific syntax.

Authors

  • Florian Schwab

  • Martin Sigloch

Contributors

  • Aaron Mueller

  • Benjamin Schweizer

  • Fabian Fingerle

  • Martin Kirst

Dependencies ↑

Raki core ↑

$ gem install rails -v=3.1
$ gem install mime-types

GIT provider ↑

$ gem install unicode

Raki parser ↑

$ gem install treetop

OpenID authenticator ↑

$ gem install ruby-openid (NOT "openid")

Installation & Configration (core) ↑

Rename/copy the file config/database.yml.example to config/database.yml and edit the credentials for the database if necessary. Now rename/copy the file config/raki.yml.example to config/raki.yml and edit it to fit your needs. Run rake db:migrate to create all necessary tables. To generate the precompiled JavaScript and CSS files, use rake assets:precompile in the production mode.

Example with GIT as storage, OpenID for authentication and file-based ↑

authorization Create a GIT repository with git init --bare /path/to/git-repo. Now change in config/raki.yml the path parameter to match the GIT repository you just created. Then change the authenticator to openid. The last step is to rename/copy the file config/permissions.yml.example to config/permissions.yml and change the permissions if necessary.

Run it ↑

$ touch tmp/restart.txt
$ script/server