Last edited one week ago
by WikiSysop

Setup:Installation Guide/With Installer: Difference between revisions

No edit summary
Tag: 2017 source edit
No edit summary
Tag: 2017 source edit
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Installing BlueSpice 3 with installer}}
{{DISPLAYTITLE:Installing BlueSpice 4}}
__TOC__
{{Messagebox|boxtype=neutral|icon=yes|Note text=[https://bluespice.com/download/ Download the installation package]  from the bluespice.com website.


Store the installation package in a web root of your choice (see our [[Setup:Installation_Guide/Advanced/Folder_structure_under_Windows|folder structure recommendations]] for Windows installations), where you can access it via your browser.|bgcolor=}}
==Introduction==
==Introduction==
BlueSpice 4 is installed  as a complete package with MediaWiki 1.35 and BlueSpice 4.
BlueSpice 4 is installed  as a complete package with MediaWiki 1.35 and BlueSpice 4.
This installation guide gives you step-by-step instructions to install BlueSpice.
This installation guide gives you step-by-step instructions to install BlueSpice.


{{Messagebox|boxtype=important|Note text=If you do a fresh install of BlueSpice 4.1, it might be necessary to run update.php afterwards if you get an error.|bgcolor=|icon=}}
{{Messagebox|boxtype=important|Note text=If you do a fresh install of BlueSpice 4, it might be necessary to run update.php afterwards if you get an error.|bgcolor=|icon=}}This document only describes the steps for installing the web application itself. For the installation of extended functions such as [[Setup:Installation_Guide/Advanced/VisualEditor_Configuration|VisualEditor]] and [[Setup:Installation Guide/Advanced/ExtendedSearch Configuration|Extendedsearch]], please refer to the corresponding documentation.
{{Messagebox|boxtype=note|Note text=This document only describes the steps for installing the web application itself. For the installation of extended functions such as [[Setup:Installation_Guide/Advanced/VisualEditor_Configuration|VisualEditor]] and [[Setup:Installation Guide/Advanced/ExtendedSearch Configuration|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 checked the [[Setup:Installation_Guide#Prerequesites|system requirements]] and your server configuration.  You can find more details in our detailed [[Setup:Installation Guide|installation guide]].


We will not go into details about your operating system installation here, but assume that you have already [[Setup:Installation_Guide#Prerequesites|configured your system]] and stored the installation package in a web root of your choice, where you can access it via your browser. You can find more details in our detailed [[Setup:Installation Guide|installation guide]].
Further help on optimizing the operating system can be found in our [[Setup:Installation Guide/Advanced|compendium]].
 
 
Further help on optimizing the operating system can be found in our [[Setup:Installation Guide/Advanced|compendium]].}}
==Step-by-step installation==
==Step-by-step installation==


{{Messagebox|boxtype=tip|Note text=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!
{{Messagebox|boxtype=note|icon=|Note text=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!
}}
|bgcolor=}}


{| class="wikitable"
First use your browser to call up the URL under which the web application can be reached. Then complete the following steps:
{| class="wikitable" style=""
|-
|-
||'''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.  
|[[File:Setup:mediawiki-setup-page.png|alt=MediaWiki setup page php error|300x300px]]
||'''Step 1Start 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.  


 
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).
'''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.<br /><br />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.  
|[[File:Setup:Screenshot (213) 123.png|alt=Select language|300x300px]]
 
||'''Step 2: Select your language'''
 
You are now in the language selection.
"Your language" defines the language that guides you through the installer,  
"Your language" defines the language that guides you through the installer,


"Wiki language" the later language settings of your wiki.
"Wiki language" the later language settings of your wiki.
|-
|-
||'''Step 3 - MediaWiki Installation Check:''' This step takes you to the MediaWiki installation check.  
|[[File:Setup:Screenshot (215)3.png|alt=Installation check|300x300px]]
 
||'''Step 3MediaWiki 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.  
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.
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.
|[[File:Setup:Screenshot (218).png|alt=Database connection|300x300px]]
 
||'''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.  
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 [[mediawikiwiki:Manual:Installing_MediaWiki#MariaDB/MySQL|official Mediawiki documentation]].
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 [[mediawikiwiki:Manual:Installing_MediaWiki#MariaDB/MySQL|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.  
|[[File:Setup:bs3-install-05.png|alt=Database user|300x300px]]
 
||'''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".
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".
|-
|-
||'''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.  
|[[File:Setup:bs3-install-06.png|alt=Wiki name and admin account|300x300px]]
 
||'''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.
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.
 
 
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.
|[[File:Setup:Screenshot (223)e.png|alt=Email options|center|300x300px]]
||'''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 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".
|[[File:Setup:Screenshot (219).png|alt=Installation status|center|300x300px]]
||'''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.
|[[File:Setup:Screenshot (224).png|alt=Download localsettings.php|300x300px]]
||'''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 <code>..\extensions\BluesSpiceFoundation</code> and rename the subfolder <code>config.template</code>  to <code>config</code> and create the new folder <code>data</code>. These folders should have read and write access, see  [[Setup:Installation Guide/Security Settings/File System Permissions|File System Permissions]].
|
|'''Step 11: Rename the template folders'''
Open the folder <code>..\extensions\BluesSpiceFoundation</code> and rename the subfolder <code>config.template</code>  to <code>config</code> and create the new folder <code>data</code>. These folders should have read and write access, see  [[Setup:Installation Guide/Security Settings/File System Permissions|File System Permissions]].
Run the script <code>..\maintenance\update.php</code> from the console.
Run the script <code>..\maintenance\update.php</code> 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.
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.
|[[File:Setup:Screenshot Landingpage.png|alt=BlueSpice start page|300x300px]]
||'''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.
|}
|}


Line 86: Line 91:
*php maintenance/update.php ''(Linux)''
*php maintenance/update.php ''(Linux)''
*php maintenance\update.php ''(Windows)''
*php maintenance\update.php ''(Windows)''
==Next steps ==
{{Messagebox|boxtype=note|Note text=If the page is not loading, give the group "users" change-permissions for the folder C:\Windows\Temp.}}
{{Messagebox|boxtype=note|Note text=If the page is not loading, give the group "users" change-permissions for the folder C:\Windows\Temp.}}
{{Messagebox|boxtype=important|Note text=As next step, you can configure [[Setup:Installation Guide/Advanced/VisualEditor Configuration|VisualEditor]] and [[Setup:Installation Guide/Advanced/ExtendedSearch Configuration|Extendedsearch]].}}
{{Messagebox|boxtype=important|Note text=As next step, you can configure [[Setup:Installation Guide/Advanced/VisualEditor Configuration|VisualEditor]] and [[Setup:Installation Guide/Advanced/ExtendedSearch Configuration|Extendedsearch]].}}
[[en:{{FULLPAGENAME}}]]
[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Installation von BlueSpice]]
[[de:Setup:Installationsanleitung/Installation von BlueSpice]]

Revision as of 10:46, 22 September 2022

Download the installation package from the bluespice.com website.


Store the installation package in a web root of your choice (see our folder structure recommendations for Windows installations), where you can access it via your browser.

Introduction

BlueSpice 4 is installed as a complete package with MediaWiki 1.35 and BlueSpice 4. This installation guide gives you step-by-step instructions to install BlueSpice.

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

This document only describes the steps for installing the web application itself. 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 checked the system requirements and your server configuration. You can find more details in our detailed installation guide.

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

Step-by-step installation

Note: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!


First use your browser to call up the URL under which the web application can be reached. Then complete the following steps:

MediaWiki setup page php error 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.

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

Select language 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.

Installation check 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.

Database connection 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.

Database user 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".

Wiki name and admin account 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.

Email options
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.

Installation status
Step 9: Installation status

After the successful installation of BlueSpice, you see a confirmation page that you confirm with "Next".

Download localsettings.php 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.

BlueSpice start page 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)

Next steps

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.



To submit feedback about this documentation, visit our community forum.

No categories assignedEdit

Discussions