kimchi-project/wokPublic

NotificationsYou must be signed in to change notification settings
Fork77
Star243

A cherrypy framework for multi-purpose plug-ins

github.com/kimchi-project/wok/releases/latest

License

Unknown and 2 other licenses found

Licenses found

243 stars 77 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 2,752 Commits
.github		.github
build-aux		build-aux
contrib		contrib
docs		docs
m4		m4
po		po
src		src
tests		tests
ui		ui
.flake8		.flake8
.gitignore		.gitignore
.gitmodules		.gitmodules
.pre-commit-config.yaml		.pre-commit-config.yaml
ABOUT-NLS		ABOUT-NLS
AUTHORS		AUTHORS
CONTRIBUTE.md		CONTRIBUTE.md
COPYING		COPYING
COPYING.ASL2		COPYING.ASL2
COPYING.LGPL		COPYING.LGPL
ChangeLog		ChangeLog
INSTALL		INSTALL
Makefile.am		Makefile.am
NEWS		NEWS
README.md		README.md
VERSION		VERSION
autogen.sh		autogen.sh
build-all.sh		build-all.sh
check_spec_errors.sh		check_spec_errors.sh
check_ui_code_errors.sh		check_ui_code_errors.sh
config.rpath		config.rpath
configure.ac		configure.ac
dependencies.yaml		dependencies.yaml
requirements-CI.txt		requirements-CI.txt
requirements-dev.txt		requirements-dev.txt
setup.cfg		setup.cfg

Repository files navigation

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 areKimchi(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. TheKimchi community (responsible for Wok project) makes an effort totest it with the latest versions of Chrome and Firefox browsers, but thefollowing 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 conditionsdescribed on the 'Getting Started' section below.

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

Getting Started

Install Dependencies

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

Fedora

First of all, installpython3-pip

sudo dnf install -y python3-pip

Development Dependencies

sudo -H pip3 install -r requirements-dev.txtsudo dnf install -y gcc make autoconf automake git python3-pip python3-requests python3-mock gettext-devel rpm-build libxslt gcc-c++ python3-devel python3-pep8 python3-pyflakes rpmlint python3-pyyaml

Runtime Dependencies

sudo dnf install -y systemd logrotate python3-psutil python3-ldap python3-lxml python3-websockify python3-jsonschema openssl nginx python3-cherrypy python3-cheetah python3-pam python3-m2crypto gettext-devel

Debian

First of all, installpython3-pip

sudo apt install -y python3-pip

Development Dependencies

sudo -H pip3 install -r requirements-dev.txtsudo apt install -y gcc make autoconf automake git python3-pip python3-requests python3-mock gettext pkgconf xsltproc python3-dev pep8 pyflakes python3-yaml

Runtime Dependencies

sudo apt install -y systemd logrotate python3-psutil python3-ldap python3-lxml python3-websockify python3-jsonschema openssl nginx python3-cherrypy3 python3-cheetah python3-pampy python3-m2crypto gettext python3-openssl

Ubuntu

First of all, installpython3-pip

sudo apt install -y python3-pip

Development Dependencies

sudo -H pip3 install -r requirements-dev.txtsudo apt install -y gcc make autoconf automake git python3-pip python3-requests python3-mock gettext pkgconf xsltproc python3-dev pep8 pyflakes python3-yaml

Runtime Dependencies

sudo apt install -y systemd logrotate python3-psutil python3-ldap python3-lxml python3-websockify python3-jsonschema openssl nginx python3-cherrypy3 python3-cheetah python3-pam python3-m2crypto gettext python3-openssl

openSUSE LEAP

First of all, installpython3-pip

sudo zypper install -y python3-pip

Development Dependencies

sudo -H pip3 install -r requirements-dev.txtsudo zypper install -y gcc make autoconf automake git python3-pip python3-requests python3-mock gettext-tools rpm-build libxslt-tools gcc-c++ python3-devel python3-pep8 python3-pyflakes rpmlint python3-PyYAML python3-distro

Runtime Dependencies

sudo zypper install -y systemd logrotate python3-psutil python3-ldap python3-lxml python3-websockify python3-jsonschema openssl nginx python3-CherryPy python3-Cheetah3 python3-python-pam python3-M2Crypto gettext-tools python3-distro

Build and Install

sudo ./autogen.sh --systemmake# Optional if running from the source treesudo make install# Or, to make installable .deb packagesmake deb# Or, for RPM packagesmake rpm

If you are looking for stable versions, there are some packages available athttps://github.com/kimchi-project/wok/releases

Starting up Wok

sudo python3 src/wokd

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

Contributing to Wok Project

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

Issues can be reported atGithub
Patches are always welcome! Please, followthese instructionson how to send patches to the mailing list (kimchi-devel@ovirt.org) or submit a pull request.

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