/wok

WoK - Webserver of Kimchi - a cherrypy framework for multi-purpose plug-ins

Primary LanguageCSSOtherNOASSERTION

What is Wok?

Wok is a cherrypy-based web framework with HTML5 support originated from Kimchi. It can be extended by plugins which expose functionality through REST APIs.

Examples of such plugins are Kimchi (Virtualization Management); Ginger Base (Basic host management) and; Ginger (System Administration).

Wok runs through wokd daemon.

Browser Support

Wok and its plugins can run in any web browser that supports HTML5. The Kimchi community (responsible for Wok project) makes an effort to test it with the latest versions of Chrome and Firefox browsers, but the following list can be used as reference to browser support.

Desktop Browser Support:

  • Internet Explorer: Current version
  • Chrome: Current version
  • Firefox: Current version
  • Safari: Current version
  • Opera: Current version

Mobile Browser Support:

  • Safari iOS: Current version
  • Android Browser Current version

Linux Support

Wok might run on any GNU/Linux distribution that meets the conditions described on the 'Getting Started' section below.

The Kimchi community (responsible for Wok project) makes an effort to test it with the latest versions of Fedora, RHEL, openSUSE, and Ubuntu.

Getting Started

Install Dependencies

In order to have Wok running as expected in your system, please make sure to have all the dependencies installed before building Wok or starting up the wokd service.

Build and Install

$ ./autogen.sh --system
$ make

# Optional if running from the source tree
$ sudo make install

Starting up Wok

$ sudo python src/wokd

To access Wok, please, connect your browser to https://localhost:8001.

Contributing to Wok Project

There are a lof of ways to contribute to the Wok Project:

Find more information about Wok Project at https://github.com/kimchi-project/wok/wiki