Setup:Installation Guide/With Installer

With BlueSpice 3, we offer the installation as a complete package with MediaWiki and BlueSpice.

These installation manual give you step-by-step instructions to install BlueSpice.

Tip for this Document

This document only describes the steps for installing the web application. For the installation of extended functions such as VisualEditor and ExtendedSearch, please refer to the corresponding documentation.

We will not go into details about your operating system installation here, but assume that you have already configured your system and stored the installation package in a Webroot of your choice, where you can access it via your browser.

Further help on the operating system setup can be found in our compendium.

RequirementsDie Installation in Einzelschritten

Web server

The system must already be running a Web server (IIS / Apache) that is configured to access <bluespice-url>.

PHP

PHP must be embedded in the web server. Ensure that the following modules are enabled:

• php-curl
• php-gd
• php-tidy

MariaDB/MySQL

A database server (MariaDB oder MySQL) must be set up and available. You need administrative access (root).

Download BlueSpice

Download the current version of BlueSpice directly at Sourceforge. The package is named BlueSpice-free-2.27.3.zip.

Unzip and Copy BlueSpice

Unzip the downloaded archive with BlueSpice. Note that the relevant content is located in the subfolder "bluespice-free-installer". Move the complete content to <installpath-bluespice> and integrate it into existing folders.

Renaming of Relevant Folders

Rename the following folders in <installpath-bluespice> as follows:

• extensions/BlueSpiceFoundation/data.template
  --> extensions/BlueSpiceFoundation/data
• extensions/BlueSpiceFoundation/config.template
  --> extensions/BlueSpiceFoundation/config

Adjusting File System Permissions

Make sure that the following folders in <installpath-bluespice> are accessible and writable by the webserver:

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

Detailed information about the file system permissions can also be found in our installation manual at the security settings. 

Starting the installation

Open <bluespice-url> in your browser. You should get the start page for installation:

Continue by clicking "set up the wiki".

Language selection

You will be asked for the language during the installation process and the system language of your installation

Select the required language and click "Next".

If you want to run your Wiki in German, please note that you have the choice between informal ("de") and formal ("de-formal") mode.

Checking the Installation Environment

The following page should allow you to skip with "Next" in most cases. If errors (red font) are displayed, there is a need for action at your server environment. Please do the necessary corrections.

Database Settings

On the following page, you will be prompted to enter your database settings.

If the database server is on the same PC as the MediaWiki installation, please do not use "localhost" but "127.0.0.1".

The database itself is created in the further process if it does not already exist. You do not have to create the database in advance.

The database table prefix does not have to be specified. This only makes sense if you need the database for other database tables than for your MediaWiki installation.

Please enter the user name and password of the administrative database user (usually root).

Click "Next".

On the second page about the database it is recommended to create your own database user for your installation. Deactivate the checkbox "Use the same database account as during the installation process" and enter a username and password of your choice. Activate the checkbox "If not already existing, you have to create the account now".

Then click "Next".

Wiki Settings

Now enter a name of your choice for your wiki. You can also define an administrative user and his password here. You can change the email address of this user at any time in the user settings. Leave all the other settings as they are and click "Next".

Extended Settings

The settings on the now displayed page should be set as shown in the following screenshot. Please adjust the email address according to your needs, the paths in the section "Uploading Images and Files" are automatically filled and should be left as they are.

At this point, no MediaWiki standard extensions will be chosen. The neccessary extensions for BlueSpice will be integrated during the BlueSpice setup. 

Then click on "Next". Also confirm the following pages with "Next". 

All necessary settings are made now. Please confirm with "Next" again.

Deposit LocalSettings.php

Finally, the "LocalSettings.php"  will be provided for downloading it. Please do this and move the file to <installpath-bluespice>.

Checking the Installation Requirements

Call up the file installcheck.php at <bluespice-url> in your browser (example: http://localhost/installcheck.php). Correct all red (error) and ideally yellow (warning) declared messages (mostly in the php.ini) like specified. Please note, that changes in the php.ini may require a restart of the webserver. Do not continue until you have been able to remove at least all errors (red). 

Check Installation

Call <bluespice-url> in your browser. BlueSpice should now be successfully installed and a login with your access data should be possible.

Further configuration

Your BlueSpice installation is now ready to use. You can also do some further configuraiton: 

• Setup of the extended search
• Setup of the PDF export

Also, some security settings are recommended.

Rufen Sie zunächst mit Ihrem Browser die URL auf, unter der die Webanwendung erreichbar ist. Führen Sie anschließend folgende Schritte durch:

300px|BlueSpice 3 Installation Step 1	Sollten Sie noch nicht alle nötigen Voraussetzungen für PHP erfüllen, werden Sie diese Einstiegsseite zum Setup noch nicht betrachten können. Bitte nehmen Sie dann zuerst die nötigen Korrekturen an Ihrer PHP-Installation vor. Andernfalls befinden Sie sich nun auf der im Screenshot gezeigten Seite. Klicken Sie auf "set up the wiki", um die Installation zu beginnen.
300px|BlueSpice 3 Installation Step 2	Sie befinden sich jetzt in der Sprachauswahl. "Your language" definiert die Sprache, mit der Sie durch den Installer geführt werden, "Wiki language" die spätere Sprache Ihres Wikis. Bei der Wahl von "de" beachten Sie bitte die Unterscheidung zwischen de (Du-Form) und de-formal (Sie-Form).
300px|BlueSpice 3 Installation Step 3	Im nächsten Schritt werden Sie zum Installationscheck von MediaWiki geführt. Lesen Sie diesen aufmerksam durch, da eventuelle Hinweise zwar die Installation nicht blockieren, aber später in der Praxis zu Einschränkungen der Wiki-Funktionalität führen können. Nehmen Sie eventuell gewünschte Korrekturen an Ihrem System vor und laden Sie die Seite in Ihrem Browser neu bevor Sie mit dem Setup fortfahren.
300px|BlueSpice 3 Installation Step 4	Anschließend wird die Verbindung zur Datenbank konfiguriert. Sie können hier entweder den root-User Ihres MySQL-Servers angeben und im folgenden Schritt einen zusätzlichen User vom Installer anlegen lassen, der nur Zugang zur BlueSpice-Datenbank hat. Auch die Datenbank wird so automatisch angelegt, sollte Sie noch nicht existieren. Alternativ können Sie bereits im Vorfeld einen Nutzer und auch eine Datenbank anlegen und direkt diese Angaben hier eintragen. Informationen zum manuellen Anlegen von Benutzer und Datenbank finden Sie in der offiziellen Mediawiki-Dokumentation.
300px|BlueSpice 3 Installation Step 5	Je nachdem, nach welchem Verfahren Sie im vorherigen Schritt vorgegangen sind können Sie jetzt einen exklusiven User für Ihre BlueSpice-Datenbank definieren. Haben Sie den Benutzer im Vorfeld bereits explizit für die Datenbank angelegt belassen Sie den Haken bei "Dasselbe Datenbankkonto wie während des Installationsvorgangs verwenden".
300px|BlueSpice 3 Installation Step 6	Geben Sie den Namen für Ihr Wiki ein. Dieser Name wird in der Titelleiste Ihres Browsers ausgegeben sowie an diversen anderen Stellen wie bspw. in Notification-Mails. Achten Sie auf die richtige Schreibweise, da dieser Name im Nachhinein nur mit gewissem Aufwand und gewissen Risiken geändert werden kann. Außerdem vergeben Sie hier Username, Passwort und E-Mail-Adresse des ersten administrativen Benutzers, der vom Wiki während des Setups angelegt werden soll.
300px|BlueSpice 3 Installation Step 7	In diesem Schritt geben Sie die Mailadresse an, die bei Notification-Mails als Absenderadresse verwendet werden soll.
300px|BlueSpice 3 Installation Step 8	Diesen Schritt können Sie direkt mit "Weiter" überspringen.
300px|BlueSpice 3 Installation Step 9	Nach der erfolgreichen Installation von BlueSpice erhalten Sie diese Bestätigungsseite, die Sie mit "Weiter" bestätigen.
300px|BlueSpice 3 Installation Step 10	Im letzten Schritt der Installation werden Sie zum Download der Konfigurationsdatei "LocalSettings.php" Ihrer Installation aufgefordert. Laden Sie diese herunter und legen Sie diese im Hauptverzeichnis Ihrer BlueSpice-Codebase ab.
300px|BlueSpice 3 Installation Step 11	Wenn Sie nun auf die von Ihnen festgelegte URL von BlueSpice zugreifen erhalten Sie die vollendete Installation und können nun direkt mit der Benutzung von BlueSpice starten.