README update.

This commit is contained in:
Julien Fontanet 2013-02-08 10:37:40 +01:00
parent 2d483150e6
commit 5d59616d01

View File

@ -1,15 +1,22 @@
Xo-web
======
# Xen Orchestra Web
Xo-web is a web client for Xo-server. This is a DRAFT for testing purpose ONLY. Be advised this is a Alpha version, code WILL fluctuate.
XO-Web is part of [Xen Orchestra](https://github.com/vatesfr/xo), a web interface for [XCP](https://en.wikipedia.org/wiki/Xen_Cloud_Platform).
Global concept
--------------
It is a web client for [XO-Server](https://github.com/vatesfr/xo-web).
Please refer to global architecture article here: https://xen-orchestra.com/first-running-prototype-is-here/
__XO is currently under development and may be subject to important bugs.__
Bug report
----------
## Installation
If you don't know where your issue is coming from (Xo-web or Xo-server), please consider report your stuff on global repo here: https://github.com/vatesfr/xo
_There is currently no package available for XO-Web, you must therefore use the following procedure._
1. Download the code, you may either use git `git clone git://github.com/vatesfr/xo-web` or download a [Zip archive](https://github.com/vatesfr/xo-web/archive/master.zip).
2. XO-Web uses [Composer](https://getcomposer.org) for its dependency management, so, once you have [installed it](https://getcomposer.org/download/), juste run `php composer.phar install`.
3. Copy `src/config/local.php.dist` to `src/config/local.php` and complete the configuration.
4. Makes sure the `src/www` directory and all its content is available from your web server.
## How to report a bug?
If you are certain the bug is exclusively related to XO-Web, you may use the [bugtracker of this repository](https://github.com/vatesfr/xo-web/issues).
Otherwise, please consider using the [bugtracker of the general repository](https://github.com/vatesfr/xo/issues).