ngocdaothanh / openkh
OpenKH (KH = Know-How) is a bliki based on Rails 2.3. It best suits open communities to share knowledge.
Home
For users
- Demo: http://openkh.cntt.tv
- Download: http://github.com/ngocdaothanh/openkh/downloads
- Bug report: http://github.com/ngocdaothanh/openkh/issues
- Mailing list: http://rubyforge.org/mail/?group_id=3480
Installation
You should have some experience with deploying Rails applications (see http://rubyonrails.org/deploy) to successfully installing OpenKH. If you have trouble installing OpenKH, you may ask for help at the mailing list.
Requirements:
- ruby 1.8.7
- gem 1.3.1+
- PostgreSQL or MySQL
Steps:
- Download latest ZIP file from RubyForge (if you think the file is old, please try the lastest source code, see the installation instruction for developers below)
- Change to OpenKH directory
- Copy config/conf.rb.sample to config/conf.rb and make proper modification
- Copy config/database.yml.sample_sqlite3 (or postgresql, mysql) to config/database.yml and make proper modification, then create the DB. 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=<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=<module> and delete its directory
- Restart OpenKH after installing/uninstalling
Theme
There are many themes in the directory “themes”. To switch theme:
- Run rake user:theme 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.
- Task for core developers: http://rubyforge.org/pm/?group_id=3480
Installation
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
