BlueSpice Helpdesk - User contributions [en]

Setup:Installation Guide/With Installer

2023-01-26T09:10:04Z

Ptechnik:

== Download installation package ==
{{DISPLAYTITLE:Installation BlueSpice 4 with Installer}}

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

Make sure that [[Setup:Installation_Guide/Security_Settings/File_System_Permissions|file system permissions]] are set up properly.|bgcolor=}}
==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.

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

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

Further help on optimizing the operating system can be found in our [[Setup:Installation Guide/Advanced|compendium]].
==Step-by-step installation==

{{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=}}{{Messagebox|boxtype=note|icon=no|Note text=If Error "Fatal exception of type MWException" shows up, you need to check the rights of your Bluespice Folder and give it reading- and writing permissions. If there is still a error you need to add "$wgShowExceptionDetails = true" to your localsettings.php file and reload your URL to get preciser information of your error.|bgcolor=}}

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=""
|-
|[[File:Setup:1.png|alt=MediaWiki setup page php error|300x300px]]
||'''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).

|-
|[[File:Setup:2.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,

"Wiki language" the later language settings of your wiki.
|-
|[[File:Setup:3.png|alt=Installation check|300x300px]]
||'''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.
|-
|[[File:Setup:4.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.
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]].
|-
|[[File:Setup:5.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".
|-
|[[File:Setup:6.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. 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.
|-
|[[File:Setup:7.png|alt=Email options|center|300x300px]]
||'''Step 7: Options'''
In this step, you specify the e-mail address for notification e-mails.
|-
|[[File:Setup:8.png|alt=|thumb]]
||'''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.
|-
|[[File:Setup:9.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".
|-
|[[File:Setup:10.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><installpath-bluespice>\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 <code>php <installpath-bluespice>\maintenance\update.php</code> from the console.
|-
|[[File:Setup:11.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.
|}

==BlueSpice WikiFarm==
If you are installing '''BlueSpice WikiFarm,''' follow these [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|instructions.]] If not, skip to [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|Next steps.]]

Now open a command line and change to the folder <code><installpath-bluespice></code>.

Run the following command:

*<code>php maintenance/update.php</code> ''(Linux)''
*<code>php maintenance\update.php</code> ''(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.}}
For security reasons, it is recommended to prevent access to the path <code>mw-config/</code> after the installation. This can be implemented as follows:

 
=Linux=
In Apache, add the following entry to the file <code>000-bluespice.conf</code>:
<pre>
<Directory /var/www/bluespice/w/mw-config>
Require all denied
</Directory>
</pre>

 
=Windows=
In IIS, create a file <code>web.config</code> in the sub-directory <code>mw-config/</code> with the following content:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<system.webServer>
<security>
<authentication>
<anonymousAuthentication enabled="false" />
</authentication>
</security>
</system.webServer>
</configuration>
</pre>
<headertabs /><notabtoc/>
Please note that this entry may have to be removed temporarily if the web installer is used to update the application.

{{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}}]]
[[de:Setup:Installationsanleitung/Installation von BlueSpice]]

File:Setup:11.png

2023-01-26T09:09:59Z

Ptechnik:

File:Setup:10.png

2023-01-26T09:09:45Z

Ptechnik:

File:Setup:9.png

2023-01-26T09:09:32Z

Ptechnik:

File:Setup:8.png

2023-01-26T09:09:16Z

Ptechnik:

File:Setup:7.png

2023-01-26T09:08:59Z

Ptechnik:

File:Setup:6.png

2023-01-26T09:08:43Z

Ptechnik:

File:Setup:5.png

2023-01-26T09:07:58Z

Ptechnik:

File:Setup:4.png

2023-01-26T09:07:13Z

Ptechnik:

File:Setup:3.png

2023-01-26T09:06:19Z

Ptechnik:

File:Setup:2.png

2023-01-26T09:06:03Z

Ptechnik:

File:Setup:1.png

2023-01-26T09:05:42Z

Ptechnik:

Setup:Installation Guide/System Preparation/Linux/Jetty

2023-01-24T14:24:36Z

Ptechnik:

{{DISPLAYTITLE:Jetty on Linux}}
__TOC__
{{Messagebox|boxtype=note|Note text=Jetty is a prerequisite for using PDF export and VisualDiff (BlueSpice pro only). The steps listed here are optional and only required if you plan to use one or more of these services in your BlueSpice installation.}}
==Introduction==
An alternative to Jetty is Apache Tomcat, which you can also find in the package manager of Debian. However, since Jetty works better, this is preferred in this documentation.
==Installing Jetty==
Install Jetty via Aptitude:
<pre>apt update; \
apt install jetty9; \
apt clean</pre>

==Configuration==
{{Messagebox|boxtype=note|Note text=If you do not have the rights to save, run "sudo nano /etc/default/jetty9" in the terminal. And put the following line at the very end of the file.}}
To configure, open the file <code>/etc/default/jetty9</code> in a text editor of your choice (vi, nano). Put the following line at the very end of the file:

<pre>JAVA_OPTIONS="-Xms512m -Xmx1024m -Djetty.host=127.0.0.1"</pre>

Restart Jetty with the command <code>service jetty9 restart</code>.

==Installing the web apps==
In your browser, open the official download page on [https://bluespice.com/download/ bluespice.com] (1). Click on "Download" (2).

# Unzip the BlueSpice-free-4.x.x.zip file.
# Rename the folder "BlueSpice-free-4.x.x" to <code>bluespice</code>.
# Rename the "bluespice" subfolder to <code>w</code>.
# Now move the unzipped bluespice folder in the terminal with the command <code>sudo mv /yourfilepath/bluespice /var/www</code> .

After successful installation of BlueSpice, follow the next steps to install the web services and activate the respective BlueSpice extension:

*[[Setup:Installation Guide/Webservices/PDF-Export | PDF Export]]

==Next step==
If you have successfully completed all steps, you can proceed to the next step"[[Setup:Installation Guide/System Preparation/Linux/Elasticsearch | Elasticsearch]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Linux/Jetty]]

Setup:Installation Guide/System Preparation/Linux/Apache and PHP

2023-01-24T13:56:42Z

Ptechnik:

{{DISPLAYTITLE:Installing Apache and PHP on Linux}}
__TOC__
{{Messagebox|boxtype=important|Note text=The web server delivers your BlueSpice installation to the user's browser. Without a web server, BlueSpice cannot be used. The source code of BlueSpice is based on the scripting language "PHP". This must also be installed on your server in order to operate BlueSpice. The steps listed here are required.}}
==Introduction==
Apache or Nginx are available as web servers under Linux. BlueSpice can theoretically also be operated with Nginx, but in this documentation only Apache is treated in detail. Of course, you can also install Nginx with the appropriate expertise and operate it according to the here documented Virtualhost configuration of Apache.
{{Messagebox|boxtype=note|Note text=If "User is not in the sudoers file." type "su" in the terminal and execute. Write a "sudo" in front of a command.}}
==Installation==
Install Apache and PHP using the Aptitude package manager with the following steps:
<pre>
apt update; \
apt install apache2 \
libapache2-mod-php7.4 \
php7.4 \
php7.4-cli \
php7.4-common \
php7.4-curl \
php7.4-gd \
php7.4-intl \
php7.4-json \
php7.4-mbstring \
php7.4-mysql \
php7.4-opcache \
php7.4-tidy \
php7.4-xml \
php7.4-zip; \
apt clean
</pre>Depending on requirements, further PHP extensions may be necessary, e.g. for an LDAP connection.

==Configuring PHP==
After the installation has been completed, first configure PHP. First change to the directory <code>/etc/php/7.4/apache2</code> through the terminal and then execute the <code>php.ini</code> file with the command <code>nano php.ini.</code>

Find the following settings and change the values accordingly. If a setting is commented out with a semicolon in front of it, please remove it.

<pre>
date.timezone = Europe/Berlin
max_execution_time = 600
post_max_size = 128M
upload_max_filesize = 128M
</pre>

Set the value for 'date.timezone' according to your own time zone.

Save and exit the php.ini again.
==Configuring Apache==
{{Messagebox|boxtype=note|Note text=In this documentation, we assume the recommended installation with [https://www.mediawiki.org/wiki/Manual:Short_URL ShortURL]. In this case, the root directory of the web server is in <code>/var/www/bluespice</code>, but the actual source code of BlueSpice is in <code>/var/www/bluespice/w</code>. This configuration is designed accordingly.}}

To configure a VirtualHost for BlueSpice, please proceed as follows:

#Change to the directory <code>/etc/apache2/sites-available </code>.
#In a text editor of your choice, open the file <code>bluespice.conf</code>, which does not yet exist, and create it. Copy the entire contents of the following file into this new configuration file:
##For BlueSpice free: [[Media:Setup:apache vhost bluespice free.txt|apache_vhost_bluespice_free.txt]]
##For BlueSpice pro: [[Media:Setup:apache vhost bluespice pro.txt|apache_vhost_bluespice_pro.txt]]
#In rows 3 and 4, replace "SERVERNAME" and "SERVERALIAS" according to your server name and domain. If the server is explicitly operated with only one VirtualHost for BlueSpice, you can also completely remove these two lines.
#Save the file and close it.

Delete the VirtualHost created by default during the Apache installation with the command <code>a2dissite 000-default</code>. Then activate the just created VirtualHost with the command <code>a2ensite bluespice</code>.

Next, activate the Module Rewrite, which we configured in the <code>bluespice.conf</code>, by entering the following command: <code>a2enmod rewrite</code>

Next, create the directory <code>/var/www/bluespice</code>(<code>mkdir/var/www/bluespice</code>) and restart Apache with the command <code>service apache2 restart</code>.

Next, call up the URL of your BlueSpice server (localhost). If configured correctly, Apache should respond to the request with the error message "Not found", which is completely correct at the time of installation.

[[File:Setup:apache_not_found.png|frameless]]

==Next step==
If you have successfully completed all these steps, you can proceed to the next step "[[Setup: Installation Guide/System Preparation/Linux/MariaDB | MariaDB]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Linux/Apache_und_PHP]]

Setup:Installation Guide/With Installer

2023-01-24T13:39:56Z

Ptechnik:

== Download installation package ==
{{DISPLAYTITLE:Installation BlueSpice 4 with Installer}}

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

Make sure that [[Setup:Installation_Guide/Security_Settings/File_System_Permissions|file system permissions]] are set up properly.|bgcolor=}}
==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.

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

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

Further help on optimizing the operating system can be found in our [[Setup:Installation Guide/Advanced|compendium]].
==Step-by-step installation==

{{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=}}{{Messagebox|boxtype=note|icon=no|Note text=If Error "Fatal exception of type MWException" shows up, you need to check the rights of your Bluespice Folder and give it reading- and writing permissions. If there is still a error you need to add "$wgShowExceptionDetails = true" to your localsettings.php file and reload your URL to get preciser information of your error.|bgcolor=}}

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=""
|-
|[[File:Setup:Mediawiki 2233.png|alt=MediaWiki setup page php error|300x300px]]
||'''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).

|-
|[[File:Setup:Sprache.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,

"Wiki language" the later language settings of your wiki.
|-
|[[File:Setup:Willkommen.png|alt=Installation check|300x300px]]
||'''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.
|-
|[[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.
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]].
|-
|[[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".
|-
|[[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. 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.
|-
|[[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.
|-
|[[File:With Installer 1674549002230.png|thumb]]
||'''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.
|-
|[[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".
|-
|[[File:Setup:Fertig.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><installpath-bluespice>\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 <code>php <installpath-bluespice>\maintenance\update.php</code> from the console.
|-
|[[File:Setup:Testwiki.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.
|}

==BlueSpice WikiFarm==
If you are installing '''BlueSpice WikiFarm,''' follow these [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|instructions.]] If not, skip to [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|Next steps.]]

Now open a command line and change to the folder <code><installpath-bluespice></code>.

Run the following command:

*<code>php maintenance/update.php</code> ''(Linux)''
*<code>php maintenance\update.php</code> ''(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.}}
For security reasons, it is recommended to prevent access to the path <code>mw-config/</code> after the installation. This can be implemented as follows:

 
=Linux=
In Apache, add the following entry to the file <code>000-bluespice.conf</code>:
<pre>
<Directory /var/www/bluespice/w/mw-config>
Require all denied
</Directory>
</pre>

 
=Windows=
In IIS, create a file <code>web.config</code> in the sub-directory <code>mw-config/</code> with the following content:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<system.webServer>
<security>
<authentication>
<anonymousAuthentication enabled="false" />
</authentication>
</security>
</system.webServer>
</configuration>
</pre>
<headertabs /><notabtoc/>
Please note that this entry may have to be removed temporarily if the web installer is used to update the application.

{{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}}]]
[[de:Setup:Installationsanleitung/Installation von BlueSpice]]

File:Setup:Testwiki.png

2023-01-24T13:39:50Z

Ptechnik:

File:Setup:Fertig.png

2023-01-24T13:39:32Z

Ptechnik:

File:Setup:Willkommen.png

2023-01-24T13:38:58Z

Ptechnik:

File:Setup:Sprache.png

2023-01-24T13:38:42Z

Ptechnik:

Setup:Installation Guide/With Installer

2023-01-24T13:25:13Z

Ptechnik:

== Download installation package ==
{{DISPLAYTITLE:Installation BlueSpice 4 with Installer}}

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

Make sure that [[Setup:Installation_Guide/Security_Settings/File_System_Permissions|file system permissions]] are set up properly.|bgcolor=}}
==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.

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

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

Further help on optimizing the operating system can be found in our [[Setup:Installation Guide/Advanced|compendium]].
==Step-by-step installation==

{{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=}}{{Messagebox|boxtype=note|icon=no|Note text=If Error "Fatal exception of type MWException" shows up, you need to check the rights of your Bluespice Folder and give it reading- and writing permissions. If there is still a error you need to add "$wgShowExceptionDetails = true" to your localsettings.php file and reload your URL to get preciser information of your error.|bgcolor=}}

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=""
|-
|[[File:Setup:Mediawiki 2233.png|alt=MediaWiki setup page php error|300x300px]]
||'''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).

|-
|[[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,

"Wiki language" the later language settings of your wiki.
|-
|[[File:Setup:Screenshot (215)3.png|alt=Installation check|300x300px]]
||'''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.
|-
|[[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.
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]].
|-
|[[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".
|-
|[[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. 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.
|-
|[[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.
|-
|[[File:With Installer 1674549002230.png|thumb]]
||'''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.
|-
|[[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".
|-
|[[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><installpath-bluespice>\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 <code>php <installpath-bluespice>\maintenance\update.php</code> from the console.
|-
|[[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.
|}

==BlueSpice WikiFarm==
If you are installing '''BlueSpice WikiFarm,''' follow these [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|instructions.]] If not, skip to [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|Next steps.]]

Now open a command line and change to the folder <code><installpath-bluespice></code>.

Run the following command:

*<code>php maintenance/update.php</code> ''(Linux)''
*<code>php maintenance\update.php</code> ''(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.}}
For security reasons, it is recommended to prevent access to the path <code>mw-config/</code> after the installation. This can be implemented as follows:

 
=Linux=
In Apache, add the following entry to the file <code>000-bluespice.conf</code>:
<pre>
<Directory /var/www/bluespice/w/mw-config>
Require all denied
</Directory>
</pre>

 
=Windows=
In IIS, create a file <code>web.config</code> in the sub-directory <code>mw-config/</code> with the following content:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<system.webServer>
<security>
<authentication>
<anonymousAuthentication enabled="false" />
</authentication>
</security>
</system.webServer>
</configuration>
</pre>
<headertabs /><notabtoc/>
Please note that this entry may have to be removed temporarily if the web installer is used to update the application.

{{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}}]]
[[de:Setup:Installationsanleitung/Installation von BlueSpice]]

File:Setup:Mediawiki 2233.png

2023-01-24T13:25:09Z

Ptechnik:

Setup:Installation Guide/System Preparation/Linux/Memcached

2023-01-24T09:29:26Z

Ptechnik:

{{DISPLAYTITLE:Memcached on Linux}}
__TOC__
{{Messagebox|boxtype=note|icon=|Note text=Memcached is a cache server to improve the performance of your BlueSpice installation. It is not required for the actual operation of BlueSpice. The steps listed here are therefore optional.|bgcolor=}}
==Installation==
Install Memcached with Aptitude:

<pre>apt-get update; \
apt-get -y install memcached; \
apt-get clean</pre>

==Configuration==
Open the file containing the memcached configuration (for example, /etc/memcached.conf on Debian / Ubuntu). Find the '' '-m' '' argument there and increase the available memory according to your server's capabilities:

<pre>-m 512</pre>
Save and close the file and restart memcached with <code>service memcached restart</code>.

==Next step==
If you have completed all steps successfully and want to install BlueSpice pro, proceed to the next step " [[Setup:Installation Guide/Advanced/Mathoid|Mathoid]]". If you want to install BlueSpice free, you can now continue with [[Setup:Installation Guide/With Installer|Installing BlueSpice]].

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Linux/Memcached]]

Setup:Installation Guide/Webservices/Mathoid

2023-01-24T08:58:26Z

Ptechnik:

Mathoid is a nodjs service which takes various forms of math input and converts it to MathML + SVG or PNG output.

{{Messagebox|boxtype=important|icon=|Note text=Beginning with BlueSpice 4.x, Mathoid is no longer distributed and has to installed separately.
 
Download:

https://bluespice.com/filebase/mathoid/|bgcolor=}}

If mathematical formulas are not rendered in your wiki, please check that <code>extensions/Math/webservices/mathoid.tar.gz</code> is deployed in the correct folder:
*Linux: <code>/opt/mathoid</code>
*Windows: <code>C:\BlueSpice\bin\mathoid</code>

== Next step ==
If you have completed all steps successfully and want to install BlueSpice pro, proceed to the next step [[Setup:Installation Guide/System Preparation/Linux/PhantomJS|PhantomJS]]

Setup:Installation Guide/System Preparation/Linux/MariaDB

2023-01-24T08:56:52Z

Ptechnik:

{{DISPLAYTITLE:MariaDB on Linux}}
__TOC__
{{Messagebox|boxtype=important|Note text=BlueSpice stores your content in a database for which you need to install a corresponding server. The steps listed here are required.}}
==Installing MariaDB==
Install MariaDB via Aptitude:

<pre>apt update; \
apt install mariadb-server mariadb-client; \
apt clean</pre>
==Create database user for BlueSpice==
After installation, immediately create a database user for MariaDB directly with the following command: 

<pre>mysql -e "GRANT ALL ON bluespice.* TO 'bluespice'@'127.0.0.1' IDENTIFIED BY '<a password of your choice>';"</pre>{{Messagebox|boxtype=important|icon=no|Note text=Remember the username and password for later parts of the Installation.|bgcolor=}}

==Next Step==
If you have completed all steps successfully, you can proceed to the next step "[[Setup:Installation Guide/System Preparation/Linux/Jetty | Jetty]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Linux/MariaDB]]

Setup:Installation Guide/System Preparation/Linux/Apache and PHP

2023-01-24T08:55:12Z

Ptechnik:

{{DISPLAYTITLE:Installing Apache and PHP on Linux}}
__TOC__
{{Messagebox|boxtype=important|Note text=The web server delivers your BlueSpice installation to the user's browser. Without a web server, BlueSpice cannot be used. The source code of BlueSpice is based on the scripting language "PHP". This must also be installed on your server in order to operate BlueSpice. The steps listed here are required.}}
==Introduction==
Apache or Nginx are available as web servers under Linux. BlueSpice can theoretically also be operated with Nginx, but in this documentation only Apache is treated in detail. Of course, you can also install Nginx with the appropriate expertise and operate it according to the here documented Virtualhost configuration of Apache.
{{Messagebox|boxtype=note|Note text=If "User is not in the sudoers file." type "su" in the terminal and execute. Write a "sudo" in front of a command.}}
==Installation==
Install Apache and PHP using the Aptitude package manager with the following steps:
<pre>
apt update; \
apt install apache2 \
libapache2-mod-php7.4 \
php7.4 \
php7.4-cli \
php7.4-common \
php7.4-curl \
php7.4-gd \
php7.4-intl \
php7.4-json \
php7.4-mbstring \
php7.4-mysql \
php7.4-opcache \
php7.4-tidy \
php7.4-xml \
php7.4-zip; \
apt clean
</pre>Depending on requirements, further PHP extensions may be necessary, e.g. for an LDAP connection.

==Configuring PHP==
After installation, configure PHP. Open <code>php.ini</code> with a text editor of your choice (nano, vi), which, in our Debian version, is located in the directory <code>/etc/php/7.3/apache2</code>.

Find the following settings and change the values accordingly. If a setting is commented out with a semicolon in front of it, please remove it. Or open the terminal with <code>sudo nano /etc/php/7.4/apache2/php.ini</code>.

<pre>
date.timezone = Europe/Berlin
max_execution_time = 600
post_max_size = 128M
upload_max_filesize = 128M
</pre>

Set the value for 'date.timezone' according to your own time zone.

Save and exit the php.ini again.
==Configuring Apache==
{{Messagebox|boxtype=note|Note text=In this documentation, we assume the recommended installation with [https://www.mediawiki.org/wiki/Manual:Short_URL ShortURL]. In this case, the root directory of the web server is in <code>/var/www/bluespice</code>, but the actual source code of BlueSpice is in <code>/var/www/bluespice/w</code>. This configuration is designed accordingly.}}

To configure a VirtualHost for BlueSpice, please proceed as follows:

#Change to the directory <code>/etc/apache2/sites-available </code>.
#In a text editor of your choice, open the file <code>bluespice.conf</code>, which does not yet exist, and create it. Copy the entire contents of the following file into this new configuration file:
##For BlueSpice free: [[Media:Setup:apache vhost bluespice free.txt|apache_vhost_bluespice_free.txt]]
##For BlueSpice pro: [[Media:Setup:apache vhost bluespice pro.txt|apache_vhost_bluespice_pro.txt]]
#In rows 3 and 4, replace "SERVERNAME" and "SERVERALIAS" according to your server name and domain. If the server is explicitly operated with only one VirtualHost for BlueSpice, you can also completely remove these two lines.
#Save the file and close it.

Delete the VirtualHost created by default during the Apache installation with the command <code>a2dissite 000-default</code>. Then activate the just created VirtualHost with the command <code>a2ensite bluespice</code>.

Next, activate the Module Rewrite, which we configured in the <code>bluespice.conf</code>, by entering the following command: <code>a2enmod rewrite</code>

Next, create the directory <code>/var/www/bluespice</code>(<code>mkdir/var/www/bluespice</code>) and restart Apache with the command <code>service apache2 restart</code>.

Next, call up the URL of your BlueSpice server (localhost). If configured correctly, Apache should respond to the request with the error message "Not found", which is completely correct at the time of installation.

[[File:Setup:apache_not_found.png|frameless]]

==Next step==
If you have successfully completed all these steps, you can proceed to the next step "[[Setup: Installation Guide/System Preparation/Linux/MariaDB | MariaDB]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Linux/Apache_und_PHP]]

Setup:Installation Guide/With Installer

2023-01-24T08:54:00Z

Ptechnik:

== Download installation package ==
{{DISPLAYTITLE:Installation BlueSpice 4 with Installer}}

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

Make sure that [[Setup:Installation_Guide/Security_Settings/File_System_Permissions|file system permissions]] are set up properly.|bgcolor=}}
==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.

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

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

Further help on optimizing the operating system can be found in our [[Setup:Installation Guide/Advanced|compendium]].
==Step-by-step installation==

{{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=}}{{Messagebox|boxtype=note|icon=no|Note text=If Error "Fatal exception of type MWException" shows up, you need to check the rights of your Bluespice Folder and give it reading- and writing permissions. If there is still a error you need to add "$wgShowExceptionDetails = true" to your localsettings.php file and reload your URL to get preciser information of your error.|bgcolor=}}

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=""
|-
|[[File:Setup:mediawiki-setup-page.png|alt=MediaWiki setup page php error|300x300px]]
||'''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).

|-
|[[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,

"Wiki language" the later language settings of your wiki.
|-
|[[File:Setup:Screenshot (215)3.png|alt=Installation check|300x300px]]
||'''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.
|-
|[[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.
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]].
|-
|[[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".
|-
|[[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. 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.
|-
|[[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.
|-
|[[File:With Installer 1674549002230.png|thumb]]
||'''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.
|-
|[[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".
|-
|[[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><installpath-bluespice>\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 <code>php <installpath-bluespice>\maintenance\update.php</code> from the console.
|-
|[[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.
|}

==BlueSpice WikiFarm==
If you are installing '''BlueSpice WikiFarm,''' follow these [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|instructions.]] If not, skip to [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|Next steps.]]

Now open a command line and change to the folder <code><installpath-bluespice></code>.

Run the following command:

*<code>php maintenance/update.php</code> ''(Linux)''
*<code>php maintenance\update.php</code> ''(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.}}
For security reasons, it is recommended to prevent access to the path <code>mw-config/</code> after the installation. This can be implemented as follows:

 
=Linux=
In Apache, add the following entry to the file <code>000-bluespice.conf</code>:
<pre>
<Directory /var/www/bluespice/w/mw-config>
Require all denied
</Directory>
</pre>

 
=Windows=
In IIS, create a file <code>web.config</code> in the sub-directory <code>mw-config/</code> with the following content:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<system.webServer>
<security>
<authentication>
<anonymousAuthentication enabled="false" />
</authentication>
</security>
</system.webServer>
</configuration>
</pre>
<headertabs /><notabtoc/>
Please note that this entry may have to be removed temporarily if the web installer is used to update the application.

{{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}}]]
[[de:Setup:Installationsanleitung/Installation von BlueSpice]]

Setup:Installation Guide/Webservices/Mathoid

2023-01-24T08:46:35Z

Ptechnik:

Mathoid is a nodjs service which takes various forms of math input and converts it to MathML + SVG or PNG output.

{{Messagebox|boxtype=important|icon=|Note text=Beginning with BlueSpice 4.x, Mathoid is no longer distributed and has to installed separately.
 
Download:

https://bluespice.com/filebase/mathoid/|bgcolor=}}

If mathematical formulas are not rendered in your wiki, please check that <code>extensions/Math/webservices/mathoid.tar.gz</code> is deployed in the correct folder:
*Linux: <code>/opt/mathoid</code>
*Windows: <code>C:\BlueSpice\bin\mathoid</code>

== Next step ==
Continue with [[Setup:Installation Guide/System Preparation/Linux/PhantomJS|PhantomJS]]

Setup:Installation Guide/Webservices/Mathoid

2023-01-24T08:45:17Z

Ptechnik:

Setup:Installation Guide/System Preparation/Linux/MariaDB

2023-01-24T08:44:00Z

Ptechnik:

{{DISPLAYTITLE:MariaDB on Linux}}
__TOC__
{{Messagebox|boxtype=important|Note text=BlueSpice stores your content in a database for which you need to install a corresponding server. The steps listed here are required.}}
==Installing MariaDB==
Install MariaDB via Aptitude:

<pre>apt update; \
apt install mariadb-server mariadb-client; \
apt clean</pre>
==Create database user for BlueSpice==
After installation, immediately create a database user for MariaDB directly with the following command: 

<pre>mysql -e "GRANT ALL ON bluespice.* TO 'bluespice'@'127.0.0.1' IDENTIFIED BY '<a password of your choice>';"</pre>{{Messagebox|boxtype=important|icon=yes|Note text=Remember the username and password for later parts of the Installation.|bgcolor=}}

==Next Step==
If you have completed all steps successfully, you can proceed to the next step "[[Setup:Installation Guide/System Preparation/Linux/Jetty | Jetty]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Linux/MariaDB]]

Setup:Installation Guide/System Preparation/Linux/MariaDB

2023-01-24T08:43:30Z

Ptechnik:

{{DISPLAYTITLE:MariaDB on Linux}}
__TOC__
{{Messagebox|boxtype=important|Note text=BlueSpice stores your content in a database for which you need to install a corresponding server. The steps listed here are required.}}
==Installing MariaDB==
Install MariaDB via Aptitude:

<pre>apt update; \
apt install mariadb-server mariadb-client; \
apt clean</pre>
==Create database user for BlueSpice==
After installation, immediately create a database user for MariaDB directly with the following command: 

<pre>mysql -e "GRANT ALL ON bluespice.* TO 'bluespice'@'127.0.0.1' IDENTIFIED BY '<a password of your choice>';"</pre>{{Messagebox|boxtype=important|icon=yes|Note text=It`s important to remember the username and password for later parts of the Installation.|bgcolor=}}

==Next Step==
If you have completed all steps successfully, you can proceed to the next step "[[Setup:Installation Guide/System Preparation/Linux/Jetty | Jetty]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Linux/MariaDB]]

Setup:Installation Guide/System Preparation/Linux/MariaDB

2023-01-24T08:42:33Z

Ptechnik:

{{DISPLAYTITLE:MariaDB on Linux}}
__TOC__
{{Messagebox|boxtype=important|Note text=BlueSpice stores your content in a database for which you need to install a corresponding server. The steps listed here are required.}}
==Installing MariaDB==
Install MariaDB via Aptitude:

<pre>apt update; \
apt install mariadb-server mariadb-client; \
apt clean</pre>
==Create database user for BlueSpice==
After installation, immediately create a database user for MariaDB directly with the following command: 

<pre>mysql -e "GRANT ALL ON bluespice.* TO 'bluespice'@'127.0.0.1' IDENTIFIED BY '<a password of your choice>';"</pre>{{Messagebox|boxtype=Important|icon=yes|Note text=It`s important to remember the username and password for later parts of the Installation.|bgcolor=yellow}}

==Next Step==
If you have completed all steps successfully, you can proceed to the next step "[[Setup:Installation Guide/System Preparation/Linux/Jetty | Jetty]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Linux/MariaDB]]

Setup:Installation Guide/With Installer

2023-01-24T08:30:14Z

Ptechnik:

== Download installation package ==
{{DISPLAYTITLE:Installation BlueSpice 4 with Installer}}

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

Make sure that [[Setup:Installation_Guide/Security_Settings/File_System_Permissions|file system permissions]] are set up properly.|bgcolor=}}
==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.

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

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

Further help on optimizing the operating system can be found in our [[Setup:Installation Guide/Advanced|compendium]].
==Step-by-step installation==

{{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=}}

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=""
|-
|[[File:Setup:mediawiki-setup-page.png|alt=MediaWiki setup page php error|300x300px]]
||'''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).

|-
|[[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,

"Wiki language" the later language settings of your wiki.
|-
|[[File:Setup:Screenshot (215)3.png|alt=Installation check|300x300px]]
||'''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.
|-
|[[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.
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]].
|-
|[[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".
|-
|[[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. 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.
|-
|[[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.
|-
|[[File:With Installer 1674549002230.png|thumb]]
||'''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.
|-
|[[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".
|-
|[[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><installpath-bluespice>\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 <code>php <installpath-bluespice>\maintenance\update.php</code> from the console.
|-
|[[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.
|}

==BlueSpice WikiFarm==
If you are installing '''BlueSpice WikiFarm,''' follow these [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|instructions.]] If not, skip to [[:en:Setup:Installation_Guide/Installation_BlueSpice_WikiFarm|Next steps.]]

Now open a command line and change to the folder <code><installpath-bluespice></code>.

Run the following command:

*<code>php maintenance/update.php</code> ''(Linux)''
*<code>php maintenance\update.php</code> ''(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.}}
For security reasons, it is recommended to prevent access to the path <code>mw-config/</code> after the installation. This can be implemented as follows:

 
=Linux=
In Apache, add the following entry to the file <code>000-bluespice.conf</code>:
<pre>
<Directory /var/www/bluespice/w/mw-config>
Require all denied
</Directory>
</pre>

 
=Windows=
In IIS, create a file <code>web.config</code> in the sub-directory <code>mw-config/</code> with the following content:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<system.webServer>
<security>
<authentication>
<anonymousAuthentication enabled="false" />
</authentication>
</security>
</system.webServer>
</configuration>
</pre>
<headertabs /><notabtoc/>
Please note that this entry may have to be removed temporarily if the web installer is used to update the application.

{{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}}]]
[[de:Setup:Installationsanleitung/Installation von BlueSpice]]

File:With Installer 1674549002230.png

2023-01-24T08:30:04Z

Ptechnik:

File:Setup:bs4-install-08.png

2023-01-24T08:27:44Z

Ptechnik:

SocialEntity:168

2022-01-12T08:06:24Z

Ptechnik:

{
"wikipageid": 1086,
"namespace": 0,
"titletext": "Manual:Extension/BlueSpiceExtendedStatistics",
"description": "",
"parentid": 0,
"id": 168,
"ownerid": 9,
"type": "wikipage",
"archived": false,
"tags": [
"Manual:Extension/BlueSpiceExtendedStatistics"
],
"resolved": false
}

Manual:Extension/BlueSpiceExtendedStatistics

2022-01-12T08:06:23Z

Ptechnik:

{{DISPLAYTITLE:Extended statistics}}

The extension '''ExtendedStatistics''' provides an analytic view of many relevant parameters on the wiki, providing wiki administrators better insight into the functioning of the wiki.

==Where to find Extended statistics==

The navigation link ''Extended statistics'' in the tab Global actions loads the page ''Special:ExtendedStatistics''.

 
[[File:Manual:extendedstatistics.png|alt=|center|thumb|441x441px|Extended statistics navigation link]]

==Choosing a data source==

ExtendedStatistics can show data for multiple aspects of the wiki. Available data sources are:

*''Number of users:'' All the users that registered in the period chosen
*''Number of pages:'' All pages created in the period chosen.
*''Number of content pages:'' All articles in content namespaces created in the period chosen
*''Number of edits:'' All edits carried out in the period chosen
*''Edits per user:'' Number of edits per user in the period chosen
*''Search queries:'' All terms users searched for in the period chosen. Only availble if [[Manual:Extension/ExtendedSearch|BlueSpiceExtendedSearch]] is installed.

==Choosing filters==

General filters:

*From - Date from which to display data
*To - Date to which to display data

Some data sources may have additional filters available, like for data sources based on wiki pages, namespace filter is available.

 
[[File:Manual:Mediawiki Extension ExtendedStatistics.png|alt=Selecting a query type|center|thumb|300x300px|Selecting a query type]]
 

==Display settings==

The display of the results is determined by the following settings:

*Interval - grain of the diagram - determines which time unit will be used to group the data.
*Mode - display type:
**Absolute - shows changes in data for the given period
**Aggregate - shows running total for the data source choosen
**List - shows data in tabular view - only avaiable for search statistics
{{Box Note|boxtype=note|Note text=Depending on the selected time period, the interval has to be set accordingly. For, example if you look for data between 02.06. and 03.06. for the same year, the interval setting "Year" will not return any data. Change the interval to "Week" or "Day" to return results.}}

==Viewing the results==

Once all the filters and options are set, click on the ''Results'' tab to show the resulting data.

 
[[File:Manual:ExtendedStatistics3.png|alt=|center|thumb|335x335px|Result view with export buttons]]
 

==Chart export==
In results view there is an ''Export-''button that allows the user to export and download the currently displayed chart as SVG.

==Data export==

===Maintenance script===
A <code>php</code> maintenance script will be provided on the following location:

<code><mw-root>/extensions/BlueSpiceExtendedStatistics/maintenance/ExportCollection.php</code>

===Usage===
This script must be called on the command line of the server. It takes the path of a configuration file in <code>JSON</code> format.

'''Example'''
php <mw-root>/extensions/BlueSpiceExtendedStatistics/maintenance/ExportCollection.php \
--config=<path-to-file>/myConfig.json \
--exportto=/tmp/myExport.xslx
'''Params'''

*<code>--config</code> - path to config file
*<code>--exportto</code> - path to the file, the data gets exportet to. Note that vaiable file formats are <code>xsl</code>, <code>xslx</code> and <code>csv</code>

===Scirpt configuration===
The script configuration will take the same parameters as the API, which is used on Special:ExtendedStatistics.

'''Params'''

*<code>aggregate</code>
*<code>filter</code>

===Example contents===
The following examples show the content of the JSON file provided to <code>--config</code>.

'''"Page views" aggregated by date over 1 year'''
{
"aggregate": [
{
"property": "timestampcreated",
"type": "daily",
"targets": [
"pagetitle",
"numberhits",
"numberhitsaggregated"
]
}
],
"filter": [
{
"property": "type",
"type": "string",
"value": "hitcounter",
"comparison": "eq"
},
{
"property": "timestampcreated",
"type": "date",
"value": "20200707120000",
"comparison": "gt"
},
{
"property": "timestampcreated",
"type": "date",
"value": "20210707120000",
"comparison": "lt"
}
]
}
'''"Review by namespaces" aggregated by namespace over 1 year''':
{
"aggregate": [
{
"property": "namespacename",
"type": "string",
"targets": [
"ongoingpages",
"expiredpages",
"notrunningpages",
"ongoingpagesaggregated",
"expiredpagesaggregated",
"notrunningpagesaggregated"
]
}
],
"filter": [
{
"property": "type",
"type": "string",
"value": "reviewedpages-ns",
"comparison": "eq"
},
{
"property": "timestampcreated",
"type": "date",
"value": "20200707120000",
"comparison": "gt"
},
{
"property": "timestampcreated",
"type": "date",
"value": "20210707120000",
"comparison": "lt"
}
]
}
 
==Configuration==

In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings:

{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedStatistics}}

{{Box Links-en|Topic1=[[Reference:BlueSpiceExtendedStatistics]]}}

[[de:Handbuch:Erweiterung/{{SUBPAGENAME}}]]
[[en:Manual:Extension/{{SUBPAGENAME}}]]
__FORCETOC__

[[Category:Administration]]

File:Manual:ExtendedStatistics3.png

2022-01-12T08:05:28Z

Ptechnik:

File:Manual:Mediawiki Extension ExtendedStatistics.png

2022-01-12T08:05:17Z

Ptechnik:

File:Manual:extendedstatistics.png

2022-01-12T08:03:01Z

Ptechnik:

Manual:Extension/BlueSpiceExtendedFilelist

2022-01-11T14:16:09Z

Ptechnik:

{{DISPLAYTITLE:extended Filelist}}

__TOC__

==What is BlueSpiceExtendedFilelist?==
'''BlueSpiceExtendedFilelist''' is special page listing all the files in the Wiki. It provides advanced user interface and other advantages over default MediaWiki filelist.

==Where to find BlueSpiceExtendedFilelist?==
[[File:Manual:filelist.png|link=link=Special:FilePath/BlueSpiceExtendedFileList.JPG|alt=|thumb]]
This extension can be accessed from the left navigation, in tab "Global actions".

In addition to filterable overview of all files uploaded to the wiki, new files can be uploaded directly from the user interface.

==possible actions==
'''For this site are following functions available'''
*''' filter list:''' Click on the ''X-''symbol to delete the filter field.
*''' Upload new files:''' Click on the upload-symbol next to the filter field to add files to the wiki (Multi-upload is possible). Alternative click on the magnifying glass on the filter field.
*''' filter namespace:''' Select a namespace from the dropdown menu to see files from a certain namespace.
*''' search result:''' Navigate through diffrent pages of the filelist.
*'''Change result per page:''' Determine how many files you want per page.
*'''Sort filelist:''' Click on a column heading to change the sort order (ascending / descending). Hover over a column heading and click the arrow to open the sort menu.
*'''Show / hide columns:''' Hover over any heading and click on teh arrow to open the column filter. Select the columns you want to display.
*'''Column filter:'''Hover over any heading and click the arrow to open the column filter. Move the mouse pointer over filter and enter a filter term.
*'''View file:'''Click the thumbnail to open the file.
*'''Display file:'''Click the file name to open the file description page.

==See also==

[[ExtendedFilelist|Reference page]] for this extension.

{{Translation}}

File:Manual:filelist.png

2022-01-11T14:15:17Z

Ptechnik:

Manual:Extension/BlueSpiceExtendedFilelist

2022-01-11T14:10:48Z

Ptechnik:

{{DISPLAYTITLE:extended Filelist}}

__TOC__

==What is BlueSpiceExtendedFilelist?==
'''BlueSpiceExtendedFilelist''' is special page listing all the files in the Wiki. It provides advanced user interface and other advantages over default MediaWiki filelist.

==Where to find BlueSpiceExtendedFilelist?==
[[File:BlueSpiceExtendedFileList.JPG|thumb|link=Special:FilePath/BlueSpiceExtendedFileList.JPG]]
This extension can be accessed from the left navigation, in tab "Global actions".

In addition to filterable overview of all files uploaded to the wiki, new files can be uploaded directly from the user interface.

==possible actions==
'''For this site are following functions available'''
*''' filter list:''' Click on the ''X-''symbol to delete the filter field.
*''' Upload new files:''' Click on the upload-symbol next to the filter field to add files to the wiki (Multi-upload is possible). Alternative click on the magnifying glass on the filter field.
*''' filter namespace:''' Select a namespace from the dropdown menu to see files from a certain namespace.
*''' search result:''' Navigate through diffrent pages of the filelist.
*'''Change result per page:''' Determine how many files you want per page.
*'''Sort filelist:''' Click on a column heading to change the sort order (ascending / descending). Hover over a column heading and click the arrow to open the sort menu.
*'''Show / hide columns:''' Hover over any heading and click on teh arrow to open the column filter. Select the columns you want to display.
*'''Column filter:'''Hover over any heading and click the arrow to open the column filter. Move the mouse pointer over filter and enter a filter term.
*'''View file:'''Click the thumbnail to open the file.
*'''Display file:'''Click the file name to open the file description page.

==See also==

[[ExtendedFilelist|Reference page]] for this extension.

{{Translation}}

SocialEntity:167

2022-01-11T13:43:36Z

Ptechnik:

{
"wikipageid": 1085,
"namespace": 0,
"titletext": "Extension/BlueSpiceExtendedFileList",
"description": "",
"parentid": 0,
"id": 167,
"ownerid": 9,
"type": "wikipage",
"archived": false,
"tags": [
"Extension/BlueSpiceExtendedFileList"
],
"resolved": false
}

Manual:Extension/BlueSpiceExtendedFilelist

2022-01-11T13:43:36Z

Ptechnik:

SocialEntity:166

2022-01-11T13:32:46Z

Ptechnik:

{
"wikipageid": 1084,
"namespace": 0,
"titletext": "Manual:Extension/BlueSpiceContextMenu",
"description": "",
"parentid": 0,
"id": 166,
"ownerid": 9,
"type": "wikipage",
"archived": false,
"tags": [
"Manual:Extension/BlueSpiceContextMenu"
],
"resolved": false
}

Manual:Extension/BlueSpiceContextMenu

2022-01-11T13:32:46Z

Ptechnik:

{{DISPLAYTITLE:Context menu}}

'''ContextMenu''' replaces the default browser context menu with wiki functions - depending on the context and user permissions.

==Using the context menu==
Context menu opens when right clicking components that support ContextMenu functionitly, namely, internal links and file links.

The context menu opens when you right-click on a component, such as a link or an image.

 
[[File:Manual:ContextMenu3.png|alt=|center|thumb|Context menu on a file (image)]]
On internal links, the context menu display quick links for basic page actions, like:

*Editing page
*Viewing page history
*Moving page
*Deleting page...

On file links, some additional options are shown, like:

*Opening file page
*Downloading file
*Uploading new version of the file
*Opening files using client application (when available)

Exact content of ContextMenu menu depends on the wiki configuration

==Settings==
[[File:Manual:ContextMenu1.png|alt=|center|thumb|User preference settings]]

Settings for the context menu are located in the user preferences (page ''Special:Preferences''), under the "Appearance" tab. The setting is applied separate for each user.

The context menu has two modes:

*Click using the right mouse button and pressing CTRL (Normal right mouse button will show default browser menu)
*Click using the right mouse button (Pressing CTRL will show default browser context menu)

{{Box Links-en|Topic1=[[Reference:BlueSpiceContextMenu]]}}

{{Translation}}
__FORCETOC__
[[Category:Editing]]

File:Manual:ContextMenu1.png

2022-01-11T13:32:16Z

Ptechnik:

File:Manual:ContextMenu3.png

2022-01-11T13:30:28Z

Ptechnik:

SocialEntity:165

2022-01-11T13:24:13Z

Ptechnik:

{
"wikipageid": 1083,
"namespace": 0,
"titletext": "Manual:Extension/BlueSpiceChecklist",
"description": "",
"parentid": 0,
"id": 165,
"ownerid": 9,
"type": "wikipage",
"archived": false,
"tags": [
"Manual:Extension/BlueSpiceChecklist"
],
"resolved": false
}

Manual:Extension/BlueSpiceChecklist

2022-01-11T13:24:12Z

Ptechnik:

{{DISPLAYTITLE:Checklists}}

'''BlueSpiceChecklist''' allows inserting checklists and checkboxes for to-do lists with responsibilities and status settings.

==Magic word "checklist"==

It is easy to insert simple checklists into any wiki page. When a wiki page has a checklist, any user with ''checklistmodify'' rights can update the checklist values without switching into edit mode. These are by default users in the role ''editor'', ''author,'' ''maintenanceadmin'' and ''bot''.
{{Messagebox|boxtype=note|Note text=If a user with read permissions changes the value of a checkbox or drop-down list, the value will not be saved. Refreshing the page will show the last value that has been saved before.}}

To create a checklist item:

*'''Click''' ''Insert > More > Magic word'' in the visual editor.[[File:Manual:ve-magicword.png|alt=The visual editor|center|thumb|222x222px|The visual editor]] 
*'''Click''' c''hecklist'' in the dialog window. [[File:Manual:Checklist2.png|link=link=https://en.wiki.bluespice.com/wiki/File:Checklist2.png|alt=|center|thumb|Magic word ''checklist'']]
*'''Click''' ''Done''. Another dialog window appears.[[File:Manual:magicword-dialog-EN.png|alt=|center|thumb|Dialog window for checklists]]

Now select the tab to select your checklist type:

*''Checkbox:'' creates an individual checkbox.
*''List:'' creates a drop-down menu.

A page can contain multiple checkboxes and lists.

===Creating a checkbox===

#'''Toggle''' the switch in the dialog window on the checkbox tab to create an unselected checkbox. When this toggle is blue, the checkbox is pre-selected.
#'''Select''' ''insert.'' The checkbox is now visible on the page. Write the text for a label or for an instruction next to the checkbox

After the page has been saved, all users can activate and deactivate the checkbox.

===Creating a drop-down list===
[[File:Manual:Checklist4-EN.png|alt=Selecting a checklist template|center|thumb|400x400px|Selecting a checklist template]]
 

#'''Select''' an [[#Defining an option list|existing option list]] in the ''List'' tab.
#Under Selected option, choose the default value.
#'''Click''' Done.

After saving the page, all users can change the selected list value in read mode.

===Defining an option list===
Before a combobox can be created, a template for the list items needs to be available. For example, to create a list of pizzas, you need to create a page ''Template:Pizza'' with the following content:

<pre>
* Choose pizza
* Margherita
* Prosciutto
* Salami
* Fungi|#00FF00
* Hawaii
* Gamberetti|#0000FF
* Diavolo
* Siziliana|#0000FF
* Quattro Formaggi|#00FF00
</pre>

After saving this page, the list "Pizza" appears in the select menu ''Option list''.

Colors can be assigned to each option using the color's [[wikipedia:Web_colors|HEX code]]. The color value #00FF00 shows green text.
<pre>* Quattro Formaggi|#00FF00</pre>
Without specifying the color, text inherits the text color of the wiki page.
[[File:Manual:Checklist5.png|link=link=https://en.wiki.bluespice.com/wiki/File:Checklist5.png|alt=|center|thumb|Checklist examples (checkbox and select menu)]]

==Adding checklists in source editing mode==
Checklists can also be added to a page using wikitext.
The syntax for adding the tag is:

Checkbox: <syntaxhighlight lang="text">
<bs:checklist type="check" checked="true" />
</syntaxhighlight>The value of the paramter ''checked'' can be ''true'' or ''false'', depending on whether the checkbox should initially be selected (true) or deselected (false).

List:<syntaxhighlight lang="text">
<bs:checklist type="list" list="Template:Pizza" value="Choose pizza" />
</syntaxhighlight>The parameter ''list'' defines the template page that contains the list, ''value'' defines the initial selection.

Once a checklist tag has been saved on a page, users can change its value in read mode.

==Configuration==

The following configuration can be changed in the [[Manual:Extension/BlueSpiceConfigManager|Config manager]]:

{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceChecklist}}

{{Box Links-en|Topic1=[[Reference:BlueSpiceChecklist]]}}

[[en:{{FULLPAGENAME}}]]
[[de:Handbuch:Erweiterung/BlueSpiceCheckList]]
[[Category:Content]]