Difference between revisions of "Setup:Installation Guide/With Installer"
[quality revision] | [unchecked revision] |
(Tag: Visual edit) |
Contents
- 1 Tip for this Document
- 2 Requirements
- 3 Download BlueSpice
- 4 Unzip and Copy BlueSpice
- 5 Renaming of Relevant Folders
- 6 Adjusting File System Permissions
- 7 Starting the installation
- 8 Language selection
- 9 Checking the Installation Environment
- 10 Database Settings
- 11 Wiki Settings
- 12 Extended Settings
- 13 Deposit LocalSettings.php
- 14 Checking the Installation Requirements
- 15 Check Installation
- 16 Further configuration
Please note that this installation guide does only work with the edition BlueSpice free! 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[edit | edit source]
<installpath-bluespice>
stands for the path to your BlueSpice installation, e.g C:\inetpub\wwwroot\bluespice
(Windows) or /var/www/bluespice
(Linux).
<bluespice-url>
stands for the URL to your future BlueSpice installation, e.g. http://localhost/bluespice.
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.
Requirements[edit | edit source]
Web server[edit | edit source]
The system must already be running a Web server (IIS / Apache) that is configured to access <bluespice-url>
.
PHP[edit | edit source]
PHP must be embedded in the web server. Ensure that the following modules are enabled:
- php-curl
- php-gd
- php-tidy
MariaDB/MySQL[edit | edit source]
A database server (MariaDB oder MySQL) must be set up and available. You need administrative access (root).
Download BlueSpice[edit | edit source]
Download the current version of BlueSpice directly at Sourceforge. The package is named BlueSpice-free-2.27.3.zip.
Unzip and Copy BlueSpice[edit | edit source]
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[edit | edit source]
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[edit | edit source]
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[edit | edit source]
Open <bluespice-url>
in your browser. You should get the start page for installation:
Continue by clicking "set up the wiki".
Language selection[edit | edit source]
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".
Checking the Installation Environment[edit | edit source]
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[edit | edit source]
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[edit | edit source]
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[edit | edit source]
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.
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[edit | edit source]
Finally, the "LocalSettings.php" will be provided for downloading it. Please do this and move the file to <installpath-bluespice>
.
Checking the Installation Requirements[edit | edit source]
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[edit | edit source]
Call <bluespice-url>
in your browser. BlueSpice should now be successfully installed and a login with your access data should be possible.
Further configuration[edit | edit source]
Your BlueSpice installation is now ready to use. You can also do some further configuraiton:
- Setup of the extended search search
- Setup of the PDF export
Also, some security settings are recommended.
{{DISPLAYTITLE:Installation Manual BlueSpice 3 With Installer}} __TOC__ This document describes the steps for the installation of MediaWiki 1.27.4 and BlueSpice 2.27.3 with installer. [[File:Hint.jpg|left]] '''Please note that this installation guide does only work with the edition BlueSpice free!''' ==Tip for this Document== * Please, read this manual completely and work through the single installtion steps one after another. * For editing the configuration files with a text editor, the files must be saved in UTF-8 coding without BOM (Byte Order Mark). * The placeholder <code><installpath-bluespice></code> stands for the path to your BlueSpice installation, e.g <code>C:\inetpub\wwwroot\bluespice</code> (Windows) or <code>/var/www/bluespice</code> (Linux). * The placeholder <code><bluespice-url></code> stands for the URL to your future BlueSpice installation, e.g. http://localhost/bluespiceWith 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 [[Setup:Installation Manual/Advanced|compendium]]. ==Requirements== ===Web server=== The system must already be running a Web server (IIS / Apache) that is configured to access <code><bluespice-url></code>. ===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 [https://sourceforge.net/projects/bluespice/files/ 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 <code><installpath-bluespice></code> and integrate it into existing folders. ==Renaming of Relevant Folders== Rename the following folders in <code><installpath-bluespice></code> as follows: * extensions/BlueSpiceFoundation/data.template<br />--> extensions/BlueSpiceFoundation/data * extensions/BlueSpiceFoundation/config.template<br />--> extensions/BlueSpiceFoundation/config ==Adjusting File System Permissions== Make sure that the following folders in <code><installpath-bluespice></code> 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 [[Setup:Installation Manual/Security Settings/File System Permissions|security settings]]. ==Starting the installation== Open <code><bluespice-url></code> in your browser. You should get the start page for installation:<br /><br /> [[File:Setup:Setup_mediawiki_start_installation.jpg|center|250x188px|border]] 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<br /><br /> [[File:Setup:Setup_installer_languageselect.jpg|center|400x313px|border]] Select the required language and click "Next".<br /><br /> [[File:Hint.jpg|left]] '''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).<br /><br /> [[File:Setup:Setup_installer_database.jpg|center|400x313px|border]] 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".<br /><br /> [[File:Setup:Setup_installer_database2.jpg|center|400x313px|border]] 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".<br /><br /> [[File:Setup:Setup_installer_settings.jpg|center|400x313px|border]] ==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.<br /><br /> [[File:Hint.jpg|left]] '''At this point, no MediaWiki standard extensions will be chosen. The neccessary extensions for BlueSpice will be integrated during the BlueSpice setup. '''<br style="clear: left;" /><br /> [[File:Setup:Setup_installer_advanced.jpg|center|400x598px|border]] 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 <code><installpath-bluespice></code>. ==Checking the Installation Requirements== Call up the file installcheck.php at <code><bluespice-url></code> 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. <span lang="en" id="result_box" class="" lang="en"><span class="">Do not continue until you have been able to remove at least all errors (red). </span></span><br /><br /> [[File:Setup:Setup_bluespice_installcheck.jpg|center|400x313px|border]] ==Check Installation== Call <code><bluespice-url></code> in your browser. BlueSpice should now be successfully installed and a login with your access data should be possible.<br /><br /> [[File:Setup:Setup_bluespice_finished.jpg|center|400x313px|border]] ==Further configuration== Your BlueSpice installation is now ready to use. You can also do some further configuraiton: * Setup of the [[Setup:Installation Manual/Webservices/Extended Search|extended search ]] * search]] *Setup of the [[Setup:Installation Manual/Webservices/PDF-Export|PDF export]] Also, some [[Setup:Installation Manual/Security Settings|security settings]] are recommended. [[en:{{FULLPAGENAME}}]] [[de:Setup:Installationsanleitung/Mit_Installer]]
Line 2: | Line 2: | ||
__TOC__ | __TOC__ | ||
+ | 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 [[Setup:Installation Manual/Advanced|compendium]]. | |
− | |||
− | |||
− | |||
− | |||
− | |||
==Requirements== | ==Requirements== | ||
Line 25: | Line 20: | ||
PHP must be embedded in the web server. Ensure that the following modules are enabled: | PHP must be embedded in the web server. Ensure that the following modules are enabled: | ||
− | * php-curl | + | *php-curl |
− | * php-gd | + | *php-gd |
− | * php-tidy | + | *php-tidy |
===MariaDB/MySQL=== | ===MariaDB/MySQL=== | ||
Line 41: | Line 36: | ||
Rename the following folders in <code><installpath-bluespice></code> as follows: | Rename the following folders in <code><installpath-bluespice></code> as follows: | ||
− | * extensions/BlueSpiceFoundation/data.template<br />--> extensions/BlueSpiceFoundation/data | + | *extensions/BlueSpiceFoundation/data.template<br />--> extensions/BlueSpiceFoundation/data |
− | * extensions/BlueSpiceFoundation/config.template<br />--> extensions/BlueSpiceFoundation/config | + | *extensions/BlueSpiceFoundation/config.template<br />--> extensions/BlueSpiceFoundation/config |
==Adjusting File System Permissions== | ==Adjusting File System Permissions== | ||
Make sure that the following folders in <code><installpath-bluespice></code> are accessible and writable by the webserver: | Make sure that the following folders in <code><installpath-bluespice></code> are accessible and writable by the webserver: | ||
− | * cache | + | *cache |
− | * images | + | *images |
− | * extensions/BlueSpiceFoundation/data | + | *extensions/BlueSpiceFoundation/data |
− | * extensions/BlueSpiceFoundation/config | + | *extensions/BlueSpiceFoundation/config |
Detailed information about the file system permissions can also be found in our installation manual at the [[Setup:Installation Manual/Security Settings/File System Permissions|security settings]]. | Detailed information about the file system permissions can also be found in our installation manual at the [[Setup:Installation Manual/Security Settings/File System Permissions|security settings]]. | ||
Line 69: | Line 64: | ||
[[File:Hint.jpg|left]] '''If you want to run your Wiki in German, please note that you have the choice between informal ("de") and formal ("de-formal") mode.''' | [[File:Hint.jpg|left]] '''If you want to run your Wiki in German, please note that you have the choice between informal ("de") and formal ("de-formal") mode.''' | ||
− | |||
Line 78: | Line 72: | ||
On the following page, you will be prompted to enter your 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". | + | *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 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. | + | *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).<br /><br /> | + | *Please enter the user name and password of the administrative database user (usually root).<br /><br /> |
[[File:Setup:Setup_installer_database.jpg|center|400x313px|border]] | [[File:Setup:Setup_installer_database.jpg|center|400x313px|border]] | ||
Line 104: | Line 98: | ||
[[File:Hint.jpg|left]] '''At this point, no MediaWiki standard extensions will be chosen. The neccessary extensions for BlueSpice will be integrated during the BlueSpice setup. '''<br style="clear: left;" /><br /> | [[File:Hint.jpg|left]] '''At this point, no MediaWiki standard extensions will be chosen. The neccessary extensions for BlueSpice will be integrated during the BlueSpice setup. '''<br style="clear: left;" /><br /> | ||
− | |||
Line 119: | Line 112: | ||
==Checking the Installation Requirements== | ==Checking the Installation Requirements== | ||
Call up the file installcheck.php at <code><bluespice-url></code> in your browser (example: http://localhost/installcheck.php). | Call up the file installcheck.php at <code><bluespice-url></code> 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. <span id="result_box" class=" | + | 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. <span lang="en" id="result_box" class=""><span class="">Do not continue until you have been able to remove at least all errors (red). </span></span><br /><br /> |
[[File:Setup:Setup_bluespice_installcheck.jpg|center|400x313px|border]] | [[File:Setup:Setup_bluespice_installcheck.jpg|center|400x313px|border]] | ||
Line 131: | Line 124: | ||
Your BlueSpice installation is now ready to use. You can also do some further configuraiton: | Your BlueSpice installation is now ready to use. You can also do some further configuraiton: | ||
− | * Setup of the [[Setup:Installation Manual/Webservices/Extended Search|extended | + | *Setup of the [[Setup:Installation Manual/Webservices/Extended Search|extended search]] |
− | * Setup of the [[Setup:Installation Manual/Webservices/PDF-Export|PDF export]] | + | *Setup of the [[Setup:Installation Manual/Webservices/PDF-Export|PDF export]] |
Also, some [[Setup:Installation Manual/Security Settings|security settings]] are recommended. | Also, some [[Setup:Installation Manual/Security Settings|security settings]] are recommended. | ||
− | [[en:{{FULLPAGENAME}}]][[de:Setup:Installationsanleitung/Mit_Installer]] | + | [[en:{{FULLPAGENAME}}]] |
+ | [[de:Setup:Installationsanleitung/Mit_Installer]] |