User manual: quick start
This page assumes you have a working installation of the EJabberd and Archipel Agent, as described in the Installation Manual. It will guide your first steps in Archipel GUI and will explains its basic operations.
Enter the URL of the HTTP served directory where Archipel GUI is installed in your browser. After a small pre-loading phase, the connection prompt will open.
And enter the following informations (all the fields must be filled):
-
Jabber ID: your XMPP admin account, which must be like
[email protected] - Password: the password associated to the admin account
-
BOSH Service: the BOSH URL of your XMPP server. If you use our sample conf for Ejabberd, it should be
http://your.fqdn.fr:5280/http-bind - Remember: remember credentials (will connect automatically at next loading of Archipel)
Basically your BOSH hostname is the same that the domain of your JID.
Then click on the connection button.
The user's preferences of Archipel are linked with a JID. This means that all information in the Preferences window will be stored into the XMPP account of the user and will be persistent over reload, browser or computer.
The Preferences window contains several tabs. One named "General" and several others. The other ones are dynamic modules preferences. To get more information about a module's user preferences, see its documentation.
To access preferences, Select the "Archipel" menu and "Preferences".
You may also type
CMD + ,on a Mac, orCTRL + ,to open this panel
It will open the Preferences window:
- Welcome page URL: The URL of the page that will be displayed when no entity is selected
- Module loading delay time: The time to wait before actually loading a module when an entity is selected.
- BOSH Resource: The XMPP ressource to use. It can be whatever you want. Just keep in mind that a JID cannot be connect several times with the same resource.
- Language: The language of the user interface (need to reload of the application)
- Use animation: Use eye candy animations
- XMPP Monitoring: Enable the traffic LED activity (it decreases performances)
- Updates: If checked, Archipel will search for new versions at connexion
- Display welcome message: Open the first connexion window
- Debug level: Set the level of the log. All logs are printed in Javascript console of your browser.
The Reset button resets all the custom preferences and reuse factory ones.
To communicate with Archipel agents, you need to add them in your roster (list of contacts). This is the exact same system you would use with your GMail account when you want to communicate with someone. You must ask the hypervisor for a subscription request. Then hypervisor is you are granted to talk with it and if yes, it will ask you as friend too.
To add your hypervisor, click on the bottom left "+" button and select "Add a contact".
Enter the JID of your hypervisor. It should be hypervisor@myfqdn. You also can choose to name it. This name is just the nickname you want to use in your own roster. It is not visible by others. If you leave this field blank, The actual name of the hypervisor will be used. You will be able to change this later.
Then your hypervisor will be added to your roster.
In Archipel, virtual machines are XMPP entities, just like the hypervisors. They have their own JID and own roster. In order to create a virtual machine, you have to ask one hypervisor to do it for you. Then the virtual machine will be created, and it will ask you a subscription request when it will be ready.
Select your hypervisor from your roster then select the tab named "Virtual Machines":
Click on the bottom "+" button, and enter the name of the virtual machine. This is name cannot be changed. You will be able to change the display name (nickname) but never the name. If you leave this field blank, Archipel will pick up a random name, from the list of named asteroids in solar system.
Once the virtual machine has been initialized, you must answer to its subscription request:
Then the virtual machine will appear in your roster in a Not defined status. The virtual machine is now ready to be configured.
You can sort entities in groups. Groups can also be placed into others groups. One advantage of groups is that you will be able to send commands to the whole group.
Click on the bottom left "+" button and choose "Add a group":
Then enter the name of your group:
Finally you can put entities and other groups in it by drag and drop:
You can't change the real name of an entity once it has been created. But you can set a nickname for each entities. It will only be visible by you.
Select the entity you want to change the nickname. It will display the properties view at the bottom of the roster (if not, click on the bottom left arrow button in the roster's button bar). Then select the name, and change it. Type enter to validate your change:
More to come...