Developer manual: add webvirt chapter

NethServer · Jan 28, 2015 · 883daff · 883daff
1 parent 33cc3d0
commit 883daff
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/developer-manual/en/index.rst b/developer-manual/en/index.rst
@@ -107,6 +107,7 @@ Modules
    web_antivirus
    content_filter
    lightsquid
+   webvirtmgr
 
 Appendix
 --------

diff --git a/developer-manual/en/webvirtmgr.rst b/developer-manual/en/webvirtmgr.rst
@@ -0,0 +1,30 @@
+==========
+WebVirtMgr
+==========
+
+WebVirtMgr is a simple web interface for :index:`libvirt` administration, the main package is ``nethserver-webvirtmgr``.
+
+By default there is a local socket connection named ``localhost``, 
+it's a simply record in SQLite database, the db name is 
+:file:`webvirtmgr.sqlite3` that can be found in :file:`/usr/lib/python2.6/site-packages/webvirtmgr/`.
+
+The webvirtmgr service is handled using upstart, meanwhile webvirtmgr-console is handled by traditional init.d.
+
+Database
+========
+
+Configuration is stored inside ``webvirtmgr`` and ``webvirtmgr-console`` keys in ``configuration`` database.
+
+Properties of ``webvirtmgr``:
+
+* TCPPort: listen TCP port, default is ``8000``
+* User: login user, default is ``admin``
+* Password: password for ``User``, automatically generated during first configuration
+* status: default is ``disabled``
+* access: default is ``private``, do not change for security reasons
+
+Properties of ``webvirtmgr-console``:
+
+* status: default is ``disabled``
+* access: default is ``private``, do not change for security reasons
+