Provided by: kimchi_1.5.0-0ubuntu1_amd64 
NAME
Kimchi - HTML5 based management tool for KVM
SYNOPSIS
kimchid [-h|--help] [--host host] [--port port] [--ssl-port ssl_port] [--cherrypy_port
cherrypy_port] [--log-level log_level] [--access-log access_log] [--error-log error_log]
[--environment environment] [--federation federation] [--test]
DESCRIPTION
Kimchi is an HTML5 based management tool for KVM. It is designed to make it as easy as
possible to get started with KVM and create your first guest. kimchid launches the daemon
on the hypervisor host which manages KVM guests through libvirt. The management interface
is accessed over the web using a browser that supports HTML5.
OPTIONS
The following options are supported:
-h , --help
Show this help message and exit.
--host host
Specify the hostname or IP to listen on.
--port port
Specify the HTTP port (default 8000).
--ssl-port ssl_port
Specify the HTTPS port (default 8001).
--cherrypy_port cherrypy_port
Specify the Cherrypy server port (default 8010).
--log-level [debug | info | warning | error | critical]
Specify the log level (default debug).
--access-log access_log
Specify the access log location where kimchi should create the access log file.
--environment [development | production]
Specify the running environment of kimchi server. Check cherrypy documentation for
more details (default production).
--federation [on | off]
Register and discover Kimchi peers in the same network using OpenSLP. Check below
the FEDERATION section for more details (default off).
--test Run kimchi on a mock version that does not affect the system. For testing
proposals.
FEDERATION
Federation feature is a mechanism to discover Kimchi peers in the same network. It uses
OpenSLP tool (http://www.openslp.org/) to register and find the Kimchi servers.
By default this feature is disabled on Kimchi as it is not critical for KVM virtualization
and requires additional software installation.
To enable it, do the following:
1. Install OpenSLP server package
2. OpenSLP uses port 427 (UDP) and port 427 (TCP) so make sure to open those
ports in your firewall configuration
For system using firewalld, do:
sudo firewall-cmd --permanent --add-port=427/udp
sudo firewall-cmd --permanent --add-port=427/tcp
sudo firewall-cmd --reload
For openSUSE systems, do:
sudo /sbin/SuSEfirewall2 open EXT TCP 427
sudo /sbin/SuSEfirewall2 open EXT UDP 427
For system using iptables, do:
sudo iptables -A INPUT -p tcp --dport 427 -j ACCEPT
sudo iptables -A INPUT -p udp --dport 427 -j ACCEPT
3. In addition to the OpenSLP ports, you also need to allow multicast in the
firewall configuration
For system using firewalld, do:
sudo firewall-cmd --direct --add-rule ipv4 filter INPUT 0 -s <subnet> -j ACCEPT
For openSUSE systems, do:
Add the subnet to the trusted networks listed on FW_TRUSTED_NETS in
/etc/sysconfig/SuSEfirewall2 file.
Make sure to restart /sbin/SuSEfirewall2 after modifying /etc/sysconfig/SuSEfirewall2
For system using iptables, do:
sudo iptables -A INPUT -s <subnet> -j ACCEPT
4. Start slpd service and make sure it is up while running Kimchi
sudo service slpd start
5. Enable federation on Kimchi by editing the /etc/kimchi/kimchi.conf file:
federation = on
6. Then start Kimchi service
sudo service kimchid start
The Kimchi server will be registered on OpenSLP on server starting up and will be found by
other Kimchi peers (with federation feature enabled) in the same network.
LICENCE
Kimchi is distributed pursuant to the terms of two different licenses. The user interface
(located in ui/ in this distribution) is governed by the Apache License version 2.0.
The code under ui/spice-html5 is imported from spice-html5 project
(http://cgit.freedesktop.org/spice/spice-html5) and the code under ui/libs which is
imported from JQuery UI (http://jqueryui.com)
The rest of this distribution is governed by the GNU Lesser General Public License version
3.
See COPYING.LGPL and COPYING.ASL2.
BUGS
Current bugs can be found here : https://github.com/kimchi-project/kimchi/issues
If you find any, please open an issue : https://github.com/kimchi-
project/kimchi/issues/new
AUTHOR
Adam King <rak@linux.vnet.ibm.com>, Adam Litke <agl@linux.vnet.ibm.com>, Adriano Botega
<abotega@linux.vnet.ibm.com>, Alexandre Tanaka Hirata <hirata@linux.vnet.ibm.com>, Aline
Manera <alinefm@br.ibm.com>, apporc <appleorchard2000@gmail.com>, Anthony Liguori
<aliguori@us.ibm.com>, Bing Bu Cao <mars@linux.vnet.ibm.com>, Christy Perez
<christy@linux.vnet.ibm.com>, Cole Robinson <crobinso@redhat.com>, CrÃstian Viana
<vianac@linux.vnet.ibm.com>, Daniel H Barboza <danielhb@linux.vnet.ibm.com>, Eduardo Elias
Ferreira <edusf@linux.vnet.ibm.com>, Eli Qiao(Li Yong Qiao) <taget@linux.vnet.ibm.com>,
Hongliang Wang <hlwang@linux.vnet.ibm.com>, Leonardo Garcia <lagarcia@br.ibm.com>, Lise
Noble <lwnoble@us.ibm.com>, Malcolm Yu <minghaoyusombie@gmail.com>, Mark Wu
<wudxw@linux.vnet.ibm.com>, Mei Na Zhou <zhoumein@linux.vnet.ibm.com>, Paulo Vital
<pvital@linux.vnet.ibm.com>, Pradeep K Surisetty <psuriset@linux.vnet.ibm.com>, Ramon
Medeiros <ramonn@linux.vnet.ibm.com>, Rodrigo Trujilo
<rodrigo.trujillo@linux.vnet.ibm.com>, Royce Lv <lvroyce@linux.vnet.ibm.com>, ShaoHe Feng
<shaohef@linux.vnet.ibm.com>, Shu Ming <shuming@linux.vnet.ibm.com>, Toby Allsopp
<toby@MI6.GEN.NZ>, Tony Breeds <tonyb@au1.ibm.com>, Xin BJ Ding <xinding@cn.ibm.com>, Yu
Xin Huo <huoyuxin@linux.vnet.ibm.com>, Zhou Zheng Sheng <zhshzhou@linux.vnet.ibm.com>,