Setup:Installation Guide/With Installer

Introduction

With BlueSpice 3, we offer the installation as a complete package with MediaWiki and BlueSpice. These installation manual give This installation guide gives you step-by-step instructions to install BlueSpice.

Tip for this Document

Important! If you do a fresh install of BlueSpice 3.2 it might be necessary to run update.php afterwards if you get an error.

Note: This document only describes the steps for installing the web application itself. For the installation of extended functions such as VisualEditor and

ExtendedSearch

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

web root of your choice, where you can access it via your browser. You can find more details in our detailed installation guide.

Further help on optimizing the operating system

setup

can be found in our compendium.

RequirementsStep-by-step installation

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

If you also install the paid extension "BlueSpiceWikiFarm", make sure that the codebase is not located directly in the DocumentRoot of your web server or VirtualHost - it must be located in the /w subfolder!

	Step 1 - Start the installation setup: First, open the URL of your web application in your browser. Then click on "set up the wiki" to start the installation. Note: If you don't meet all necessary requirements for PHP yet, you won't be able to view this setup page yet. Please make the necessary corrections to your PHP installation first. Otherwise, you are now on the page shown in the screenshot (click on the thumbnail to see the full screenshot).
	Step 2 - Select your language: You are now in the language selection. "Your language" defines the language that guides you through the installer, "Wiki language" the later language settings of your wiki.
	Step 3 - MediaWiki Installation Check: This step takes you to the MediaWiki installation check. Please read this check carefully, as possible hints may not block the installation itself, but may lead to restrictions of the wiki functionality in practice. Make the necessary corrections to your system and reload the page in your browser before proceeding with the setup.
	Step 4 - Establish the database connection: In this step, you configure the database connection. Here you can either specify the root user of your MySQL server and in the following step have the installer create an additional user who only has access to the BlueSpice database. The database will also be created automatically if it does not yet exist. Or, alternatively, you can create a user and a database in advance and directly enter this information here. You can find information on the manual creation of users and databases in the official Mediawiki documentation.
	Step 5 - Create the BlueSpice database user: Depending on the procedure you followed in the previous step, you can now define an exclusive user for your BlueSpice database. If you have already created the user explicitly for the database in advance, leave the check mark at "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.

	Step 6 - Create your wiki name and administrator account: Enter the name for your wiki. This name is displayed in the title bar of your browser and in various other places such as in notification mails. Pay extra attention to the correct spelling, because this name can afterwards only be changed with a certain effort and certain risks. Next, enter the username, password and e-mail address of the first wiki administrator. The administrator account is then created by the wiki during setup.
	Step 7 - Options: In this step, you specify the e-mail address for notification e-mails.
	Step 8 - Installation: This step announces the installation of the wiki. If you don't need to make any changes to the previous steps, click "Next" to start the installation process.
	Step 9 - Installation status: After the successful installation of BlueSpice, you see a confirmation page that you confirm with "Next".
	Step 10 - Download LocalSettings.php: In the last step of the installation, you will be asked to download the configuration file "LocalSettings.php" of your installation. Download it and place it in the root directory of your BlueSpice codebase.
	Step 11 - Rename the template folders: Open the folder ..\extensions\BluesSpiceFoundation and rename the subfolder config.template to config and create the new folder data. These folders should have read and write access, see File System Permissions. Run the script ..\maintenance\update.php from the console. If you receive the error message "Fatal exception of type MWException", open the terminal and run the command "sudo nautilus". After that, give the folder /var where bluespice was installed all rights.
	Step 12 - Load the BlueSpice welcome page: If you now access the URL you specified for BlueSpice, you now see the BlueSpice welcome page. You can start using BlueSpice immediately.

BlueSpice WikiFarm

If you are installing BlueSpice WikiFarm follow these instructions

Now open a command line and change to the folder <installpath-bluespice>. Run the following command:

• php maintenance/update.php (Linux)
• php maintenance\update.php (Windows)

Note: If the page is not loading, give the group "users" change-permissions for the folder C:\Windows\Temp.

Important! As next step, you can configure VisualEditor and Extendedsearch.