From SMW+ A Semantic Web Enterprise Wiki

This article introduces the new Wiki Administration Tool web interface which lets you perform administrative tasks easily and intuitively. Information on how to install, upgrade and uninstall packages using the web interface is given. Additional information on other tasks such as creating and loading restore points, adding repositories or uploading bundles from your local server as well as editing the wiki's Localsettings.php file is also given. With SMW+ 1.6.0, you can now monitor the status of the servers (Apache, mySQL, solr, tsc and memcached) and start or stop them easily.

User manual information
Applies to version: Help:SMW+ 1.6.0,
Note: Use the tree-view on the right hand side to navigate in the documentation

Contents 1 Introduction 2 Prerequisites 3 Accessing the web interface 3.1 Accessing the web interface from the Administrator tab 3.2 Accessing the web interface via URL 4 Overview of the web interface 5 The Status menu - Update or uninstall extensions 5.1 Updating extensions 5.1.1 Performing a Global Update 5.1.2 Updating a single extension 5.2 Uninstalling extensions 6 Find extensions menu - Search and install Wiki Apps and extensions 6.1 Searching for extensions 6.2 Installing extensions 7 Uploading local bundles/ontologies menu 8 System restore menu 8.1 Creating a restore point 8.2 Restoring the wiki with a restore point 9 Managing repositories 10 Editing LocalSettings 11 Monitor status and Start/Stop servers

Introduction

The new Wiki Administration Tool web interface lets you administrate your wiki in a more comfortable and intuitive way - you interact with the web interface instead of giving commands in the command-line. This not only saves you time, but also enhances the usability of the Wiki Administration Tool.

Apart from using the web interface to install new extensions, update and uninstall existing extensions, there is a tool that is meant to help you edit your wiki's LocalSettings.php from the comfort of your web browser - this tool is unique.

With SMW+ 1.6.0, you can now monitor the status of the servers (Apache, mySQL, solr, tsc and memcached) and start or stop them easily.

The web interface is capable of performing all Wiki Administration Tool operations that were previously done using the console (refer to: Administrating the wiki with the command-line interface.)

With the web interface you can:

• generate and view a list of all installed extensions.
• update or uninstall extensions.
• search for new extensions from defined repositories.
• install new extensions from defined repositories.
• upload local bundles or ontologies.
• create and work with restore points.
• manage repositories.
• edit LocalSettings.php file.
• monitor the status of the servers (Apache, mySQL, solr, tsc and memcached) and start or stop them easily.

Prerequisites

• Wiki Administration Tool has been adjusted for web interface

Note: Wiki Administration Tool 1.6.0 is pre-installed in SMW+ 1.6.0

• You have the web interface user rights (login credentials).

---

Accessing the web interface

The web interface is accessed from your browser via HTTP just like you access your wiki.

Accessing the web interface from the Administrator tab

1. Log in to your wiki as Administrator. The default credentials are:

   Username: WikiSysop

   Password: root

2. Go to the upper right section, extend the Administrator menu and select Wiki Administration Tool

   

   

   Accessing the Wiki Administration Tool from the Administration tab

   - this opens a the Wiki Administration Tool login page

   

   

   Wiki Administration Tool login page
3. Login with the same credentials as those used in step 1 to access the tool

Accessing the web interface via URL

1. Log in to your wiki as Administrator. The default credentials are:

   Username: WikiSysop

   Password: root

2. To access the web interface via URL, extend the URL as follows:

   deployment/tools/webadmin 

   Example: If the URL of your wiki's Main Page is:

   http://yourwiki/mediawiki/index.php/Main_Page 

   The URL of the Wiki Administration Tool web interface is:

   http://yourwiki/mediawiki/deployment/tools/webadmin/ 

   - this opens a the Wiki Administration tool login page

3. Login with the same credentials as those used in step 1 to access the tool

---

Overview of the web interface

Having logged in, the Wiki administration tool displays a menu bar with different items. The selected menu is in orange.

An overview of the Wiki Administration Tool menu bar.

The menu items are:

• Status - view all installed extensions, their description and version and update or uninstall them.
• Find extensions - search and view all extensions, their description and version, check dependencies and install extensions
• Upload local bundles/ontologies - upload local bundles
• System Restore - create or load restore points
• Repositories - manage repositories (add/modify/remove)
• LocalSettings - edit LocalSettings.php file
• Servers - monitor status and Start/Stop servers (Apache, mySQL, solr, tsc and memcached)

If you have installed large content bundles or extensions that have a lot of dependencies using the Wiki Administration Tool, it might take some time before the selected tab is loaded - just wait a bit as the files are loaded. This delay may be experienced while creating a restore point of a wiki with a lot of data.

Once any of the tabs above is clicked, the web interface expands the view, and retrieves the necessary data letting you perform the desired action.

If you wish to interrupt any of these (load) processes, press the  Esc key - if it takes too much time.

---

The Status menu - Update or uninstall extensions

The first menu item Status is the default selection whenever you open the web interface. It generates a list of all installed extensions and content bundles of your wiki, their version, description and lets you update or uninstall any of the listed entries.

Status Menu - a list of all the currently installed extensions and content bundles

The extensions and bundles are listed alphabetically according to their names with the following columns:

• Extension - name of extension.

Click on any extension to open a popup with the detailed information about the selected extension

Example presentation of the details of smwplus-160

• Version - shows the version of the selected extension
• Description - gives a brief description of the selected extension
• Action column - has the following buttons:
  • Update - update the extension - this button is only activated if there is an update version available.
  • Uninstall - uninstall an extension. Button is deactivated for the necessary extensions, i.e. Wiki Administration Tool and mw. You cannot uninstall these packages with the Wiki Administration Tool - these packages are required!

Updating extensions

The Status menu will notify you if there are any updates available for the installed extensions.

Updates are of two types:

• Global Update - applies all available updates
• Single update - applies an update on a selected extension.

Performing a Global Update

To perform a Global Update thereby applying all available updates:

1. Press the Global update button
   

   

   Wiki Administration Tool reports if updates are available

   - this opens up a popup listing the extensions that will be updated.

   

   

   Popup lists all extensions

2. Press the Do update button

   - this updates the listed extensions

   The update progress is can be followed in the popup that opens thereafter.
   Be patient while the system updates the listed extensions - the system will give notice of successful update.

Updating a single extension

To update a single extension:

1. Press the Update button on the respective extension from the Action column.

   - this opens up a popup listing the extension that will be updated.

2. Press the Do update button

   - this updates the listed extension

   The update progress can be followed in the popup that opens thereafter.
   Be patient while the system updates the listed extensions - the system will give notice of successful update.

Uninstalling extensions

With the Wiki Administration Tool web interface you may uninstall extensions with only two clicks:

1. Click the Uninstall button in the corresponding row.

- this opens up a popup letting you validate the uninstall process.



Uninstall extension
2. Click Yes.

- the system will automatically uninstall the extension.

You can follow the progress in the information that is displayed in the popup. Depending to the extension, de-installation might take a while. The system will give notice of successful de-installation.


Notice of successful de-installation

---

Find extensions menu - Search and install Wiki Apps and extensions

Find extensions menu

The Find extensions section gives you an overview of all extension which are available in the chosen repository and lets you install any of these extensions.

Searching for extensions

The following options may be used while searching for extensions:

• "Find all" search option - this is the default search option. Pressing the Search button with this option displays a table with all extensions in your repositories.
• Empty search option - if you leave the search entry box empty and press the Search button, a table with all extensions in your repositories will be displayed.
• Enter a string and search - this option will display all the extensions which contain the string either in their name or in their description.

The 4th column of the table that is generated will display an extension as:

• Installed - if the extension has been installed
• Update - if the extension has been installed and there is an update
• If an extension is not installed - it will have the Install and Check dependencies buttons

Installing extensions

1. Before installation, we recommend that you first check dependencies - to do this, hit the Check dependencies button

   -this opens up the Inspect extension popup.

   It has a list of all the extensions that need to be installed to acquire full functionality of the selected extension.

   

   

   Checking dependencies of an extension
2. Hit Close the window
3. Hit the Install button

   - this automatically installs the extension together with its dependencies (these are other extensions which are required to attain full functionality).

   You can follow the progress of the installation in the popup that opens thereafter - this popup will report successful installation as: "Installation successful".
4. Close the pop-up window to exit installation.
   

   

   Installation successful
   To verify that the installation was done successfully, got to the special page Special:Version - the extension should be listed on this page after the installation.

---

Uploading local bundles/ontologies menu

Uploading local bundles/ontologies menu

The Upload local bundles/ontologies section lets you upload content bundles directly from your local hard disk. Just click on the upload button and choose the bundle from your local file system.

Please note that only bundles in zip-format can be uploaded while or ontology files can have any of the following formats - *.owl/*.rdf/*.n3/*.ttl/*.ntriple/*.nt/*.obl - ref.: Importing ontologies user guide.

The Wiki Administration Tool will only upload the bundle and not install it directly. Once you upload a bundle, it shall be seen on the list and you can install it or remove it from the list.

---

System restore menu

System restore menu

The System restore menu has all your wiki's restore points.

Restore points save the actual status of your installation and your wiki's database. We recommend that you save your installation before you install new features or edit the settings. This is especially necessary since a restore point can be used to revert and restore your installation just in case anything were to go wrong thus breaking your wiki database and making your wiki inconsistent.

Creating a restore point

To create a restore point:

1. Enter the name of your restore point and press the Create button

   -this opens up a popup which informs you about the progress.

   It will inform you of successful restore point creation and add the restore point to the list.

Restoring the wiki with a restore point

1. Select a restore point from the list and hit the Restore button.

   - a popup will warn you of the effects of restoring the wiki and ask for your confirmation.

   

   

   System restore warning
2. Hit the Yes button to restore the wiki with the selected restore point.
     Important note:

   Restoring will REPLACE both the wiki setup and its ENTIRE contents by a previous version. YOU WILL LOOSE YOUR CURRENT WIKI CONTENT!

---

Managing repositories

Repositories menu

This section has a list of all defined repositories. You can easily add or remove repositories from the list.

The default repository is the stable ontoprise repository.

Default: stable ontoprise repository http://dailywikibuilds.ontoprise.com/repository

ontoprise offers Wiki Administration Tool repositories to the community - these repositories contain extensions and Wiki Apps which are packaged by the ontoprise team as well as other extensions and Wiki Apps that have been packaged by our community (ref.:The SMW+ repository list)

In addition to this, other extension programmers or content providers can set up their own repositories and distribute their own extensions or content bundles. You may therefore install extensions from several repositories.

If you search for extensions from the Find extensions section, the DF will search through the repositories that have been defined in the Repositories section.

You may add the unstable SMW+ repository or any other repositories.

Unstable ontoprise repository: http://dailywikibuilds.ontoprise.com/nightly_repository

  Note:

The local file of the repository file is repositories - it is located in:InstallDirectory\htdocs\mediawiki\deployment\config. If you encounter issues, it helps to remove your repositories this file

---

Editing LocalSettings

LocalSettings menu

The LocalSettings menu enables you to edit the wiki settings file LocalSettings.php directly from the web interface. You can edit the several sections of the several extensions in the php file as follows:

1. Select extension from the dropdown menu.

   -the text field will be activated and the syntax of the corresponding section in the LocalSettings.php file will be displayed.

2. Edit the section in the text field

   Once you make any changes to the syntax, the Save button will be activated.

3. Click Save.

   - the system will now overwrite LocalSettings.php.

   A popup will report when the file has been saved successfully.

---

Monitor status and Start/Stop servers

Server menu

With SMW+ 1.6.0, you can now monitor the status of the servers (Apache, mySQL, solr, tsc and memcached) and start or stop them easily. This menu has four columns:

1. Service - lists these servers: Apache, mySQL, solr, tsc, memcached.
2. Status - lists the status of the corresponding service as follows:
   • Green background + running means that this service is up-and running - as expected.
   • Red background + not running means that this service down.
3. Operation - you can select restart, start or stop from the drop-down menu beside a service.
4. Command - displays the command that the selected operation does.
5. Execute - press this button to perform the selected operation.

Copyright © 2012 (see terms of use for ownership)

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the article "GNU Free Documentation License".