forked from kimchi-project/kimchi
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add improved README with screenshots
Signed-off-by: Anthony Liguori <[email protected]>
- Loading branch information
Anthony Liguori
committed
Jun 27, 2013
1 parent
59a94c8
commit c812468
Showing
3 changed files
with
62 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,64 @@ | ||
Project Burnet | ||
Kimchi Project | ||
============== | ||
|
||
More details to come! | ||
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. | ||
|
||
Getting Started | ||
=============== | ||
|
||
Install Dependencies | ||
-------------------- | ||
|
||
$ sudo yum install python-cherrypy python-cheetah \ | ||
python-imaging python-polib | ||
|
||
Build and Install | ||
----------------- | ||
|
||
$ sudo python setup.py install | ||
|
||
Run | ||
--- | ||
|
||
$ sudo burnetd --host=0.0.0.0 | ||
|
||
Usage | ||
----- | ||
|
||
Connect your browser to localhost:8000. You should see a screen like: | ||
|
||
![Kimchi Guest View](/docs/kimchi-guest.png) | ||
|
||
This shows you the list of running guests including a live screenshot of | ||
the guest session. You can use the action buttons to shutdown the guests | ||
or connect to the display in a new window. | ||
|
||
To create a new guest, click on the "+" button in the upper right corner. | ||
In Kimchi, all guest creation is done through templates. | ||
|
||
You can view or modify templates by clicking on the Templates link in the | ||
top navigation bar. | ||
|
||
The template screen looks like: | ||
|
||
![Kimchi Template View](/docs/kimchi-templates.png) | ||
|
||
From this view, you can change the parameters of a template or create a | ||
new template using the "+" button in the upper right corner. | ||
|
||
Known Issues | ||
------------ | ||
|
||
Kimchi is still experimental and should not be used in a production | ||
environment. | ||
|
||
Participating | ||
------------- | ||
|
||
All patches are sent through our mailing list hosted at Google Groups. More | ||
information can be found at: | ||
|
||
https://groups.google.com/forum/#!forum/project-kimchi | ||
|
||
Patches should be sent using git-send-email. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.