ngocdaothanh edited this page Sep 19, 2010 · 98 revisions

For users


You should have some experience with deploying Rails applications (see http://rubyonrails.org/deploy) to successfully installing OpenKH.


  • Ruby 1.9.2
  • Rails 3
  • PostgreSQL or MySQL


  • Download
  • Change to OpenKH directory
  • Copy config/conf.rb.sample to config/conf.rb and make proper modification
  • Copy config/database.yml.sample_{postgresql, mysql} to config/database.yml and make proper modification, then create the DB accordingly. You may create DB by running rake db:create if the user you specify has enough permission.
  • Run rake gems to see the list of required gems, and run rake gems:install to install
  • Read README.html for information
  • Install OpenKH: rake user:install
  • To add demo data (with an account with user name “admin” password “admin”): rake user:demo
  • Start OpenKH as a normal Rails application

Install/uninstall module

OpenKH has an open structure. You may find extended modules on the Internet.

  • To install an extended module, copy it to modules/extended directory and run: rake user:module:install MODULE=
  • If the module has the file README.textile, you may need to update README.html by running: rake user:readme
  • To uninstall, run: rake user:module:uninstall MODULE= and delete its directory
  • Restart OpenKH after installing/uninstalling


There are many themes in the directory “themes”. To switch theme:

  • Run rake user:theme THEME=
  • Restart OpenKH

OpenKH has an open structure. You may find extended themes on the Internet.

  • To install an extended theme, copy it to themes directory
  • To switch theme, do as above
  • To uninstall a theme, just delete its directory

Search engine

For developers

You should be a user before becoming a developer, please read the part for users above.

There are 3 kinds: core core development, module development, and theme development. Only *nix environment is supported for development.

After installing, you can start creating modules, themes, or modifying the core.


After checking out the latest source code using Git (you should be familiar with Git):

  • Rails and many plugins are installed as git submodules (OpenKH always tries to use latest technologies): git submodule init && git submodule update
  • To download additional things and create additional directories (these have been prepared in the ZIP file for users): rake developer:prepare
  • Perform installation as instructed in the part for users above




Only ones who have committed are listed.