BlueSpice 2.27.0 Installation Manual with Installer

From BlueSpice

Jump to: navigation, search

This document describes the installation steps for all BlueSpice 2.27.0 releases.

For running the Mediawiki web installer see Manual:Installation_guide or Manual:Running_MediaWiki_on_FreeBSD

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

Installation

Set write permissions

After downloading BlueSpice and unpacking it at <installpath-mediawiki>, the following directories have to be set to writable on the web server: (Under Linux issue e. g. chmod -R a+w)

  • /cache
  • /images
  • /extensions/BlueSpiceFoundation/data
  • /extensions/BlueSpiceFoundation/config

Installation of MediaWiki and BlueSpice

Open <mediawiki-url> in your browser and follow the instructions. Don't make any changes to the selection of extensions for your installation. Further information can be found in the MediaWiki documentation.

Requirements check

Output of installcheck.php
In order to check futher 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 already start using your BlueSpice.

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
<installpath-mediawiki>\extensions\BlueSpiceExtensions\ExtendedSearch\webservices
to

\$CATALINA_HOME\webapps\  (Windows)

or

/$CATALINA_HOME/webapps/  (Linux)

Integration in MediaWiki

Add the following line to the very end of your <installpath-mediawiki>\LocalSettings.php file:

wfLoadExtension( 'BlueSpiceExtensions/ExtendedSearch );

Open the command line or terminal in <installpath-mediawiki>. Execute the follwing command:

Windows:

php maintenance\update.php

Linux:

php maintenance/update.php

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

Add the following lines to the very end of your <installpath-mediawiki>\LocalSettings.php file:

wfLoadExtension( 'BlueSpiceExtensions/UEModulePDF' ); wfLoadExtension( 'BlueSpiceExtensions/UniversalExport' );

Open the command line or terminal in <installpath-mediawiki>. Execute the follwing command:

Windows:

php maintenance\update.php

Linux:

php maintenance/update.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: