WikiSoftware 2.22 Installation manual

From BlueSpice

Jump to: navigation, search


This document describes the installation steps for all WikiSoftware 2.22 releases.

About this manual

  • When editing configuration files in a text editor be sure to save them as UTF-8 without BOM (Byte Order Mark).
  • The string <unzipped-archive> represents the place where you unzipped the downloaded file.
  • The string <mediawiki-url> represents the URL of your Mediawiki installation, e.g. http://localhost/mediawiki.
  • The string <installpath-mediawiki> represents the file system path to your Mediawiki installation, e.g. C:\xampp\htdocs\mediawiki (Windows) or /var/www/mediawiki (Linux).

Requirements

MediaWiki

For the installation of WikiSoftware we assume that MediaWiki (version 1.19.x - 1.22.x) is installed and configured. It can be accessed via browser (while the web and the database server are started) at <mediawiki-url>. If you did not install MediaWiki yet, visit this wewsite to download MediaWiki. Note: The extensions WikiSoftware Distribution/Echo and WikiSoftware Extensions/Review are not supported by MediaWiki < 1.21.

Browser

  • Mozilla Firefox 3.6+
  • Google Chrome
  • Internet Explorer 10+ (without compatibility view!)

Server

  • Wewserver (Apache 2+, IIS 6+)
  • PHP 5.3.2+
  • MySQL 5.0.2+
  • Main Memory: > 2 GB
  • Hard Drive: > 10 GB (depends on the planned storage of data).
  • CPU: 2 GHz+ (Dual Core or more recommended).
  • Apache Tomcat 6 / 7 / 8 (for ExtendedSearch and PDFExport)
  • Java Runtime Environment (Jre) 1.6 - 1.8 (see alsoUniversal Export)

These login credentials to the database server should be known:

  • Host/IP address and port
  • Username and password for the root user (CREATE/DROP-Statements) and the Wiki-User
    (probably created during the installation of MediaWiki)
    With an installation on XAMPP the username "root" with empty password is preset.
  • Name of the used database
  • The table prefix of the used database

Installation

Components of WikiSoftware

The <unzipped-archive> contains the following directories and files:

  • extensions
  • skins
  • installcheck.php

Copy the content extracted elements directly into the directory <installpath-mediawiki>.

The directories extensions and skins already exist in the MediaWiki files. Integrate the files of these directories in one directory. This means that you will get one extensions and one skins directory.

The following files and directories need to be renamed:

  • <installpath-mediawiki>/extensions/wikiDistribution/wikiDistribution.php.template to
    <installpath-mediawiki>/extensions/wikiDistribution/wikiDistribution.php
  • <installpath-mediawiki>/extensions/wikiExtensions/wikiExtensions.php.template to
    <installpath-mediawiki>/extensions/wikiExtensions/wikiExtensions.php
  • <installpath-mediawiki>/extensions/wikiFoundation/data.template to
    <installpath-mediawiki>/extensions/wikiFoundation/data
  • <installpath-mediawiki>/extensions/wikiFoundation/config.template to
    <installpath-mediawiki>/extensions/wikiFoundation/config

The following directories have to be writable by the web server:

(Under Linux issue e. g. chmod -R a+w <path> )

  • <installpath-mediawiki>/cache
  • <installpath-mediawiki>/images
  • <installpath-mediawiki>/extensions/wikiFoundation/data
  • <installpath-mediawiki>/extensions/wikiFoundation/config

Checking the requirements

To check further requirements for the installation, access <mediawiki-url>/installcheck.php via browser. The page shows additional information about the installation as well as occurring errors (e. g. concerning missing rights).

If everything is OK (green "OK") you can proceed to the setup of WikiSoftware:

Setup of WikiSoftware

Open the file <installpath-mediawiki>/LocalSettings.php in a text editor and add the following lines at the very end:

require_once("$IP/extensions/wikiDistribution/wikiDistribution.php");
require_once("$IP/extensions/wikiFoundation/wikiFoundation.php");
require_once("$IP/extensions/wikiExtensions/wikiExtensions.php");
require_once("$IP/skins/wikiSkin/wikiSkin.php");

Configuration of WikiSoftware

update.php

Manually execute this on the server's command line.

php maintenance/update.php

The output should look something like this:

(...)
Creating ws_whoisonline table...ok
(...) 
Creating ws_saferedit table...ok
(...)
...done.

WikiSoftware for MediaWiki can now be reached at <mediawiki-url> by browser.

MediaWiki web updater (WikiSoftware 2.22.1+)

Open <installpath-mediawiki>/mw-config/ and follow the steps! Further instructions can be found on the official MediaWiki Documentation

Security

After your WikiSoftware is up and running, follow these steps to provide additional security:

  • Remove the file <installpath-mediawiki>/installcheck.php
  • In order for the SecureFileStore feature to work you are required to deny HTTP access to the <installpath-mediawiki>/images directory!
  • If you want to use the FlexiSkin feature, you have to except the directory <installpath-mediawiki>/images/wiki/flexiskin from above access restriction
  • Details on how to configure this are here.
  • Stop Tomcat from being publicly accessible. Edit the file $CATALINA_HOME\conf\server.xml (Windows) or $CATALINA_HOME/conf/server.xml (Linux) and look for the following section: <Connector port="8080" maxHttpHeaderSize="8192" ... Add address="localhost" and restart Tomcat.

Performance

Windows

Use $wgDwserver = "127.0.0.1"; instead of $wgDwserver = "localhost"; in your LocalSettings.php

(due to a MySQL problem with IPv6).

If you're using the WinCache Extension for PHP (php_wincache.dll) do NOT set $wgMainCacheType = CACHE_ACCEL; in your LocalSettings.php! Use $wgMainCacheType = CACHE_NONE; instead!

Almost done

If you don't want to use WikiSoftware's Universal Export or Extended Search features, you are already done here. If you do, you'll need to complete the following steps:

Wewservices

The WikiSoftware extensions "ExtendedSearch" and "Universal Export" are implemented as Java web services. These must be deployed to an Application Server such as Apache Tomcat. For this manual we assume a running Tomcat installation at $CATALINA_HOME.

ExtendedSearch

The Tomcat connector must be configured with URIEncoding="UTF-8":

Edit the file $CATALINA_HOME\conf\server.xml (Windows) or $CATALINA_HOME/conf/server.xml (Linux) to include it:

<Connector port="8080" maxHttpHeaderSize="8192" URIEncoding="UTF-8" ...

Create the directory for the search index and copy the directory solr from <unzipped-archive>/extensions/wikiExtensions/ExtendedSearch/wewservices into it:

Windows:

mkdir C:\xampp\wiki_data\
copy <unzipped-archive>\extensions\wikiExtensions\ExtendedSearch\wewservices\solr C:\xampp\wiki_data\

Linux:

mkdir -p /opt/wiki_data
cp -r <unzipped-archive>/extensions/wikiExtensions/ExtendedSearch/wewservices/solr /opt/wiki_data/
chown -R tomcat6 /opt/wiki_data/solr # given that tomcat6 is the tomcat user

The path to the Solr configuration (solr directory containing solr.xml) needs be set in Tomcat via the variable solr.solr.home.

On Windows add the following line at the beginning of the file $CATALINA_HOME\bin\catalina.bat:

set JAVA_OPTS=%JAVA_OPTS% -Dsolr.solr.home=C:\xampp\wiki_data\solr

On Linux (Debian) add the following line to the end of the file /etc/default/tomcat6:

JAVA_OPTS="$JAVA_OPTS -Dsolr.solr.home=/opt/wiki_data/solr"

Restart Tomcat.

Now deploy "solr.war" from <unzipped-archive>/extensions/wikiExtensions/ExtendedSearch/wewservices by copying it to $CATALINA_HOME\webapps\ (Windows) / $CATALINA_HOME/webapps/ (Linux):

Make sure the file <installpath-mediawiki>/extensions/wikiExtensions/wikiExtensions.php contains the line

require_once( __DIR__."/ExtendedSearch/ExtendedSearch.setup.php" );

Execute update.php again!

Configure WikiSoftware to use the "Extended Search" web service in your browser:

WikiSoftware (navigation on the left) -> Admin -> Preferences -> WikiSoftware -> WikiSoftware - Mediawiki Settings -> Extended Search:

Universal Export

With WikiSoftware 2.22 two PDF Export Backends are shipped. The following table gives you a short overview:

&nwsp; bn2pdf.war wsHtml2PDF.war
JRE 6 7
Apache Tomcat 6 7
Implementation SOAP Servlet 3.0
URL in WikiAdmin (i.e.) http://localhost:8080/bn2pdf http://localhost:8080/wshtml2PDF

Deploy the WAR file needed by copying it from <installpath-mediawiki>\extensions\wikiExtensions\UEModulePDF\wewservices\ to $CATALINA_HOME\webapps\ (Windows) / $CATALINA_HOME/webapps/(Linux).

Make sure the file <installpath-mediawiki>/extensions/wikiExtensions/wikiExtensions.php contains the lines

require_once( __DIR__."/UniversalExport/UniversalExport.setup.php" );
require_once( __DIR__."/UEModulePDF/UEModulePDF.setup.php" );

Configure WikiSoftware to use the "Universal Export" web service in your browser:

WikiSoftware (navigation on the left) -> Admin -> Preferences -> WikiSoftware -> WikiSoftware - MediaWiki settings -> UniversalExport PDF Module.

Finish

Your WikiSoftware installation should be working now. Have fun!