BlueSpice 2.27.0 Installation Manual without Installer

From BlueSpice

Jump to: navigation, search


This document describes the installation steps for all BlueSpice 2.27.0 releases over the base of an already existing Mediawiki installation.

If you haven't installed Mediawiki yet, try the installer version of Blue Spice 2.27.0, which already contains Mediawiki 1.27. For the installation of BlueSpice with the installer please find an separat installation manual here.

About this manual

  • Please read this manual completely and follow the installation steps in the given order.
  • For editing the configuration files in a text editor, it is necessary to save the files in UTF-8 code without BOM (Byte Order Mark).
  • The placeholder <unzipped-archive> is representative for the path, where you unzipped the downloaded extension.
  • The placeholder <mediawiki-url> is representative for the URL of your MediaWiki, e.g. http://localhost/mediawiki.
  • The placeholder <installpath-mediawiki> is representative for the path to your MediaWiki installation, e.g. C:\inetpub\wwwroot (Windows) or /var/www/bluespice (Linux).

Requirements

For the installation of BlueSpice, an already installed and fully configured MediaWiki 1.22.x - 1.24.x is re-quired. This must be accessable at <mediawiki-url> in your browser (with started web and database server).

Installation

After downloading BlueSpice 2.27.0 extract it with an appropriate extraction program (e.g. 7-zip, WinZip) and save it at <unzipped-archive>.

Components of BlueSpice

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

  • extensions
  • skins
  • installcheck.php
  • LocalSettings.BlueSpice.php.template
  • LocalSettings.BlueSpiceDistribution.php

Copy the extracted elements directly into the directory <installpath-mediawiki>. The directories "extensions" and "skins" already exist there. Just integrate the content of the direcotries into the appropriate MediaWiki directories.

Renaming files & directories

The following files and directories need to be renamed:

<installpath-mediawiki>/extensions/BlueSpiceFoundation/data.template

to

<installpath-mediawiki>/extensions/BlueSpiceFoundation/data



<installpath-mediawiki>/extensions/BlueSpiceFoundation/config.template

to

<installpath-mediawiki>/extensions/BlueSpiceFoundation/config



<installpath-mediawiki>/LocalSettings.BlueSpice.php.template

to

<installpath-mediawiki>/LocalSettings.BlueSpice.php


Set write permissions

The following directories have to be writable by the web server: (Under Linux issue e. g. chmod -R a+w)

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

Requirements check

Output of installcheck.php

In order to check further conditions for the installation, start <mediawiki-url>/installcheck.php in your browser. Further requirements and information for the installation as well as occurring errors (e.g. missing permissions) will be displayed there.

If everything is alright (indicated by the green OK, see image below), you can go on with the setup of BlueSpice.


Setup of BlueSpice

Open the file <installpath-mediawiki>/LocalSettings.php in a text editor (e.g. Notepad++) and add the following line at the very end of the code:

require_once "$IP/LocalSettings.BlueSpice.php";

Updating the database

You can update the database by two different ways as described below. After the update, BlueSpice for MediaWiki can be reached at <mediawiki-url> by browser.

By command line / terminal

Open your command line or terminal in <installpath-mediawiki> and execute the following command there:

Windows: php maintenance/update.php

Linux: php /maintenance/update.php


The output should look like this:

(...)
Creating bs_whoisonline table...ok
(...) 
Creating bs_saferedit table...ok
(...)
...done.


MediaWiki web updater

Open <installpath-mediawiki>/mw-config/ in your browser and follow the instructions. Further information can be found on the official MediaWiki Documentation


End of the default installation

If you don't want to use the PDF export and the extended search of BlueSpice, you're already done here!


Installation of the BlueSpice-Webservices

The BlueSpice extensions "ExtendedSearch" and "Universal Export" (PDF export) are implemented by Java web services. These must be provided on an Application Server such as Apache Tomcat. For the following description we assume a running Tomcat installation at $CATALINA_HOME.

ExtendedSearch

Create index directory

Open the command line or the terminal and execute the following commands:

Windows:

mkdir C:\xampp\bluespice_data\solr
xcopy <installpath-mediawiki>\extensions\BlueSpiceExtensions\ExtendedSearch\webservices\solr 
C:\xampp\bluespice_data\solr /s

Linux:

mkdir -p /opt/bluespice_data
cp -r <installpath-mediawiki>/extensions/BlueSpiceExtensions/ExtendedSearch/webservices/solr
/opt/bluespice_data/
chown -R tomcat6 /opt/bluespice_data/solr # (# provided that tomcat6 is the tomcat user)

Adding stop word list

The "More like this (Mlt)" feature needs a stop word list in the content language of your wiki to run without any problems.

Open the language configuration folder at
<installpath-mediawiki>\bluespice_data\solr\bluespice\conf\lang. Many lists for different languages can be found here. Copy the stop word list with the language code which fits to your language of the wiki content, e.g. for English content: ->\stopwords_en.txt

Copy the appropriate file into the following directory:
bluespice_data\solr\bluespice\conf

Afterwards rename

bluespice_data\solr\bluespice\conf\stopwords_en.txt

to

bluespice_data\solr\bluespice\conf\stopwords.txt

Path to solr config

The path to the Solr configuration (the conf-file contains solr.xml) now has to be set by the variable solr.solr.home.

Open the command line and

... add the following lines at the beginning of the file $CATALINA_HOME\bin\catalina.bat (Windows):

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

... add the following lines at the end of the file /etc/default/tomcat6 (Linux Debian):

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

Restart Tomcat now.

Deploy solr.war

Now copy "solr.war" from
<unzipped-archive>\extensions\BlueSpiceExtensions\ExtendedSearch\webservices
to

\$CATALINA_HOME\webapps\  (Windows)

or

/$CATALINA_HOME/webapps/  (Linux)

Integration in MediaWiki

If you have not yet done so, copy the file <installpath-mediawiki>\extensions\BlueSpiceExtensions\BlueSpiceExtensions.default.php and save it as <installpath-mediawiki>\extensions\BlueSpiceExtensions\BlueSpiceExtensions.local.php.

Make sure the file <installpath-mediawiki>\extensions\BlueSpiceExtensions\BlueSpiceExtensions.local.php contains the following line and is not commented out ('#' at the beginning of a line)

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

Execute update.php again (as described above)!

Configure the ExtendedSearch

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

Admintab (gear symbol) -> Preferences -> Extended Search:

  • Solr URL (default = http://127.0.0.1:8080/solr)

Universal Export

Deploy BShtml2PDF.war

Now copy "BShtml2PDF.war" from <installpath-mediawiki>/extensions/BlueSpiceExtensions/UEModulePDF/webservices to the following directory:

Windows:

$CATALINA_HOME\webapps\

Linux:

/$CATALINA_HOME/webapps/

Integration in MediaWiki

If you have not yet done so, copy the file <installpath-mediawiki>\extensions\BlueSpiceExtensions\BlueSpiceExtensions.default.php to <installpath-mediawiki>\extensions\BlueSpiceExtensions\BlueSpiceExtensions.local.php.

Make sure the file <installpath-mediawiki>\extensions\BlueSpiceExtensions\BlueSpiceExtensions.local.php contains the following line and is not commented out ('#' at the beginning of a line)

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

Configure the UniversalExport

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

Admintab (gear symbol) -> Preferences -> Universal Export PDF module:

  • Backend URL (default = http://localhost:8080/BShtml2PDF)

Finish

If you worked through all of the installation steps, the BlueSpice installation should be completed successfully now and you can start working with your new BlueSpice. Have fun!


Further Configuration

Security settings

After you configured your BlueSpice successfully, please follow these steps to increase the security of the system:

  • Delete the file <installpath-mediawiki>/installcheck.php
  • To make sure that the feature SecureFileStore will work correctly, prohibit the direct http access to the directory

<installpath-mediawiki>/images

  • If you want to use the feature FlexiSkin, you need to exclude the directory

<installpath-mediawiki>/images/bluespice/flexiskin

from the previously mentioned rule.


Increasing performance on Windows

If you are using BlueSpice for MediaWiki with Windows, make sure that you use

$wgDBserver = "127.0.0.1";

instead of

$wgDBserver = "localhost";

in your LocalSettings.php (due to MySQL issues with IPv6).

Using img_auth

If you wish to use img_auth instead of SecureFileStore please follow these steps:

1. Open the file

<installpath-mediawiki>/extensions/BlueSpiceExtensions/BlueSpiceExtensions.local.php

Deactivate SecureFileStore by uncommenting the following line:

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

2. Insert the following line into your LocalSettings.php before you include the BlueSpice extensions:

$wgUploadPath = $wgScriptPath."/img_auth.php";

Other helpful settings

For a list of commonly used MediaWiki settings that may prove useful, take a look at this configuration.


Support

You can find support here: