Documentation.
This commit is contained in:
Julien Fontanet
parent
e5f752b5fa
commit
3ec9dc0a45
12
README.md
12
README.md
@ -5,16 +5,16 @@ XO is a web interface to visualize and administrate your XenServer (or XAPI enab
|
||||
It aims to be easy to use on any device supporting modern web technologies (HTML 5, CSS 3, JavaScript) such as your desktop computer or your smartphone.
|
||||
|
||||
XO is developped by [Vates SAS](https://vates.fr) a small French company and released under the [AGPL v3](http://www.gnu.org/licenses/agpl-3.0-standalone.html) licence.
|
||||
|
||||
a
|
||||
__XO is currently under development and may be subject to important bugs.__
|
||||
|
||||
## How to try XO?
|
||||
## Documentation
|
||||
|
||||
XO is composed of two parts (the server and the interface) which have their own repositories.
|
||||
* [Installation](./installation.md)
|
||||
* [Known bugs](./known-bugs.md)
|
||||
|
||||
The server is available at https://github.com/vatesfr/xo-server and the interface at https://github.com/vatesfr/xo-web.
|
||||
|
||||
Check their documentation to see how to use them.
|
||||
* [How to contribute?](./contributing.md)
|
||||
* [Architecture overview](./architecture.md)
|
||||
|
||||
## How to report a bug?
|
||||
|
||||
|
||||
21
contributing.md
Normal file
21
contributing.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Contributing
|
||||
|
||||
XO is an Open Source project released under the [AGPL v3](http://www.gnu.org/licenses/agpl-3.0-standalone.html) licence, contributions are therefore very welcome.
|
||||
|
||||
## Bug reports
|
||||
|
||||
Xen Orchestra has three bugtrackers:
|
||||
|
||||
* [one for the server](https://github.com/vatesfr/xo-server/issues);
|
||||
* [one for the interface](https://github.com/vatesfr/xo-web/issues);
|
||||
* [and the last one](https://github.com/vatesfr/xo/issues) for common issues or when you don't know to which part it is related to.
|
||||
|
||||
Feel free to report issues or features you miss.
|
||||
|
||||
## Documentation / Code
|
||||
|
||||
Using Github fork/pull-request feature, you may send us some fixes or enhancements.
|
||||
|
||||
Please, do explain:
|
||||
* what you are fixing (issue number if available);
|
||||
* how you did it.
|
||||
67
installation.md
Normal file
67
installation.md
Normal file
@ -0,0 +1,67 @@
|
||||
# Installation
|
||||
|
||||
As you may have seen, in other parts of the documentation, XO is composed of two parts: [XO-Server](https://github.com/vatesfr/xo-server/) and [XO-Web](https://github.com/vatesfr/xo-web/).
|
||||
|
||||
They can be installed separatly, even on different machines, but for the sake of simplicity we will set them up together.
|
||||
|
||||
## Fetching the Code
|
||||
|
||||
You may either download them [here](https://github.com/vatesfr/xo-server/archive/master.zip) and [here](https://github.com/vatesfr/xo-web/archive/master.zip) or use `git` with these repositories from `git://github.com/vatesfr/xo-server.git` and `git://github.com/vatesfr/xo-web.git`.
|
||||
|
||||
## Installing dependencies
|
||||
|
||||
The only dependency you have to install by yourself is [Node.js](http://nodejs.org). For more information you may check [this page](http://nodejs.org/download/).
|
||||
|
||||
Once you have it, you can use `npm` to install the other dependencies: for both XO-Server and XO-Web, go into their respective folder and launch the following command:
|
||||
|
||||
npm install
|
||||
|
||||
## Making XO-Web accessible from XO-Server
|
||||
|
||||
XO-Server embeds an HTTP server which can be used to delivers XO-Web.
|
||||
|
||||
We are going to use this feature because it dispenses us from having to configure XO-Server's URL in XO-Web.
|
||||
|
||||
All you have to do is link all XO-Web's files in the `public/` directory from XO-Server's `public/http/` directory.
|
||||
|
||||
## Running XO
|
||||
|
||||
The sole part you have to launch is XO-Server which is quite easy to do, just launch the `xo-server` script.
|
||||
|
||||
You may now open http://localhost:8080/ and starts using it.
|
||||
|
||||
## All-in-one script
|
||||
|
||||
This script has been tested on Debian Wheeze, it may requires some adaptation for your system.
|
||||
|
||||
```bash
|
||||
# Installs everything in this directory, you may move it afterward.
|
||||
mkdir /tmp/xo
|
||||
cd /tmp/xo
|
||||
|
||||
# Fetches the Code.
|
||||
git clone git://github.com/vatesfr/xo-server.git
|
||||
git clone git://github.com/vatesfr/xo-web.git
|
||||
|
||||
# Installs dependencies.
|
||||
sudo apt-get install nodejs npm
|
||||
|
||||
cd xo-server
|
||||
npm install
|
||||
cd ..
|
||||
|
||||
cd xo-web
|
||||
npm install
|
||||
cd ..
|
||||
|
||||
# Makes XO-Web accessible from XO-Server.
|
||||
cd xo-server/public/http
|
||||
for e in ../../xo-web/public/*
|
||||
do
|
||||
ln -s "$e"
|
||||
done
|
||||
cd ../../..
|
||||
|
||||
# Runs XO.
|
||||
./xo-server/xo-server
|
||||
```
|
||||
21
known-bugs.md
Normal file
21
known-bugs.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Known bugs
|
||||
|
||||
XO is currently under development and contains various known bugs/limitations.
|
||||
|
||||
We will try to list the most important here so that you know what to expect if you try it and that we are planning to fix them :)
|
||||
|
||||
# No persistence
|
||||
|
||||
Each time you shutdown XO-Server, the configuration will be lost (added servers, users, etc.).
|
||||
|
||||
# VNC Console
|
||||
|
||||
The VNC console works on Firefox but not on Chromium, furthermore it has not been tested with other browsers.
|
||||
|
||||
There are also lots of minor bugs such as:
|
||||
* Duplicate key inputs (refresh the page if it happens).
|
||||
* Links on the navigation bar are sometimes unclickable.
|
||||
|
||||
# Non refresh-proof authentication
|
||||
|
||||
If you refresh the page, you have to re-authenticate yourself.
|
||||
Loading…
Reference in New Issue
Block a user