CSS Python JavaScript M4 Shell Makefile Other
Clone or download
Ramon Medeiros and alinefm Add make check to tests
Signed-off-by: Ramon Medeiros <ramon.rnm@gmail.com>
Latest commit 00c1548 May 30, 2018
Permalink
Failed to load latest commit information.
build-aux bug fix: Update genChangelog script Jul 31, 2014
contrib Add an explicit runtime dependency on sudo. Fix #196 Apr 23, 2018
docs Add make check to tests May 31, 2018
m4 Use Autoconf macros AC_PROG_MKDIR_P and MKDIR_P Jan 29, 2014
po Update VERSION, ChangeLog and .po files for 2.5 release Jun 30, 2017
src Use a CDN to get base64.min.js content Sep 7, 2017
tests Use a CDN to get base64.min.js content Sep 7, 2017
ui Remove ui/css/jquery-ui.custom.css as it is not in use by any component Sep 12, 2017
.gitignore Bug fix #191: Add updated lodash.min.js file Dec 13, 2016
.gitmodules Track submodules master branch Dec 2, 2015
.travis.yml Add make check to tests May 31, 2018
ABOUT-NLS build: Add gettext i18n support Jul 30, 2013
AUTHORS Update AUTHORS content according to git-log command Jan 17, 2017
CONTRIBUTE.md Add mailing list information. Feb 13, 2014
COPYING Remove icons only related to Kimchi Sep 12, 2017
COPYING.ASL2 burnet: relicense source tree Jun 20, 2013
COPYING.LGPL Update back-end license to LGPLv2.1 Oct 5, 2015
ChangeLog Update VERSION, ChangeLog and .po files for 2.5 release Jun 30, 2017
IBM-license-blacklist Code clean up Sep 12, 2017
INSTALL build: Add basic autotools infrastructure Jul 30, 2013
Makefile.am Generate dhparams in post-install and development mode Jan 30, 2017
NEWS build: Add basic autotools infrastructure Jul 30, 2013
README.md Display "README" with markdown style on Github Oct 6, 2014
VERSION Update VERSION, ChangeLog and .po files for 2.5 release Jun 30, 2017
autogen.sh Update the header of all Wok back-end files Oct 5, 2015
build-all.sh Update IBM copyright according to check-IBM-license-header.sh script Feb 10, 2016
check-IBM-license-header.sh Add script to verify IBM copyright date Feb 10, 2016
check_spec_errors.sh Issue #116: Suggestion to check spec guidelines Nov 1, 2016
check_ui_code_errors.sh Improve UI error codes checking Jun 16, 2016
config.rpath build: Add basic autotools infrastructure Jul 30, 2013
configure.ac Use a CDN to get base64.min.js content Sep 7, 2017

README.md

Build Status

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
# Or, to make installable .deb packages
$ make deb
# Or, for RPM packages
$ make rpm

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