Project Wonderland v0.5 Web-Based Administration

Table of Contents

Project Wonderland v0.5 has a unified, web-based administration tool. This administration tool lets you start and stop the Wonderland server components (darkstar server, voice bridge, shared application server) and view server-related log files.

Launching the Wonderland Web-Based Administration Tool

After you have started Wonderland, you may launch the web-based administration tool, by visiting the following URL in your web browser:

http://<host name>:<port>/wonderland-web-front/admin

where <host name> is the host and domain name of your server machine (e.g. localhost) and <port> is the port on which the server is registered, most often port 8080. When you visit this URL, you should see the following screen:

Managing the Wonderland Server Components

To view the server components currently running, click the Server Status link on the left-hand side bar. It should display the Wonderland server components running and also a collection of update controls. The table gives the name of the server component (Darkstar, Voice Bridge), the machine on which it is running, its status (Running, Starting, Shutting Down, Not Running), and Actions to take upon the server component.

By default, this view will refresh every 15 seconds. Click the links on top of the server component table to control the refresh rate of this information.

Starting and stopping the server components

You may start, stop, and restart each server component individually or all at once via the links present on the Server Status page.

Next to each server component, under the Actions column:

• Click stop to stop the server component (if running)
• Click restart to stop and then start the server component (if running)
• Click start to start the server component (if not running)

At the bottom of the table:

• Click Stop All to stop all currently running server components
• Click Start All to start all server components not currently running
• Click Restart All to stop and then start all currently running server components

Editing the server component properties

Each server component has a collection of configuration properties that are editable via this web-based administration tool.

Next to each server component under the Actions column:

• Click edit to edit the server component properties
• Edit the existing properties directly in the table
• Click Add Property to add a new configuration property
• Click Restore Defaults to restore the previously saved property values
• Click Save to save the new properties or Cancel to revert to the existing property values

For example, the properties for the Voice Bridge server component looks like this:

Viewing the server component log files

To view the log files for each server component:

• Click logs under the Actions column next to each server component

For example, the log file for the Darkstar server component looks like this:

Managing Modules

To view the list of modules currently installed in Wonderland, click on the Manage Modules link on the left-hand side bar. It should display four sections:

1. Installed Modules: A table of modules currently installed, their version, descriptions, and a checkbox to mark the module for deletion
2. Pending Modules: A table of modules that are waiting to be installed for some reason, typically during the next server component restart or when a module it depends upon is installed
3. Removed Modules: A table of modules that are waiting to be uninstalled for some reason, typically during the next server component restart or when a module that requires it is uninstalled
4. Install a New module: Provides the ability to select a module JAR file to upload and install

This screen should look something like this:

Installing new modules

In Project Wonderland v0.5, modules are encapsulated in JAR archive files. To install a new module into Wonderland:

1. Select Choose File under the Install a New Module heading and locate the module JAR archive file to install

Once you have selected the module JAR archive file to install, your window should appear like the following, with the name of your module (in this case, example.jar) filled in beside the Choose File button:

Next,

1. Click the INSTALL button
2. A page will display a success or error message
3. Click the Manage Modules tab once again to refresh your view of the modules

If the module does not depend upon any other missing module, or if the module does not require any of the server components to be restarted, it should be appear under the Installed Modules heading. Otherwise, it will appear under the Pending Modules heading, as follows:

To have this module installed, revisit the Server Status tab and select Restart All to restart all of the server components. Once they have restarted, the module should appear under the Installed Modules section.

Removing existing modules

To remove an existing installed module, first select the checkbox next to its entry under the Installed Selection. For example, the "example" module has been selected to be removed.

Next, click the Remove Selected Modules button underneath the table of installed modules. If some other installed module does not depend upon the selected module, or if the module does not require any of the server components to be restarted, it should be removed from the Installed Modules heading. Otherwise, it will appear under the Removed Modules heading, as follows:

To have this module uninstalled, revisit the Server Status tab and select Restart All to restart all of the server components. Once they have restarted, the module should no longer appear under the Installed Modules section.

Managing the Content Repository

COMING SOON

Managing the Initial World and World Snapshots

To view the current list of initial worlds and world snapshots, click the Manage Snapshots link on the left-hand side bar. It should display two lists: a list of initial worlds and a list of snapshots of worlds. Your screen should look something like this (Click on the image to see a full-screen version):

Each Initial World has a name, a path, and a set of actions. All Initial Worlds are stored as individual Wonderland File Systems (WFS). The WFSs listed under Initial Worlds are found in the ~/.wonderland-server/0.5-dev/wfs/worlds directory. Under the Actions header, initial worlds either have the "Current" label and the "restore" link, indicating that it is the basis for the initial world state, or the "make current" link.

Each World Snapshot, has a name, date, description, and a set of actions. All World Snapshots are stored as individual Wonderland File Systems (WFS). The WFSs listed under World Snapshots are found in the ~/.wonderland-server/0.5-dev/wfs/snapshots directory. Under the Actions header, snapshots of worlds either have the "Current" label and the "restore" link, indicating that it is the basis for the initial world state, or the "make current" link. They also have "edit" and "remove" links.

Selecting the initial world

You may initialize the state of the world to one of the Wonderland File Systems (WFS) listed under either the "Initial Worlds" heading or the "World Snapshots" heading. The current initial world has the label "Current" under the Actions column. To set the initial state of the world:

1. Click the "make current" under the Action header of the desired initial world or world snapshot
2. Click OK on the Confirm page

This will reset the state of the world to that stored in the selected WFS and restart the Darkstar server component. When clients reconnect to the server, they see a new world state.

Restoring the world state

You may restore the state of the world to the currently-selected world state WFS. You may do this for either an Initial World or a World Snapshot. You can only restore to the state of the world if it has a "Current" label under the Actions column. To restore the state of the world.

1. Click the "restore" under the Action header of the desired initial world or world snapshot
2. Click OK on the Confirm page

This will restore the state of the world to that stored in the selected WFS and restart the Darkstar server component. When clients reconnect to the server, they see a new world state.

Creating a world snapshot

A World Snapshot is the current state of the running world stored in a WFS. You may take a World Snapshot at any point (and restore to that snapshot using the steps above), although the process will restart the Darkstar server component and clients will have to reconnect. To create a World Snapshot:

1. Click the "Create snapshot" link under the World Snapshots section
2. Click OK on the Confirm page

This will take a snapshot of the world state and create a new WFS to hold that state. After the snapshot has been created your screen should look something like this (Click on the image to see a full-screen version):

The initial name of the snapshot is the time and date the snapshot was performed. To reset the state of the world to the state stored in the snapshot, please follow the instructions above.

Deleting a world snapshot

You may also delete a stored snapshot at any point:

1. Click on the "remove" link under the Actions column next to the desired World Snapshot to remove. Note: there is no confirmation step after you click on the "remove" link

Editing a world snapshot's properties

You can edit both the World Snapshot name and its description that appears on the Web Administration UI.

1. Click on the "edit" link under the Actions column next to the desired World Snapshot to edit
2. Edit either/both the name and description
3. Click OK to save your changes

The edit window should look something like this (Click on the image to see a full-screen version):

Editing Security Groups

To view the current list of security groups, click the Group Editor link on the left-hand side bar. It should display a list the security groups. Your screen should look something like this (Click on the image to see a full-screen version):

Security groups are collections of users to which fine-grained security permissions may be assigned. Examples of fine-grained security permissions include the ability to view and edit Cells in a world. Assigning specific fine-grained security permissions to security groups is done via the Wonderland client.

Each security group entry in the list has a unique name, a number of members, and actions to be taken upon the group definition.

Editing a security group

You can edit both the name of the security group and its members via the Web Administration UI.

1. Click on the "edit" link under the Actions column next to the desired Security Group to edit
2. Edit the name of a member of the group, whether that member "Owns" the Security Group (and hence can make changes the group), whether to delete the member from the Security Group, or whether to add a new member to the security group.
3. Click "Update group" to save your changes or "Cancel" to revert to the previous settings.

The edit window should look something like this (Click on the image to see a full-screen version):

Delete a Security Group

To delete a Security Group:

1. Click on the "Group Editor" link on the left-hand side bar of the window
2. Click on "delete" under the Actions column on the row of the desired Security Group to delete. Note: there is no confirmation step after you click on the "delete" link.

Add a Security Group

To add a new Security Group:

1. Click on the "Group Editor" link on the left-hand side bar of the window
2. Click on the "Add group" link
3. Enter the desired name of the new Security Group
4. Click "Edit group" to continue to add members to the new Security Group, etc.

The add window should look something like this (Click on the image to see a full-screen version):

Viewing the Server Statistics

To view statistics on the current performance of the server, click the Server Performance link on the left-hand side bar. It should display a graph of network "ping" times, indicating the health of the Darkstar server component. (Typically values below 250 ms indicate a healthy server).

You may control the rate at which this information is refreshed via the links on top of the graph. The list to the right of the graph, labelled with the letters of the alphabet, indicate when the Darkstar server component has been stopped and started.