BlueSpice Wiki - User contributions [en]

SocialEntity:6937

2021-12-20T10:50:57Z

PraktiED:

{
"social-profile-title": null,
"social-profile-name": null,
"social-profile-email": null,
"social-profile-department": "",
"social-profile-function": "",
"social-profile-location": "",
"social-profile-phone": "",
"description": "",
"parentid": 0,
"id": 6937,
"ownerid": 54,
"type": "profile",
"archived": false,
"tags": [
"User:PraktiED"
],
"resolved": false
}

SocialEntity:6936

2021-12-20T10:44:53Z

PraktiED:

{
"social-profile-title": null,
"social-profile-name": null,
"social-profile-email": null,
"social-profile-department": "",
"social-profile-function": "",
"social-profile-location": "",
"social-profile-phone": "",
"description": "",
"parentid": 0,
"id": 6936,
"ownerid": 54,
"type": "profile",
"archived": false,
"tags": [
"User:PraktiED"
],
"resolved": false
}

SocialEntity:6935

2021-12-20T10:29:50Z

PraktiED:

{
"social-profile-title": null,
"social-profile-name": null,
"social-profile-email": null,
"social-profile-department": "",
"social-profile-function": "",
"social-profile-location": "",
"social-profile-phone": "",
"description": "",
"parentid": 0,
"id": 6935,
"ownerid": 54,
"type": "profile",
"archived": false,
"tags": [
"User:PraktiED"
],
"resolved": false
}

SocialEntity:6934

2021-12-20T10:08:35Z

PraktiED:

{
"social-profile-title": null,
"social-profile-name": null,
"social-profile-email": null,
"social-profile-department": "",
"social-profile-function": "",
"social-profile-location": "",
"social-profile-phone": "",
"description": "",
"parentid": 0,
"id": 6934,
"ownerid": 54,
"type": "profile",
"archived": false,
"tags": [
"User:PraktiED"
],
"resolved": false
}

Setup:Installation Guide/System Preparation/Windows/Node.js

2021-10-14T12:32:31Z

PraktiED:

{{DISPLAYTITLE:Node.js on Windows}}
__TOC__

{{Template:Optional|text=Node.js is required for the operation of the rendering service "Parsoid" for the Visual Editor. The steps listed here are optional and only required if you plan to use them in your BlueSpice installation.}} 
==Download==
{{Template:Hint|text=This guide uses the Node.js version 10.13.0 as an example. You can download any 10.x version of Node.js.
BlueSpice is NOT compatible with a Node.js version greater than 10.x!}}In Internet Explorer, open the [https://nodejs.org/en/download/releases/ official website of Node.js] (1). Download the latest LTS version 10.x.

Follow the further download instructions and download the installation package to your hard drive.

{{Template:Hint|text=Please note that the download on your Windows Server with Internet Explorer only works if you have configured the Internet Explorer Advanced Security Settings in the Server Manager. Please refer to the technical documentation from Microsoft.}} 
==Installing Node.js==
Open the downloaded file "node-v10.13.0-x64.msi".

Start the installation by clicking "Next>":

[[File:Setup:Nodejs_Install_01.png|center|400px|Node.js Installation 01]]

Confirm the license (1) and click "Next >" (2):

[[File:Setup:Nodejs_Install_02.png|center|400px|Node.js Installation 02]]

Confirm the further installation steps by clicking "Next >":

<gallery>
File:Setup:Nodejs_Install_03.png
File:Setup:Nodejs_Install_04.png
File:Setup:Nodejs_Install_05.png
</gallery>

Start the installation by clicking "Install":

[[File:Setup:Nodejs_Install_06.png|center|400px|Node.js Installation 06]]

You can close the setup program after finishing the installation:

[[File:Setup:Nodejs_Install_07.png|center|400px|Node.js Installation 07]] 
==Adjusting the Installation path of the Node.js packages==
By default, Node.js installs its packages in the profile directory of the logged-in user. Since Node.js is intended solely to operate as a user-independent server application under BlueSpice, it is strongly recommended that you change the default path for these packages:

In the Node.js installation folder, open the file node_modules\npm\npmrcin a text editor:

[[File:Setup:Nodejs_ChangePath_01.png|center|400px|Node.js Standardpfad ändern 01]]

Edit this file and enter the new default path for your Node.js packages:

[[File:Setup:Nodejs_ChangePath_02.png|center|400px|Node.js Standardpfad ändern 02]]

Save the file and close the editor.

{{Template:Hint|text=This documentation is based on the [[Setup:Installation Guide/Advanced/Windows_Folder_Structure | folder structure recommended by us]]. For this reason, the default path for the Node.js packages is set to the folder C:\bluespice\bin\npm. If you have different requirements, you must adapt these paths accordingly.}}

==Installing the Windows Build Tools==
The Node.js package windows-build-tools is required for installing the relevant BlueSpice applications.

To install, first open the Windows command prompt as administrator. To do this, right-click "Start" (1) and select "Command Prompt (Administrator)" (2):
[[File:Setup:Nodejs_InstallWindowsBuildTools_01.png|center|200px|Node.js Installation Windows Build Tools 01]]

Execute the command "npm install --global --production --vs2015 windows-build-tools":

[[File:Setup:Nodejs_InstallWindowsBuildTools_02.png|center|400px|Node.js Installation Windows Build Tools 02]]Execute the command in C:\Windows\system32.{{Template:Hint|text=This command may take a long time and not show any activity for a long time. However, it is still active and must not be canceled! Additionally, Windows Server may restart during the process without warning. In this case, restart the installation as described above.}}

After successful installation, you can close the command prompt:

[[File:Setup:Nodejs_InstallWindowsBuildTools_03.png|center|400px|Node.js Installation Windows Build Tools 03]]

==Next step==
If you have completed all steps successfully, you can delete the previously downloaded file "node-v10.13.0-x64.msi" from your hard disk and continue to the next step "[[Setup:Installation Guide/System Preparation/Windows/Parsoid | Parsoid]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Windows/Node.js]]

Setup:Installation Guide/With Installer

2021-10-14T09:54:19Z

PraktiED:

{{DISPLAYTITLE:Installing BlueSpice 3 with installer}}
__TOC__

==Introduction==
With BlueSpice 3, we offer the installation as a complete package with MediaWiki and BlueSpice.
This installation guide gives you step-by-step instructions to install BlueSpice.
{{Box Note|boxtype=important|Note text=If you do a fresh install of BlueSpice 3.2 it might be necessary to run update.php afterwards if you get an error.}}
{{Box Note|boxtype=note|Note text=This document only describes the steps for installing the web application itself. For the installation of extended functions such as [[Setup:Installation_Guide/Advanced/VisualEditor_Configuration|VisualEditor]] and [[Setup:Installation Guide/Advanced/ExtendedSearch Configuration|Extendedsearch]], please refer to the corresponding documentation.

We will not go into details about your operating system installation here, but assume that you have already [[Setup:Installation_Guide#Prerequesites|configured your system]] and stored the installation package in a web root of your choice, where you can access it via your browser. You can find more details in our detailed [[Setup:Installation Guide|installation guide]].

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

{{Hint
|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!
}}

{| class="wikitable"
|-
|[[File:Setup:Screenshot 12.png|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.

'''Note:''' If you don't meet all necessary requirements for PHP yet, you won't be able to view this setup page yet. Please make the necessary corrections to your PHP installation first. Otherwise, you are now on the page shown in the screenshot (click on the thumbnail to see the full screenshot).

|-
|[[File:Setup:Screenshot (213) 123.png|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|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|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|300px|BlueSpice 3 Installation Step 5]]
||'''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|300px|BlueSpice 3 Installation Step 6]]
||'''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|300x300px]]
||'''Step 7 - Options:''' In this step, you specify the e-mail address for notification e-mails.
|-
|[[File:Setup:Screenshot (220)35.png|300x300px]]
||'''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|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|300x300px]]
||'''Step 10 - Download LocalSettings.php:''' In the last step of the installation, you will be asked to download the configuration file "LocalSettings.php" of your installation. Download it and place it in the root directory of your BlueSpice codebase.
|-
|
|'''Step 11 - Rename the template folders:''' Open the folder <code>..\extensions\BluesSpiceFoundation</code> and rename the subfolder <code>config.template</code> to <code>config</code> and create the new folder <code>data</code>. These folders should have read and write access, see [[Setup:Installation Guide/Security Settings/File System Permissions|File System Permissions]].
Run the script <code>..\maintenance\update.php</code> from the console.

If you receive the error message "Fatal exception of type MWException", open the terminal and run the command "sudo nautilus". After that, give the folder /var where bluespice was installed all rights.
|-
|[[File:Setup:bs3-install-11.png|300px|BlueSpice 3 Installation Step 12]]
||'''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]]

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

*php maintenance/update.php ''(Linux)''
*php maintenance\update.php ''(Windows)''
{{Box Note|boxtype=note|Note text=If the page is not loading, give the group "users" change-permissions for the folder C:\Windows\Temp.}}{{Box Note|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/PDF-Export

2021-10-14T09:36:11Z

PraktiED:

{{DISPLAYTITLE:Webservice: PDF-Export}}
__TOC__

Make sure that the [[Setup:Installation_Manual/System_Configuration/Apache_Tomcat|Apache Tomcat server]] is completely installed and configured on the BlueSpice server before setting up PDF-Export.

==Moving the BShtml2PDF Application==
Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <code><tomcat-webapps></code>

The default paths are as follows:

*C:\Program Files\Apache Software Foundation\Tomcat 10.0\webapps '''(Apache Tomcat on Windows)'''
*/var/lib/jetty9/webapps '''(Jetty on Debian)'''

Or run the command <code>sudo mv /var/www/bluespice/w/extensions/BlueSpiceUEModulePDF/webservices/BShtml2PDF.war /var/lib/jetty9/webapps</code> in the terminal. '''(Linux)'''

The application usually starts automatically without the need for rebooting the application server.

==Checking the functionality==
The correct functionality of the BShtml2PDF service can be checked as follows:

On Windows, open Internet Explorer using the URL <nowiki>http://localhost:8080/BShtml2PDF</nowiki>. With correct functionality, you should see the following website:
[[File:Setup:Tomcat_Check_03.png|center|400px|Tomcat Check 03]]

==Enable PDF Export in BlueSpice==
Go to the directory <code><installpath-bluespice>/settings.d</code>. Open the file '''020-BlueSpiceUEModulePDF.php''' in a text editor.

Or open the 020-BlueSpiceUEModulePDF.php in the terminal using the command <code>sudo nano /var/www/bluespice/w/settings.d/020-BlueSpiceUEModulePDF.php</code>. '''(Linux)'''

In the second line is the code to activate the extension:

return; // Disabled. Needs Tomcat

You can either add a comment character (#) to the beginning of this line or delete the line completely, save the file and exit it.

{{Hint|text=Give the user "Everyone" full access to the Temp folder under C:\Widows.}}

==Installing BlueSpice 3 with installer==

#Open <code>localhost/w</code> in your Browser and follow the [[:en:Setup:Installation_Guide/With_Installer|instructions]].
#For BlueSpice WikiFarm, move the .htaccess and web.config files to C:\bluespice\var

Open a command line and change into the folder <code><installpath-bluespice></code>. Execute the following command:

php maintenance/update.php ''(Linux)''
php maintenance\update.php ''(Windows))''
{{Hint
|text=In Windows, make sure that the environment variables are set correctly to access the "php" command.}}
{{Hint
|text=Note that you must update the [[Setup:Installation Guide/Security Settings/File System Permissions#Assignment_of_Permissions_with_Linux|file system permissions]] after running update.php.}}

When the script is finished with the "Done" message, you have successfully isntalled the web service .

[[File:Setup:Setup_bluespice_maintenance_update.jpg|center|400x556px]]

==Troubleshooting==
If there is a problem with the PDF export in BlueSpice, first check the [[Setup:Installation Guide/Security Settings/File System Permissions|file system permissions]].
==Download Web services==
If the required war-file is missing in your installation package, you can download it here: [https://buildservice.bluespice.com/webservices3.tar.gz Webservices].

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Webservices/PDF-Export]]

SocialEntity:6837

2021-10-13T11:55:58Z

PraktiED:

{
"social-profile-title": null,
"social-profile-name": null,
"social-profile-email": null,
"social-profile-department": "",
"social-profile-function": "",
"social-profile-location": "",
"social-profile-phone": "",
"description": "",
"parentid": 0,
"id": 6837,
"ownerid": 54,
"type": "profile",
"archived": false,
"tags": [
"User:PraktiED"
],
"resolved": false
}

Setup:Installation Guide/Webservices/PDF-Export

2021-10-13T08:17:50Z

PraktiED:

{{DISPLAYTITLE:Webservice: PDF-Export}}
__TOC__

Make sure that the [[Setup:Installation_Manual/System_Configuration/Apache_Tomcat|Apache Tomcat server]] is completely installed and configured on the BlueSpice server before setting up PDF-Export.

==Moving the BShtml2PDF Application==
Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <code><tomcat-webapps></code>

The default paths are as follows:

*C:\Program Files\Apache Software Foundation\Tomcat 10.0\webapps '''(Apache Tomcat on Windows)'''
*/var/lib/jetty9/webapps '''(Jetty on Debian)'''

Or run the command <code>sudo mv /var/www/bluespice/w/extensions/BlueSpiceUEModulePDF/webservices/BShtml2PDF.war /var/lib/jetty9/webapps</code> in the terminal. '''(Linux)'''

The application usually starts automatically without the need for rebooting the application server.

==Checking the functionality==
The correct functionality of the BShtml2PDF service can be checked as follows:

On Windows, open Internet Explorer using the URL <nowiki>http://localhost:8080/BShtml2PDF</nowiki>. With correct functionality, you should see the following website:
[[File:Setup:Tomcat_Check_03.png|center|400px|Tomcat Check 03]]

==Enable PDF Export in BlueSpice==
Go to the directory <code><installpath-bluespice>/settings.d</code>. Open the file '''020-BlueSpiceUEModulePDF.php''' in a text editor.

Or open the 020-BlueSpiceUEModulePDF.php in the terminal using the command <code>sudo nano /var/www/bluespice/w/settings.d/020-BlueSpiceUEModulePDF.php</code>. '''(Linux)'''

In the second line is the code to activate the extension:

return; // Disabled. Needs Tomcat

You can either add a comment character (#) to the beginning of this line or delete the line completely, save the file and exit it.

{{Hint|text=Give the user "Everyone" full access to the Temp folder under C:\Widows.}}

==Installing BlueSpice 3 with installer==

#Open <code>localhost/w</code> in your Browser and follow the [[:en:Setup:Installation_Guide/With_Installer|instructions]].

Open a command line and change into the folder <code><installpath-bluespice></code>. Execute the following command:

php maintenance/update.php ''(Linux)''
php maintenance\update.php ''(Windows))''
{{Hint
|text=In Windows, make sure that the environment variables are set correctly to access the "php" command.}}
{{Hint
|text=Note that you must update the [[Setup:Installation Guide/Security Settings/File System Permissions#Assignment_of_Permissions_with_Linux|file system permissions]] after running update.php.}}

When the script is finished with the "Done" message, you have successfully isntalled the web service .

[[File:Setup:Setup_bluespice_maintenance_update.jpg|center|400x556px]]

==Troubleshooting==
If there is a problem with the PDF export in BlueSpice, first check the [[Setup:Installation Guide/Security Settings/File System Permissions|file system permissions]].
==Download Web services==
If the required war-file is missing in your installation package, you can download it here: [https://buildservice.bluespice.com/webservices3.tar.gz Webservices].

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Webservices/PDF-Export]]

Setup:Installation Guide/System Preparation/Windows/Apache Tomcat

2021-10-13T08:08:00Z

PraktiED:

{{DISPLAYTITLE:Apache Tomcat on Windows}}
__TOC__

{{Template:Optional|text=Apache Tomcat is required for the PDF export, VisualDiff (BlueSpice pro only) and the LaTeX renderer (BlueSpice pro only). The following steps are optional and only required if you want to use one or more of these services in your BlueSpice installation.}}
{{Template:Hint|text=Operation of Apache Tomcat requires [[Setup:Installation Guide/System Preparation/Windows/OpenJDK| OpenJDK]]. If you have not installed it, follow the link above.}}
==Download==
Open the [http://tomcat.apache.org/ official download page] (1) in your browser and go to the version 10 (2) download page.
[[File:Setup:tc1.png|center|400x400px|Tomcat Download 01]]
Download the "32-bit/64-bit Windows Service Installer"
[[File:Setup:tc2.png|center|400x400px|Tomcat Download 02]]

{{Template:Hint|text=Please note that the download on your Windows server with Internet Explorer only works if you have configured the Internet Explorer Advanced Security Settings in the Server Manager. Please refer to the technical documentation from Microsoft.}}

{{Template:Hint|text=This guide uses version 10.0.12 of Apache Tomcat and is just an example of the latest version that you can download at the time of installation.}}
==Installing Apache Tomcat==
Open the downloaded file "apache-tomcat-10.0.12.exe".

Start the installation by clicking "Next >":
[[File:Setup:tm v3.png|center|400x400px|Tomcat Installation 01]]
Confirm the license agreement by clicking "I Agree":

[[File:Setup:Tomcat_Install_02.png|center|400px|Tomcat Installation 02]]

Click "Next >":

[[File:Setup:Tomcat_Install_03.png|center|400px|Tomcat Installation 03]]

Click "Next >" again:
[[File:Setup:tm v4.png|center|400x400px|Tomcat Installation 04]]
Select (1) the home directory of your [[Setup:Installation Guide/System Preparation/Windows/OpenJDK | OpenJDK Installation]] (2) and click "Next>" (3):
[[File:Setup:tm3.png|center|400x400px|Tomcat Installation 05]]
Start the Tomcat Installation:
[[File:Setup:tm4.png|center|400x400px|Tomcat Installation 06]]
At the end of the installation, leave both preselected checkboxes (1) and finish the setup (2)
[[File:Setup:tm v7.png|center|400x400px|Tomcat Installation 07]]

==Configuring Apache Tomcat==
Change to the installation directory of Tomcat. By default, you can find it at <code>C:\Program Files\Apache Software Foundation\Tomcat 9.0\conf</code>.

Open the context.xml file in a text editor and replace the one-time line
<pre><Context></pre>
with
<pre><Context mapperContextRootRedirectEnabled="true"></pre>

[[File:Setup:Tomcat_Configuration_01.png|center|400px|Tomcat Configuration 01]]

Save and close the file.

In the same directory, open the file server.xml in a text editor and make sure that the complete block
<pre><Connector port="8080" protocol="HTTP/1.1"
... /></pre>
looks like this:
<pre><Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
URIEncoding="UTF-8"
redirectPort="8443"
address="127.0.0.1" /></pre>

[[File:Setup:Tomcat_Configuration_02.png|center|400px|Tomcat Configuration 02]]

Save and close the file.

Find the entry "Configure Tomcat" in the start menu and open it:

[[File:Setup:Tomcat_Configuration_03.png|center|400px|Tomcat Configuration 03]]

Set "Startup type" to "Automatic" (1) and start Tomcat (2). Then exit the configuration console (3):
[[File:Setup:tm5.png|center|479x479px|Tomcat Configuration 04]]

==Reviewing the installation==
To check if Tomcat is working correctly, open the address <nowiki>http://localhost:8080/</nowiki> in a browser on the server. 
You should now see the homepage of the Tomcat server:

[[File:Setup:tm6.png|center|400x400px|Tomcat Check 01]]

==Installing the web apps==
{{Hint|text=Please unzip the installed BlueSpice folder and move the subfolder to C:\bluespice\var\www. Rename the folder to "w".}}
After the successful installation of BlueSpice, please follow the next steps to install the web services and activate the respective BlueSpice extension:

*[[Setup:Installation Guide/Webservices/PDF-Export|PDF-Export]]
*[[Setup:Installation Guide/Webservices/VisualDiff|VisualDiff]] (BlueSpice pro only)
*[[Setup:Installation Guide/Webservices/LatexRenderer|LatexRenderer]] (nurBlueSpice pro only)

==Next step==
If you have completed all steps successfully, you can delete the previously downloaded "apache-tomcat-10.0.11.exe" file from your hard drive and continue to the next step "[[Setup: Installation Guide/System Preparation/Windows/Elasticsearch | Elasticsearch]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Windows/Apache_Tomcat]]

Setup:Installation Guide/System Preparation/Windows/Apache Tomcat

2021-10-13T07:57:47Z

PraktiED:

{{DISPLAYTITLE:Apache Tomcat on Windows}}
__TOC__

{{Template:Optional|text=Apache Tomcat is required for the PDF export, VisualDiff (BlueSpice pro only) and the LaTeX renderer (BlueSpice pro only). The following steps are optional and only required if you want to use one or more of these services in your BlueSpice installation.}}
{{Template:Hint|text=Operation of Apache Tomcat requires [[Setup:Installation Guide/System Preparation/Windows/OpenJDK| OpenJDK]]. If you have not installed it, follow the link above.}}
==Download==
Open the [http://tomcat.apache.org/ official download page] (1) in your browser and go to the version 10 (2) download page.
[[File:Setup:tc1.png|center|400x400px|Tomcat Download 01]]
Download the "32-bit/64-bit Windows Service Installer"
[[File:Setup:tc2.png|center|400x400px|Tomcat Download 02]]

{{Template:Hint|text=Please note that the download on your Windows server with Internet Explorer only works if you have configured the Internet Explorer Advanced Security Settings in the Server Manager. Please refer to the technical documentation from Microsoft.}}

{{Template:Hint|text=This guide uses version 10.0.12 of Apache Tomcat and is just an example of the latest version that you can download at the time of installation.}}
==Installing Apache Tomcat==
Open the downloaded file "apache-tomcat-10.0.12.exe".

Start the installation by clicking "Next >":
[[File:Setup:tm v3.png|center|400x400px|Tomcat Installation 01]]
Confirm the license agreement by clicking "I Agree":

[[File:Setup:Tomcat_Install_02.png|center|400px|Tomcat Installation 02]]

Click "Next >":

[[File:Setup:Tomcat_Install_03.png|center|400px|Tomcat Installation 03]]

Click "Next >" again:
[[File:Setup:tm v4.png|center|400x400px|Tomcat Installation 04]]
Select (1) the home directory of your [[Setup:Installation Guide/System Preparation/Windows/OpenJDK | OpenJDK Installation]] (2) and click "Next>" (3):
[[File:Setup:tm3.png|center|400x400px|Tomcat Installation 05]]
Start the Tomcat Installation:
[[File:Setup:tm4.png|center|400x400px|Tomcat Installation 06]]
At the end of the installation, leave both preselected checkboxes (1) and finish the setup (2)
[[File:Setup:tm v7.png|center|400x400px|Tomcat Installation 07]]

==Configuring Apache Tomcat==
Change to the installation directory of Tomcat. By default, you can find it at <code>C:\Program Files\Apache Software Foundation\Tomcat 9.0\conf</code>.

Open the context.xml file in a text editor and replace the one-time line
<pre><Context></pre>
with
<pre><Context mapperContextRootRedirectEnabled="true"></pre>

[[File:Setup:Tomcat_Configuration_01.png|center|400px|Tomcat Configuration 01]]

Save and close the file.

In the same directory, open the file server.xml in a text editor and make sure that the complete block
<pre><Connector port="8080" protocol="HTTP/1.1"
... /></pre>
looks like this:
<pre><Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
URIEncoding="UTF-8"
redirectPort="8443"
address="127.0.0.1" /></pre>

[[File:Setup:Tomcat_Configuration_02.png|center|400px|Tomcat Configuration 02]]

Save and close the file.

Find the entry "Configure Tomcat" in the start menu and open it:

[[File:Setup:Tomcat_Configuration_03.png|center|400px|Tomcat Configuration 03]]

Set "Startup type" to "Automatic" (1) and start Tomcat (2). Then exit the configuration console (3):
[[File:Setup:tm5.png|center|479x479px|Tomcat Configuration 04]]

==Reviewing the installation==
To check if Tomcat is working correctly, open the address <nowiki>http://localhost:8080/</nowiki> in a browser on the server. 
You should now see the homepage of the Tomcat server:

[[File:Setup:tm6.png|center|400x400px|Tomcat Check 01]]

==Installing the web apps==
{{Hint|text=Please unzip the installed BlueSpice folder and move it to C:\bluespice\var\www. Rename the folder to "bluespice" and the subfolder to "w".}}
After the successful installation of BlueSpice, please follow the next steps to install the web services and activate the respective BlueSpice extension:

*[[Setup:Installation Guide/Webservices/PDF-Export|PDF-Export]]
*[[Setup:Installation Guide/Webservices/VisualDiff|VisualDiff]] (BlueSpice pro only)
*[[Setup:Installation Guide/Webservices/LatexRenderer|LatexRenderer]] (nurBlueSpice pro only)

==Next step==
If you have completed all steps successfully, you can delete the previously downloaded "apache-tomcat-10.0.11.exe" file from your hard drive and continue to the next step "[[Setup: Installation Guide/System Preparation/Windows/Elasticsearch | Elasticsearch]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Windows/Apache_Tomcat]]

Setup:Installation Guide/System Preparation/Windows/Apache Tomcat

2021-10-13T07:49:11Z

PraktiED:

{{DISPLAYTITLE:Apache Tomcat on Windows}}
__TOC__

{{Template:Optional|text=Apache Tomcat is required for the PDF export, VisualDiff (BlueSpice pro only) and the LaTeX renderer (BlueSpice pro only). The following steps are optional and only required if you want to use one or more of these services in your BlueSpice installation.}}
{{Template:Hint|text=Operation of Apache Tomcat requires [[Setup:Installation Guide/System Preparation/Windows/OpenJDK| OpenJDK]]. If you have not installed it, follow the link above.}}
==Download==
Open the [http://tomcat.apache.org/ official download page] (1) in your browser and go to the version 10 (2) download page.
[[File:Setup:tc1.png|center|400x400px|Tomcat Download 01]]
Download the "32-bit/64-bit Windows Service Installer"
[[File:Setup:tc2.png|center|400x400px|Tomcat Download 02]]

{{Template:Hint|text=Please note that the download on your Windows server with Internet Explorer only works if you have configured the Internet Explorer Advanced Security Settings in the Server Manager. Please refer to the technical documentation from Microsoft.}}

{{Template:Hint|text=This guide uses version 10.0.12 of Apache Tomcat and is just an example of the latest version that you can download at the time of installation.}}
==Installing Apache Tomcat==
Open the downloaded file "apache-tomcat-10.0.12.exe".

Start the installation by clicking "Next >":
[[File:Setup:tm v3.png|center|400x400px|Tomcat Installation 01]]
Confirm the license agreement by clicking "I Agree":

[[File:Setup:Tomcat_Install_02.png|center|400px|Tomcat Installation 02]]

Click "Next >":

[[File:Setup:Tomcat_Install_03.png|center|400px|Tomcat Installation 03]]

Click "Next >" again:
[[File:Setup:tm v4.png|center|400x400px|Tomcat Installation 04]]
Select (1) the home directory of your [[Setup:Installation Guide/System Preparation/Windows/OpenJDK | OpenJDK Installation]] (2) and click "Next>" (3):
[[File:Setup:tm3.png|center|400x400px|Tomcat Installation 05]]
Start the Tomcat Installation:
[[File:Setup:tm4.png|center|400x400px|Tomcat Installation 06]]
At the end of the installation, leave both preselected checkboxes (1) and finish the setup (2)
[[File:Setup:tm v7.png|center|400x400px|Tomcat Installation 07]]

==Configuring Apache Tomcat==
Change to the installation directory of Tomcat. By default, you can find it at <code>C:\Program Files\Apache Software Foundation\Tomcat 9.0\conf</code>.

Open the context.xml file in a text editor and replace the one-time line
<pre><Context></pre>
with
<pre><Context mapperContextRootRedirectEnabled="true"></pre>

[[File:Setup:Tomcat_Configuration_01.png|center|400px|Tomcat Configuration 01]]

Save and close the file.

In the same directory, open the file server.xml in a text editor and make sure that the complete block
<pre><Connector port="8080" protocol="HTTP/1.1"
... /></pre>
looks like this:
<pre><Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
URIEncoding="UTF-8"
redirectPort="8443"
address="127.0.0.1" /></pre>

[[File:Setup:Tomcat_Configuration_02.png|center|400px|Tomcat Configuration 02]]

Save and close the file.

Find the entry "Configure Tomcat" in the start menu and open it:

[[File:Setup:Tomcat_Configuration_03.png|center|400px|Tomcat Configuration 03]]

Set "Startup type" to "Automatic" (1) and start Tomcat (2). Then exit the configuration console (3):
[[File:Setup:tm5.png|center|479x479px|Tomcat Configuration 04]]

==Reviewing the installation==
To check if Tomcat is working correctly, open the address <nowiki>http://localhost:8080/</nowiki> in a browser on the server. 
You should now see the homepage of the Tomcat server:

[[File:Setup:tm6.png|center|400x400px|Tomcat Check 01]]

==Installing the web apps==
{{Hint|text=Please move the subfolder of the installed BlueSpice folder to C:\bluespice\var\www}}
After the successful installation of BlueSpice, please follow the next steps to install the web services and activate the respective BlueSpice extension:

*[[Setup:Installation Guide/Webservices/PDF-Export|PDF-Export]]
*[[Setup:Installation Guide/Webservices/VisualDiff|VisualDiff]] (BlueSpice pro only)
*[[Setup:Installation Guide/Webservices/LatexRenderer|LatexRenderer]] (nurBlueSpice pro only)

==Next step==
If you have completed all steps successfully, you can delete the previously downloaded "apache-tomcat-10.0.11.exe" file from your hard drive and continue to the next step "[[Setup: Installation Guide/System Preparation/Windows/Elasticsearch | Elasticsearch]]".

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Systemvorbereitung/Windows/Apache_Tomcat]]

Setup:Installation Guide/System Preparation/Linux/Parsoid

2021-09-30T13:19:35Z

PraktiED:

{{DISPLAYTITLE:Installing Parsoid on Linux}}
__TOC__

{{Template:Optional|text=Parsoid is the rendering service for the Visual Editor. The steps listed here are optional and only required if you plan to use them in your BlueSpice installation. After your BlueSpice Installation, you still have to [[Setup:Installation Guide/Advanced/VisualEditor Configuration|activate VisualEditor]].}}
==Installation==
The installation from package sources of the distribution will be omitted. Parsoid is installed under /opt. Go there with the following command:

<pre>cd /opt</pre>

To download Parsoid, the software "git" must be installed(<code>apt install git</code>).
Start the download with:

<pre>git clone --depth 1 --branch v0.10.0 https://gerrit.wikimedia.org/r/p/mediawiki/services/parsoid parsoid</pre>

Install Parsoid with the following commands:

<pre>cd parsoid; \
npm install</pre>

==Create the configuration file==
In the BlueSpice codebase, you can find two files in the folder <code>extensions/BlueSpiceVisualEditorConnector/docs/parsoid</code>:

*config.yaml
*localsettings.js

Copy them to the folder <code>/opt/parsoid</code>.

Parsoid is already fully configured and should work in standard setup without further changes.

{{Hint|text=If rights are missing, run "sudo nautilus" in the terminal and copy the files from "extensions/BlueSpiceVisualEditorConnector/docs/parsoid" to "/opt/parsoid".}}

==Installing Parsoid and checking the configuration==
To test the installation and the configuration, run the command <code>node bin/server.js </code> in the <code>/opt/parsoid </code> folder.

Parsoid should now start without an error message.

Quit Parsoid by pressing "Ctrl+C". Keep the command prompt open and go to the next step.

==Installing Parsoid as a service==
To run Parsoid in the background in the future, you must additionally install pm2 via Node.js:

<pre>npm install -g pm2</pre>

Then start Parsoid via pm2:

<pre>pm2 start /opt/parsoid/bin/server.js</pre>

Now save the pm2 process list — this adds parsoid to the pm2 services:

<pre>pm2 save</pre>

Finally, add pm2 to the system startup:

<pre># Render startup-script for a specific platform, the [platform] could be one of:
# ubuntu|centos|redhat|gentoo|systemd|darwin|amazon
pm2 startup [platform]</pre>

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

[[en:{{FULLPAGENAME}}]]
[[de:etup:Installationsanleitung/Systemvorbereitung/Linux/Parsoid]]

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

2021-09-30T13:07:40Z

PraktiED:

{{DISPLAYTITLE:Installing Apache and PHP on Linux}}
__TOC__

{{Template:Important|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.

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

==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.
[[File:Setup:apache vhost bluespice free.txt|thumb]]
==Configuring Apache==
{{Template:Hint|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.

'''If you do not have rights to save:'''

#Open a text editor of your choice.
#Copy the complete contents of the following file into this new configuration file.
##Bei BlueSpice free: [[Media:Setup:apache vhost bluespice free.txt|apache_vhost_bluespice_free.txt]]
##Bei 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 as <code>bluespice.conf</code> under any file path and exit it.
#In terminal, run the command <code>sudo mv /yourfilepath/bluespice.conf /etc/apache2/sites-available</code>.

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

2021-09-30T13:01:46Z

PraktiED:

{{DISPLAYTITLE:Installing BlueSpice 3 with installer}}
__TOC__

==Introduction==
With BlueSpice 3, we offer the installation as a complete package with MediaWiki and BlueSpice.
This installation guide gives you step-by-step instructions to install BlueSpice.
{{Box Note|boxtype=important|Note text=If you do a fresh install of BlueSpice 3.2 it might be necessary to run update.php afterwards if you get an error.}}
{{Box Note|boxtype=note|Note text=This document only describes the steps for installing the web application itself. For the installation of extended functions such as [[Setup:Installation_Guide/Advanced/VisualEditor_Configuration|VisualEditor]] and [[Setup:Installation Guide/Advanced/ExtendedSearch Configuration|Extendedsearch]], please refer to the corresponding documentation.

We will not go into details about your operating system installation here, but assume that you have already [[Setup:Installation_Guide#Prerequesites|configured your system]] and stored the installation package in a web root of your choice, where you can access it via your browser. You can find more details in our detailed [[Setup:Installation Guide|installation guide]].

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

{{Hint
|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!
}}

{| class="wikitable"
|-
|[[File:Setup:Screenshot 12.png|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.

'''Note:''' If you don't meet all necessary requirements for PHP yet, you won't be able to view this setup page yet. Please make the necessary corrections to your PHP installation first. Otherwise, you are now on the page shown in the screenshot (click on the thumbnail to see the full screenshot).

|-
|[[File:Setup:Screenshot (213) 123.png|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|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|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|300px|BlueSpice 3 Installation Step 5]]
||'''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|300px|BlueSpice 3 Installation Step 6]]
||'''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|300x300px]]
||'''Step 7 - Options:''' In this step, you specify the e-mail address for notification e-mails.
|-
|[[File:Setup:Screenshot (220)35.png|300x300px]]
||'''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|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|300x300px]]
||'''Step 10 - Download LocalSettings.php:''' In the last step of the installation, you will be asked to download the configuration file "LocalSettings.php" of your installation. Download it and place it in the root directory of your BlueSpice codebase.
|-
|
|'''Step 11 - Rename the template folders:''' Open the folder <code>..\extensions\BluesSpiceFoundation</code> and rename the subfolder <code>config.template</code> to <code>config</code> and create the new folder <code>data</code>. These folders should have read and write access, see [[Setup:Installation Guide/Security Settings/File System Permissions|File System Permissions]].
Run the script <code>..\maintenance\update.php</code> from the console.

If you receive the error message "Fatal exception of type MWException", open the terminal and run the command "sudo nautilus". After that, give the folder /var where bluespice was installed all rights.
|-
|[[File:Setup:bs3-install-11.png|300px|BlueSpice 3 Installation Step 12]]
||'''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.
|}
Now open a command line and change to the folder <code><installpath-bluespice></code>. Run the following command:

*php maintenance/update.php ''(Linux)''
*php maintenance\update.php ''(Windows)''
{{Box Note|boxtype=note|Note text=If the page is not loading, give the group "users" change-permissions for the folder C:\Windows\Temp.}}{{Box Note|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]]

SocialEntity:6770

2021-09-30T12:57:56Z

PraktiED:

{
"social-profile-title": null,
"social-profile-name": null,
"social-profile-email": null,
"social-profile-department": "",
"social-profile-function": "",
"social-profile-location": "",
"social-profile-phone": "",
"description": "",
"parentid": 0,
"id": 6770,
"ownerid": 54,
"type": "profile",
"archived": false,
"tags": [
"User:PraktiED"
],
"resolved": false
}

SocialEntity:6765

2021-09-30T08:09:51Z

PraktiED:

{
"wikipageid": 4504,
"revisionid": 27885,
"namespace": 3008,
"titletext": "Installation Guide/System Preparation/Linux/Parsoid",
"action": "edit",
"summary": "how to copy files when rights are missing",
"parentid": 0,
"id": 6765,
"ownerid": 54,
"type": "articlesave",
"archived": false,
"tags": [],
"resolved": false
}

Setup:Installation Guide/System Preparation/Linux/Parsoid

2021-09-30T08:09:50Z

PraktiED: how to copy files when rights are missing

{{DISPLAYTITLE:Installing Parsoid on Linux}}
__TOC__

{{Template:Optional|text=Parsoid is the rendering service for the Visual Editor. The steps listed here are optional and only required if you plan to use them in your BlueSpice installation. After your BlueSpice Installation, you still have to [[Setup:Installation Guide/Advanced/VisualEditor Configuration|activate VisualEditor]].}}
==Installation==
The installation from package sources of the distribution will be omitted. Parsoid is installed under /opt. Go there with the following command:

<pre>cd /opt</pre>

To download Parsoid, the software "git" must be installed(<code>apt install git</code>).
Start the download with:

<pre>git clone --depth 1 --branch v0.10.0 https://gerrit.wikimedia.org/r/p/mediawiki/services/parsoid parsoid</pre>

Install Parsoid with the following commands:

<pre>cd parsoid; \
npm install</pre>

==Create the configuration file==
In the BlueSpice codebase, you can find two files in the folder <code>extensions/BlueSpiceVisualEditorConnector/docs/parsoid</code>:

*config.yaml
*localsettings.js

Copy them to the folder <code>/opt/parsoid</code>.

Parsoid is already fully configured and should work in standard setup without further changes.

{{Hint|text=If rights are missing, run "sudo nautilus" in the terminal and copy the files to /opt/parsoid.}}

==Installing Parsoid and checking the configuration==
To test the installation and the configuration, run the command <code>node bin/server.js </code> in the <code>/opt/parsoid </code> folder.

Parsoid should now start without an error message.

Quit Parsoid by pressing "Ctrl+C". Keep the command prompt open and go to the next step.

==Installing Parsoid as a service==
To run Parsoid in the background in the future, you must additionally install pm2 via Node.js:

<pre>npm install -g pm2</pre>

Then start Parsoid via pm2:

<pre>pm2 start /opt/parsoid/bin/server.js</pre>

Now save the pm2 process list — this adds parsoid to the pm2 services:

<pre>pm2 save</pre>

Finally, add pm2 to the system startup:

<pre># Render startup-script for a specific platform, the [platform] could be one of:
# ubuntu|centos|redhat|gentoo|systemd|darwin|amazon
pm2 startup [platform]</pre>

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

[[en:{{FULLPAGENAME}}]]
[[de:etup:Installationsanleitung/Systemvorbereitung/Linux/Parsoid]]

Setup:Installation Guide/With Installer

2021-09-30T08:04:42Z

PraktiED: Added the command lines fpr linux and windows

{{DISPLAYTITLE:Installing BlueSpice 3 with installer}}
__TOC__

==Introduction==
With BlueSpice 3, we offer the installation as a complete package with MediaWiki and BlueSpice.
This installation guide gives you step-by-step instructions to install BlueSpice.
{{Box Note|boxtype=important|Note text=If you do a fresh install of BlueSpice 3.2 it might be necessary to run update.php afterwards if you get an error.}}
{{Box Note|boxtype=note|Note text=This document only describes the steps for installing the web application itself. For the installation of extended functions such as [[Setup:Installation_Guide/Advanced/VisualEditor_Configuration|VisualEditor]] and [[Setup:Installation Guide/Advanced/ExtendedSearch Configuration|Extendedsearch]], please refer to the corresponding documentation.

We will not go into details about your operating system installation here, but assume that you have already [[Setup:Installation_Guide#Prerequesites|configured your system]] and stored the installation package in a web root of your choice, where you can access it via your browser. You can find more details in our detailed [[Setup:Installation Guide|installation guide]].

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

{{Hint
|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!
}}

{| class="wikitable"
|-
|[[File:Setup:Screenshot 12.png|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.

'''Note:''' If you don't meet all necessary requirements for PHP yet, you won't be able to view this setup page yet. Please make the necessary corrections to your PHP installation first. Otherwise, you are now on the page shown in the screenshot (click on the thumbnail to see the full screenshot).

|-
|[[File:Setup:Screenshot (213) 123.png|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|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|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|300px|BlueSpice 3 Installation Step 5]]
||'''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|300px|BlueSpice 3 Installation Step 6]]
||'''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|300x300px]]
||'''Step 7 - Options:''' In this step, you specify the e-mail address for notification e-mails.
|-
|[[File:Setup:Screenshot (220)35.png|300x300px]]
||'''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|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|300x300px]]
||'''Step 10 - Download LocalSettings.php:''' In the last step of the installation, you will be asked to download the configuration file "LocalSettings.php" of your installation. Download it and place it in the root directory of your BlueSpice codebase.
|-
|
|'''Step 11 - Rename the template folders:''' Open the folder <code>..\extensions\BluesSpiceFoundation</code> and rename the subfolder <code>config.template</code> to <code>config</code> and create the new folder <code>data</code>. These folders should have read and write access, see [[Setup:Installation Guide/Security Settings/File System Permissions|File System Permissions]].
Run the script <code>..\maintenance\update.php</code> from the console.
|-
|[[File:Setup:bs3-install-11.png|300px|BlueSpice 3 Installation Step 12]]
||'''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.
|}
Now open a command line and change to the folder <code><installpath-bluespice></code>. Run the following command:

*php maintenance/update.php ''(Linux)''
*php maintenance\update.php ''(Windows)''
{{Box Note|boxtype=note|Note text=If the page is not loading, give the group "users" change-permissions for the folder C:\Windows\Temp.}}{{Box Note|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]]

SocialEntity:6764

2021-09-30T08:04:42Z

PraktiED:

{
"wikipageid": 833,
"revisionid": 27883,
"namespace": 3008,
"titletext": "Installation Guide/With Installer",
"action": "edit",
"summary": "Added the command lines fpr linux and windows",
"parentid": 0,
"id": 6764,
"ownerid": 54,
"type": "articlesave",
"archived": false,
"tags": [],
"resolved": false
}

SocialEntity:6763

2021-09-30T08:01:57Z

PraktiED:

{
"wikipageid": 755,
"revisionid": 27881,
"namespace": 3008,
"titletext": "Installation Guide/Webservices/PDF-Export",
"action": "edit",
"summary": "Link to the instrucation for BlueSpice 3",
"parentid": 0,
"id": 6763,
"ownerid": 54,
"type": "articlesave",
"archived": false,
"tags": [],
"resolved": false
}

Setup:Installation Guide/Webservices/PDF-Export

2021-09-30T08:01:56Z

PraktiED: Link to the instrucation for BlueSpice 3

{{DISPLAYTITLE:Webservice: PDF-Export}}
__TOC__

Make sure that the [[Setup:Installation_Manual/System_Configuration/Apache_Tomcat|Apache Tomcat server]] is completely installed and configured on the BlueSpice server before setting up PDF-Export.

==Moving the BShtml2PDF Application==
Download the file "BShtml2PDF.war" from https://sourceforge.net/projects/bluespice/files/webservices/BShtml2PDF.war/download and copy it to <code><tomcat-webapps></code>

The default paths are as follows:

*C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps '''(Apache Tomcat on Windows)'''
*/var/lib/jetty9/webapps '''(Jetty on Debian)'''

Or run the command <code>sudo mv /var/www/bluespice/w/extensions/BlueSpiceUEModulePDF/webservices/BShtml2PDF.war /var/lib/jetty9/webapps</code> in the terminal.

The application usually starts automatically without the need for rebooting the application server.

==Checking the functionality==
The correct functionality of the BShtml2PDF service can be checked as follows:

On Windows, open Internet Explorer using the URL <nowiki>http://localhost:8080/BShtml2PDF</nowiki>. With correct functionality, you should see the following website:
[[File:Setup:Tomcat_Check_03.png|center|400px|Tomcat Check 03]]

==Enable PDF Export in BlueSpice==
Go to the directory <code><installpath-bluespice>/settings.d</code>. Open the file '''020-BlueSpiceUEModulePDF.php''' in a text editor.

Or open the 020-BlueSpiceUEModulePDF.php in the terminal using the command <code>sudo nano /var/www/bluespice/w/settings.d/020-BlueSpiceUEModulePDF.php</code>.

In the second line is the code to activate the extension:

return; // Disabled. Needs Tomcat

You can either add a comment character (#) to the beginning of this line or delete the line completely, save the file and exit it.

== Installing BlueSpice 3 with installer ==

# Open <code>localhost/w</code> in your Browser and follow the [[:en:Setup:Installation_Guide/With_Installer|instructions]].

Open a command line and change into the folder <code><installpath-bluespice></code>. Execute the following command:

php maintenance/update.php ''(Linux)''
php maintenance\update.php ''(Windows))''
{{Hint
|text=In Windows, make sure that the environment variables are set correctly to access the "php" command.}}
{{Hint
|text=Note that you must update the [[Setup:Installation Guide/Security Settings/File System Permissions#Assignment_of_Permissions_with_Linux|file system permissions]] after running update.php.}}

When the script is finished with the "Done" message, you have successfully isntalled the web service .

[[File:Setup:Setup_bluespice_maintenance_update.jpg|center|400x556px]]

==Troubleshooting==
If there is a problem with the PDF export in BlueSpice, first check the [[Setup:Installation Guide/Security Settings/File System Permissions|file system permissions]].
==Download Web services==
If the required war-file is missing in your installation package, you can download it here: [https://buildservice.bluespice.com/webservices3.tar.gz Webservices].

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Webservices/PDF-Export]]

Setup:Installation Guide/System Preparation/Linux/Jetty

2021-09-30T07:54:09Z

PraktiED: Added download page for bluespice and how to unzip the folder

{{DISPLAYTITLE:Jetty on Linux}}
__TOC__

{{Template:Optional|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==
{{Hint|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-3.x.x.zip file.
# Rename the folder "BlueSpice-free-3.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 to /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]]
*[[Setup:Installation Guide/Webservices/VisualDiff | VisualDiff]] (BlueSpice pro only)

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

SocialEntity:6762

2021-09-30T07:54:09Z

PraktiED:

{
"wikipageid": 4490,
"revisionid": 27879,
"namespace": 3008,
"titletext": "Installation Guide/System Preparation/Linux/Jetty",
"action": "edit",
"summary": "Added download page for bluespice and how to unzip the folder",
"parentid": 0,
"id": 6762,
"ownerid": 54,
"type": "articlesave",
"archived": false,
"tags": [],
"resolved": false
}

SocialEntity:6761

2021-09-30T07:49:01Z

PraktiED:

{
"social-profile-title": null,
"social-profile-name": null,
"social-profile-email": null,
"social-profile-department": "",
"social-profile-function": "",
"social-profile-location": "",
"social-profile-phone": "",
"description": "",
"parentid": 0,
"id": 6761,
"ownerid": 54,
"type": "profile",
"archived": false,
"tags": [
"User:PraktiED"
],
"resolved": false
}

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

2021-09-30T07:43:16Z

PraktiED: How to save bluespice.conf without rights.

{{DISPLAYTITLE:Installing Apache and PHP on Linux}}
__TOC__

{{Template:Important|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.

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

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

<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.
[[File:Setup:apache vhost bluespice free.txt|thumb]]
==Configuring Apache==
{{Template:Hint|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.

'''If you do not have rights to save:'''

# Open a text editor of your choice.
# Copy the complete contents of the following file into this new configuration file.
##Bei BlueSpice free: [[Media:Setup:apache vhost bluespice free.txt|apache_vhost_bluespice_free.txt]]
##Bei 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 as <code>bluespice.conf</code> under any file path and exit it.
# In terminal, run the command <code>sudo mv /yourfilepath/bluespice.conf /etc/apache2/sites-available</code>.

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

SocialEntity:6760

2021-09-30T07:43:16Z

PraktiED:

{
"wikipageid": 4480,
"revisionid": 27876,
"namespace": 3008,
"titletext": "Installation Guide/System Preparation/Linux/Apache and PHP",
"action": "edit",
"summary": "How to save bluespice.conf without rights.",
"parentid": 0,
"id": 6760,
"ownerid": 54,
"type": "articlesave",
"archived": false,
"tags": [],
"resolved": false
}

SocialEntity:6759

2021-09-30T07:30:15Z

PraktiED:

{
"social-profile-title": null,
"social-profile-name": null,
"social-profile-email": null,
"social-profile-department": "",
"social-profile-function": "",
"social-profile-location": "",
"social-profile-phone": "",
"description": "",
"parentid": 0,
"id": 6759,
"ownerid": 54,
"type": "profile",
"archived": false,
"tags": [
"User:PraktiED"
],
"resolved": false
}

User:PraktiED

2021-09-30T07:25:20Z

PraktiED: create user page