How to install Kimchi on ClearOS

2021-07-20: WikiSuite will now support all major Linux distros. Thus, the information below is no longer updated. It may still be valid, or not. It will be eventually removed from this site, so anything relevant should be moved to the appropriate site. For anything related to ClearOS, please search among the following: ClearOS site, code base, Developer docs, Wiki or forum.

Please contact us if you would like to help out.

Kimchi is an HTML5 based management tool for the KVM virtualization infrastructure. Permits access via the Spice protocol or VNC

Status as of 2017-11-24: The apps is complete. Next step is to ask both ClearOS and Kimchi communities to test extensively.

Your server must support virtualization. You will see a warning if this is not the case.

  1. Install a ClearOS system
  2. Register the ClearOS system (to configure the CentOS/EPEL repos properly)
  3. Run:
    yum install app-kimchi
  4. Open up firewall port TCP / 8001 at ClearOS -> Firewall -> Incoming Firewall -> Allowed Incoming Connections (https://example.org:81/app/incoming_firewall)
  5. Reboot your server
  6. Visit Server -> Virtualization -> Kimchi in the ClearOS admin panel ( or directly https://example:81/app/kimchi )
  7. Make sure Kimchi is running
  8. Follow the link to access the Kimchi Admin Console (https://example.org:8001/)

2017 08 19 Kimchi Admin Panel

When you log into the Kimchi/Wok web interface, you might only have the "Wok' and 'Host' tabs, but not the "Virtualization" tab (screenshot:) . This will be the case if the underlying hardware does not support KVM.


  1. https://example:8001/#plugins/kimchi/tabs/network
  2. Add a network
    • Network Type: "Bridged: Virtual machines are connected through a network bridge"
    • Destination: Use a different network interface than the main one used by ClearOS

Known issues

  • ISO templates don't work, so you need to SFTP the ISOs on the server.
    • Create a sub-directory of /var/lib/libvirt
    • Upload ISO there (or wget them to there)
    • Use that path when creating a virtual machine template