Extension:BlueSpice/BlueSpice fully featured install

This document describes the installation steps for the first stable version of BlueSpice for MediaWiki (Fully Featured).

About this manual
If you installed MediaWiki directly into  then   and   are identical.
 * The manual should be read completely and followed step-by-step.
 * When editing configuration files in a text editor be sure to save them as UTF-8 without BOM (Byte Order Mark).
 * The string  represents the place where you unzipped the downloaded extension.
 * The string  represents the URL of your Mediawiki installation, e.g..
 * The string  represents the file system path to your Mediawiki installation, e.g.   (Windows) or   (Linux).
 * The string  represents the file system path to the web server root, e. g.   (Windows) or   (Linux).

MediaWiki
For the installation of BlueSpice we assume that MediaWiki (version 1.15x or 1.16x) is installed and configured. It can be accessed via browser at.

Languages
Currently only the languages,   and   are supported.

Browser
BlueSpice works under Firefox 3.6+ and Internet Explorer 7+. Other browsers may work, but have not been tested properly so far.

Server
These login credentials to the database server should be known: (probably created during the installation of MediaWiki) With an installation on Xampp the username "root" with empty password is preset.
 * Web server (Apache 2, IIS 7+ seems to work fine but has not been thoroughly tested)
 * PHP versions 5.2.0, 5.2.6, 5.2.9, 5.3.0 and 5.3.2 were successfully tested.
 * PHP version 5.3.1 has a bug Bug due to which MediaWiki does not work. This affects e. g. Xampp 1.7.3.
 * MySQL from version 5.x
 * Host/IP address and port
 * Username and password for the root user (Create/Drop-Statements) and the Wiki-User
 * Name of the used database
 * The table prefix of the used database

Components of BlueSpice
The  contains the following directories and files:


 * bluespice-core
 * bluespice-mw
 * bluespice-skin
 * webservices
 * installcheck.php

Copy the contents of this file directly into the directory.

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

(Under Linux issue e. g. )

Checking the requirements
To check further requirements for the installation, access  via browser. The page shows additional information about the installation as well as occurring errors (e.&#x202f;g. concerning missing rights).



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

Setup of BlueSpice
Open the file  in a text editor and add the following lines at the very end:

 $wgUseAjax = true; $wgDefaultSkin = 'bluespice'; $wgStylePath = $wgScriptPath.'/bluespice-skin'; $wgStyleDirectory = $IP.'/bluespice-skin';

require_once( dirname(__FILE__).'/bluespice-core/index.php' ); BsCore::getInstance('MW')->setup;

// MediaWiki extensions require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/Lockdown/Lockdown.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/Quiz/Quiz.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/Poem/Poem.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/CategoryTree/CategoryTree.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/ImageMap/ImageMap.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/ParserFunctions/ParserFunctions.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/InputBox/InputBox.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/Nuke/Nuke.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/DynamicPageList/DynamicPageList.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/Cite/Cite.php' ); require_once( BsConfig::get('MW::AdapterPath').DS.'ext-dist/RSS/RSS.php' );

Configuration of BlueSpice
Point your browser at the URL.

Click "Start configuration" and fill in the necessary parameters (cf. screenshot).



User: Provide a database user who has the right to create tables in the database. The database user who is created via a standard MediaWiki installation does not necessarily have these rights! For testing (only!) you can use the MySQL-root-user.

Database: Fill in the database name and the prefix used when MediaWiki was installed.

Socket: Leave this field empty.

Core::BlueSpiceScriptPath: Fill in the path to the  directory starting at. See the following examples:

Core::UseMinify: Leave this unchecked.

If the submission of the configuration was successful, the message Configuration successfully finished. is shown in the browser.

WARNING: For security reasons we recommend to delete the file  as soon as BlueSpice is up and running.

Executing update.php
This step automatically creates additional database tables required by BlueSpice. Use the user/password combination from above.  $wgDBadminuser = 'wikiuser'; $wgDBadminpassword = 'your-password';
 * For MediaWiki 1.15.x make sure the file  exists. If it doesn't, copy the file   to.
 * For MediaWiki 1.16.x the according variables can be found in !
 * Open the respective file in a text editor and adjust the user name and password in the following lines:
 * In a command shell execute

Linux: php /maintenance/update.php Windows: php \maintenance\update.php The tables are now being created. Make sure the output looks something like this: Creating whoisonline table...ok Creating shoutbox table...ok

BlueSpice for MediaWiki can now be reached by browser at.

Webservices
If you wanted BlueSpice Basic you are already done here. For BlueSpice Fully Featured you'll need to complete the following steps: The BlueSpice extensions "ExtendedSearch" and "PDF-Export" are implemented as Java web services. These must be deployed to an Application Server such as Tomcat, Glassfish, Jboss or Jetty. For this manual we assume a running Tomcat installation at.

Extended Search
The Tomcat connector must be configured with :

Alter the file  (Windows) or   (Linux) to include it: \webservices\conf C:\xampp\bluespice_data\solr

Linux: mkdir -p /opt/bluespice_data/solr/ chown -R tomcat55 /opt/bluespice_data/solr/ # given that tomcat55 is the tomcat user cp -r \webservices/conf /opt/bluespice_data/solr/

The path to the Solr configuration ( directory containing  ) must be set in Tomcat via the variable  :

On Windows add the following line at the beginning of the file : set JAVA_OPTS=%JAVA_OPTS% -Dsolr.solr.home=C:\xampp\bluespice_data\solr

On Linux (Debian) add the following line to the end of the file : JAVA_OPTS="$JAVA_OPTS -Dsolr.solr.home=/opt/bluespice_data/solr"

Restart Tomcat.

Now deploy  from the unzipped archive by copying it to   (Windows)   (Linux):

Make sure the file  contains the line

BsExtensionManager::registerExtension('ExtendedSearch',     RUNLEVEL::FULL|RUNLEVEL::REMOTE, ACTION::ALL);

Now activate Extended Search in your browser and configure the new web service:

BlueSpice (navigation on the left) -> Admin -> Preferences -> Section Search
 * Check the box "EnableExtendedSearch"
 * SolrHost (default: 127.0.0.1)
 * SolrPath "/solr1.4"
 * SolrPort (cf. the connector port in your server.xml)

PDF-Export
Deploy  by copying it to   (Windows)   (Linux).

Make sure the file  contains the line

BsExtensionManager::registerExtension('UniversalExport',    RUNLEVEL::FULL, ACTION::ALL);

Now activate Universal Export in your browser and configure the new web service:

BlueSpice (navigation on the left) -> Admin -> Preferences -> Section Universal Export
 * PdfService (BN2PDF) URL (e. g. http://localhost:8080/bn2pdf-light)

Finish
Your BlueSpice installation should be working now. Have fun!

Support
If you need support visit the following links:


 * Support, Bug reports
 * Forums