From SMW+ A Semantic Web Enterprise Wiki

This article gives instructions on how to install the Wiki Administration Tool on your MediaWiki installation.

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

Help out! You feel that the documentation needs a cleanup or misses information? Report a quality issue List of issues for this article: [open in bugzilla]

Contents 1 Requirements 2 Installation 3 Verifying the installation 3.1 Opening the command line as Administrator (Windows 7) 4 Configuration 4.1 Adjusting Wiki Administration Tool for using the web interface 4.2 Adding and changing repositories 4.3 Using a proxy 4.4 Using more then one wiki on a machine 4.5 Restricting access to the web interface 4.6 Using LDAP 4.7 Deactivating automatic updates 4.8 Changing account to run commands on server 4.9 Keeping command window on Windows when using web interface 4.10 Changing home directory 4.11 Setting PHP executable 5 Setting MYSQL directory= 6 Upgrade notes 7 Troubleshooting 8 Related topics

Requirements

• Apache HTTP Server
• MySQL higher than 4.0.14 (Recommended MySQL 5.x)
• PHP 5.2.x, 5.3.2 or 5.3.3 (Do not use 5.3.1)
• MediaWiki 1.16 installed (see installation)

Installation

1. Download the latest version of the Wiki Administration Tool
2. Unzip file:

   Unzip deployment-1.6.0_0.zip in the MediaWiki root folder: ..\htdocs\mediawiki

3. Adjust mysql administrator account in "LocalSettings.php" and install the tool:
   1. Open the file "LocalSettings.php"
   2. Set $wgDBadminuser and $wgDBadminpassword of your MySQL installation.
   3. Add the following statement:

      /*start-wikiadmintool*/

      require_once($IP.'/deployment/Deployment.php');

      /*end-wikiadmintool*/

      This enables a special page to check the integrity of the MW installation. The statement was optional until version 1.3.1. Since version 1.6.0, it is required.

   If this is not set, an error will be reported: "...1044: Access denied for user @'localhost' to database...Could not run "mysqldump".

   If you are using SMW+ then your default name and password is: 'root', 'm8nix'.

4. On Linux: make "smwadmin.sh" executable - if you are not using Linux, jump to the next step.
   1. Open the shell or the terminal of your system e.g. "xterm"
   2. Navigate to the installation directory of the Wiki Administration Tool,e.g. <deployment-framework-install-dir>/tools/
   3. Call: chmod +x smwadmin.sh
5. Include the path to php.bin to the system variable PATH (either Windows or Linux), e.g. C:\xampp\php;
6. Include the path to mysql.exe to the system variable PATH (either Windows or Linux), e.g. C:\xampp\mysql\bin;
7. See Help:Changing the PATH system variable for a description how to change the PATH variable on your OS
8. Grant write access to the following directories for the Wiki Administration Tool: If you do not grant write access then error messages will be printed out. The default credentials are: Wikiserver login: WikiSysop; Password: root
   • htdocs\mediawiki\LocalSettings.php
   • deployment\tools\webadmin\sessiondata
   • deploymenttools\webadmin
   • htdocs\mediawiki\extensions (and all extensions contained)
   • path of %TEMP% variable, default: C:\Windows\TEMP
   • \usr\share\local\Ontoprise (optional, only required if you plan to install external apps like TSC)
9. Configure the Wiki Administration tool:#Open the file deployment\config\settings.php and configure the two mandatory settings:
   1. • $scriptPath = "/mediawiki";

        This is required for the web interface. It is the same as specified in LocalSettings.php for $wgScriptPath

      • $df_lang = "en"

        Define the language (default is english) used in the web interface, same as in LocalSettings.php for $wgLang

   2. Save the file and copy this file in the root folder of the Wiki Administration Tool

Result:

You can now use the Wiki Administration Tool to install, update and remove MediaWiki extensions and content bundles.

Verifying the installation

To verify the installation, follow these steps:

1. Open in your commandline tool the directory: <deployment-framework-install-dir>/deployment/tools/
2. Call "smwadmin" (in Linux, "./smwadmin.sh")
   If this fails then you should verify the steps above.
3. Call "smwadmin -l" (in Linux, "./smwadmin.sh -l")
   If this fails then you should check that you can access the ontoprise repository with a web browser.

Opening the command line as Administrator (Windows 7)

To open the command line with administrator rights (Windows 7) :

1. Hit the Windows start button
2. Enter some text in the search pane .i.e. "cmd"

   -the system will search and display the "cmd.exe" application

3. Right click on "cmd.exe" and select "Run as Administrator" from the context menu
   

   

   Opening the command line "as an administrator" in Windows 7

   - this opens the "cmd.exe" application with administrator rights

4. Navigate to the "tools" directory with the following syntax:

    cd htdocs\mediawiki\deployment\tools

   

   

   Change directory
5. Run the desired command from this location

Configuration

Adjusting Wiki Administration Tool for using the web interface

1. Make sure that deployment/tools/webadmin is accessible via HTTP.
2. Set the $scriptPath and $df_lang variable in deployment/settings.php to your wiki location (same as $wgScriptPath and $wgLanguageCode in LocalSettings.php).

Adding and changing repositories

The ontoprise repository is already configured, but you may change it or add new repositories as source for obtaining MW extensions and content bundles. You may enter multiple repositories.

To add and change repositories, follow these steps:

1. Navigate to the directory <deployment-framework-install-dir>/deployment/config/
2. Open the file "repositories"
3. Add or edit repositories

Using a proxy

If you're using the Wiki Administration Tool in a network where the internet is not directly accessible but through a proxy server, you have to adjust the settings. Setting up the Wiki Administration Tool to use a proxy server, the following steps need to be done:

1. Open the file <mediawiki-install-dir>/deployment/settings.php
2. Locate the line with 'df_proxy' => ' '
3. Uncomment the line and enter the address of your proxy server including the port for 'df_proxy'.
   For example the config should look like this:

   'df_proxy' => 'proxy.example.com:8080'

4. Save your changes to the settings.php

The Wiki Administration Tool will now connect to the repository using the stated proxy.

Using more then one wiki on a machine

If you use more than one wiki on a machine, make sure you use different names for each. Don't change it afterwards, otherwise the Wiki Administration Tool won't find your restore points again.

public static $df_wikiName = "mywiki";

Restricting access to the web interface

Uncomment the lines and set $df_authorizeByWiki to false if you do not want to authorize Wiki Administration Tool web interface by the wiki user base.

public static $df_authorizeByWiki = true;
//public static $df_webadmin_user = "root";
//public static $df_webadmin_pass = "pass";

Using LDAP

If you are using an LDAP server together with the LdapAuthentication extension, set the domain in order to access web interface of the Wiki Administration Tool.

public static $df_webadmin_ldap_domain = "";

Deactivating automatic updates

By default the tool checks automatically for updates if a sysop user logs in. Set public static df_checkForUpdateOnLogin to false to deactivate automatic updates

public static $df_checkForUpdateOnLogin = true;

Changing account to run commands on server

By default the account on which the web server runs is used for the Wiki Admin tool web interface.

public static $df_runas_user = NULL;
public static $df_runas_password = NULL;

Keeping command window on Windows when using web interface

Set 'df_keep_cmd_window' to true

Changing home directory

in the home directory is several information stored (restore points, logs, uploaded files), by default (nothing set)$HOME is used.

'df_homedir' => '',
'df_uploaddir' => '',

Setting PHP executable

only necessary if it is not in PATH or it has the wrong version; PHP 5 is required at least

'df_php_executable' => 'php',

Setting MYSQL directory=

only necessary if it is not in PATH

'df_mysql_dir' => '',

Upgrade notes

The Wiki Administration Tool is a tool for managing and upgrading the wiki's extensions. So, the DF can also upgrade itself. You may upgrade the DF to the most current version via the web interface or the console:

• Web interface: DF reports in the Status section, if an update is available. Just click on the Update button. Upgrading extensions with the web interface.
  

  

  Update available for Wiki Administration Tool
• Console: Run the following command in the command line:

  smwadmin -u deployment

Troubleshooting

The Special:CheckInstallation tool throws the following issues:

• "Missing extension: LinkedData" - this comes about if DataImport extension is not installed (this extension is optional)
• "Semantic rules extension is not registered" - this comes about if the Triple Store Connector (TSC) is not installed
• "There are registry entries for non-existing extensions" - this comes about if the particular extensions are not handled by the Wiki Administration Tool

Related topics

• Using the Wiki Administration Tool 1.6.0
• Setting up your own repository
• Troubleshooting for common problems with the Wiki Administration Tool

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".