NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More language changes and tweaks

Browse Source
This commit is contained in:
Rob Gormley 2015-02-19 14:59:11 -08:00
parent 0e7b053798
commit 3febe34221
9 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -4,7 +4,7 @@ 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](https://vates.fr), a French company specialized in Open Source, and released under the [AGPL v3](http://www.gnu.org/licenses/agpl-3.0-standalone.html) licence.
XO is developed by [Vates](https://vates.fr), a French company specializing in Open Source, and released under the [AGPL v3](http://www.gnu.org/licenses/agpl-3.0-standalone.html) license.
__XO is evolving fast, so check the [known bugs](./doc/known_bugs/README.md) file first.__

16
doc/administration/README.md
View File

@ -4,13 +4,13 @@ Once Xen Orchestra is installed, you can configure some parameters in the config
## Configuration
The configuration file is in XO-server folder (for XOA users, it's in `/etc/xo-server/config.yaml`). If it's not already done, copy this file to `local.yaml` in the same folder. Now, you can edit the configuration safely (if you destroy it, you can reuse the dist file).
The configuration file is in the XO-server folder (for XOA users, it's in `/etc/xo-server/config.yaml`). If it's not already done, copy this file to `local.yaml` in the same folder. Now, you can edit the configuration safely (if you destroy it, you can reuse the dist file).
WARNING: YAML is very strict with indentation: use spaces for it, not tabs.
WARNING: YAML is very strict with indentation: use spaces, not tabs.
### User to run XO-server as
By default, XO-server is running with 'nobody' user and 'nogroup' group. You can change it by uncommenting these lines and choose whatever user/group you want:
By default, XO-server is running with 'nobody' user and 'nogroup' group. You can change that by uncommenting these lines and choose whatever user/group you want:
```yaml
user: 'nobody'
@ -28,7 +28,7 @@ port: 80
### HTTPS
XO-server can also run in HTTPS (both HTTP and HTTPS can cohabit), just modify what's needed in the `# Basic HTTPS` section, this time with certificates/keys you want and their path:
XO-server can also run in HTTPS (both HTTP and HTTPS can cohabit) - just modify what's needed in the `# Basic HTTPS` section, this time with certificates/keys you want and their path:
```yaml
host: '0.0.0.0'
@ -39,7 +39,7 @@ key: './key.pem'
### Link to XO-web
On XOA, you shouldn't have to change this. On manual install, you need to link files served by XO-server for XO-web. That's the mount section. In this example, "xo-web" folder is in the same folder than "xo-server":
On XOA, you shouldn't have to change this. On a manual install, you need to link files served by XO-server for XO-web. That's the mount section. In this example, "xo-web" folder is in the same folder than "xo-server":
```yaml
mounts:
@ -57,7 +57,7 @@ By default, XO-server will try to contact Redis server on `localhost`, with the
### Log file
On XOA, the log file for XO-server is in `/var/log/xo`: it has all of the server informations. Can be a real help when you have trouble.
On XOA, the log file for XO-server is in `/var/log/xo`. It contains all the server information returned and can be a real help when you have trouble.
## First connection
@ -67,7 +67,7 @@ This is the login screen:
![](./assets/loginok.png)
Note the green *check* icons: it indicates that you are correctly connected to XO-server. If you see this icon: ![](./assets/loginbad.png), that's not good. Please check the Troubleshooting section if it's the case.
Note the green *check* icons: it indicates that you are correctly connected to XO-server. If you see this icon: ![](./assets/loginbad.png), then please check the Troubleshooting section.
The default user login/password is `admin@admin.net` with `admin` password. This is what you should see after been logged:
@ -77,7 +77,7 @@ The default user login/password is `admin@admin.net` with `admin` password. This
## Users and passwords
You can access users ans servers management in the Setting view. It's accessible from the main menu:
You can access users and servers management in the Setting view. It's accessible from the main menu:
![](./assets/gosettings.png)

12
doc/architecture/README.md
View File

@ -4,13 +4,13 @@ This part is dedicated to the architecture of Xen Orchestra. It will give you hi
## Overview
Here is a diagram giving an overview of what is Xen Orchestra:
Here is a diagram giving an overview of what Xen Orchestra is:
![](./assets/xo-arch.jpg)
Xen Orchestra is split in modules:
- the core is "[xo-server](https://github.com/vatesfr/xo-server)", a daemon dealing directly with XenServer or XAPI capable hosts. This is where are stored users, and it's the center point for talking to your whole Xen infrastructure.
- the Web interface is in "[xo-web](https://github.com/vatesfr/xo-web)": you are running it directly in your browser. The connection with "xo-server" is done via *WebSockets*
- "[xo-cli](https://github.com/vatesfr/xo-cli)" is a new module allowing to send order directly in command line
- the core is "[xo-server](https://github.com/vatesfr/xo-server)", a daemon dealing directly with XenServer or XAPI capable hosts. This is where users are stored, and it's the center point for talking to your whole Xen infrastructure.
- the Web interface is in "[xo-web](https://github.com/vatesfr/xo-web)": you are running it directly in your browser. The connection with "xo-server" is done via *WebSockets*.
- "[xo-cli](https://github.com/vatesfr/xo-cli)" is a new module allowing to send commands directly from the command line.
We will use this modular architecture to add further parts later. It's completely flexible, allowing us to adapt Xen Orchestra in every existing work-flow.
@ -44,13 +44,13 @@ With XO < 3.4, we used events in this way:
![](./assets/semievent.jpg)
But interface was still lagging behind the server. At least, with XO 3.4, we got a full event system, allowing instant display of what's happening on your infrastructure:
But interface was still lagging behind the server. With XO 3.4, we got a full event system, allowing instant display of what's happening on your infrastructure:
![](./assets/fullevent.jpg)
### Pluggable
It's really easy to plug other modules to XO-server, thus extend or adapt the solution to your needs (see XO-web and XO-cli for real examples).
It's really easy to plug other modules to XO-server, and extend or adapt the solution to your needs (see XO-web and XO-cli for real examples).
### NodeJS under the hood

4
doc/architecture/architecture.md
View File

@ -78,13 +78,13 @@ The client's only role is to provide an easy-to-use yet powerful interface to us
Used for communication between the server and its clients.
WebSocket has been choosen because it is a full-duplex real-time protocol implemented in web browsers.
WebSocket has been chosen because it is a full-duplex real-time protocol implemented in web browsers.
### [Node.js](http://nodejs.org/)
The framework Node.js is used to develop XO-Server in JavaScript, the same language already used in XO-Web.
It's perfectly fit to run efficiently network services.
It's perfectly fit to run efficient network services.
### [Redis](http://redis.io/)

2
doc/installation/README.md
View File

@ -6,7 +6,7 @@ There are two ways to install Xen Orchestra. If you are just a user and not a de
## Default credentials
Be advised that our default user and password for a fresh install are **admin@admin.net** and **admin**. Do not forget to change it to avoid trouble.
Be advised that our default user and password for a fresh install are **admin@admin.net** and **admin**. Remember to change the default password immediately after installation.
## [Xen Orchestra Appliance (XOA)](./xoa_installation.md)

2
doc/installation/installation_freebsd.md
View File

@ -4,7 +4,7 @@ This small guide is an addendum for installing XO on FreeBSD 10.
## Packages and Pre-requisites
Just install those packages:
Just install these packages:
```
pkg install gmake redis python git npm node

2
doc/installation/manual_installation.md
View File

@ -1,6 +1,6 @@
# Manual installation
This installation is validated on a fresh Debian 7 (Wheezy) 64 bits. It should be almost the same on others dpkg systems. For RPMs based OS, it should be close, because most of our dependencies came from NPM and not the OS itself.
This installation is validated against a fresh Debian 7 (Wheezy) 64 bits. It should be almost the same on others dpkg systems. For RPMs based OS, it should be close, because most of our dependencies came from NPM and not the OS itself.
FreeBSD user? Check [our dedicated page](./installation_freebsd.md) for this.

8
doc/installation/xoa_installation.md
View File

@ -2,11 +2,11 @@
The fastest way to install Xen Orchestra is to use our Appliance. You can [download it from here](https://xen-orchestra.com/) (fill the form and click on "Try Now"). Basically, it's a Debian VM with all the stuff needed to run Xen Orchestra, no more, no less.
Once you got it, you can import it with `xe vm-import filename=xoa_version_number.xva` or via XenCenter.
Once you've got it, you can import it with `xe vm-import filename=xoa_version_number.xva` or via XenCenter.
After the VM is imported, you just need to start it with a `xe vm-start vm=XOA` or with XenCenter.
XOA is in **DHCP** by default, so if you need to configure the IP, you need to edit `/etc/network/interfaces` as explain in the [Debian documentation](https://wiki.debian.org/NetworkConfiguration#Configuring_the_interface_manually). You can access the VM console through XenCenter or using VNC through a SSH tunnel.
XOA is in **DHCP** by default, so if you need to configure the IP, you need to edit `/etc/network/interfaces` as explained in the [Debian documentation](https://wiki.debian.org/NetworkConfiguration#Configuring_the_interface_manually). You can access the VM console through XenCenter or using VNC through a SSH tunnel.
Xen Orchestra is now accessible in your browser on ` http://your-vm-ip` or in HTTPS on the same URL.
@ -16,9 +16,9 @@ Default user is **admin@admin.net** with **admin** as a password.
## XOA credentials
So far, system/SSH user and password are **root**/**xoa**. Be smart and change the root password as soon as possible!
By default, system/SSH user and password are **root**/**xoa**. Be smart and change the root password as soon as possible!
> For version of XOA < 3.6, user/pass combo in SSH is **root**/**root**. But we encourage you strongly to switch to the lastest XOA version (3.6)
> For version of XOA < 3.6, user/pass combo in SSH is **root**/**root**. But we encourage you strongly to switch to the lastest XOA version (3.6).
## Restart XOA

6
doc/vm_usage/README.md
View File

@ -1,6 +1,6 @@
# Virtual machines
VM are the core interest of virtualization. That's why they are first in this documentation. The VM view contains all you need to interact with a virtual machine:
VMs are the core interest of virtualization. That's why they are first in this documentation. The VM view contains all you need to interact with a virtual machine:
![](./assets/vmview.png)
@ -30,7 +30,7 @@ Xen Orchestra allows console access from the web. For that, we use the NoVNC pro
Consoles are accessible from different views, but always with the same symbol: ![](./assets/consoleicon.png)
You can send *Ctrl+Alt+Del* key with the dedicated button. And you can also insert a virtual CD (from an ISO repository or a local DVD drive) in any VM you need:
You can send the *Ctrl+Alt+Del* combination with the dedicated button. And you can also insert a virtual CD (from an ISO repository or a local DVD drive) in any VM you need:
![](./assets/consoleview.png)
@ -61,7 +61,7 @@ Fill the required fields:
The summary is here to check if you are sure about your settings. Let's create a VM by clicking on "Create VM" button!
**WARNING**: if you create a VM from a special template (a previously existing VM converted in a template), you should remove all interfaces and disks! Because they are already existing in the template.
**WARNING**: if you create a VM from a special template (a previously existing VM converted in a template), you should remove all interfaces and disks, because they already exist in the template!
## Copy/clone a VM