BlueSpice - User contributions [en]

Setup:Installation Guide/Docker

2024-11-25T12:59:45Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were some important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, nor for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has completely been reworked
If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

===Overview===
Since version 4.5, BlueSpice MediaWiki can be easily installed using a stack of Docker container images. Everything is build in a modular way to allow different types of setups.

The most common cases are
# "All-in-one" (with and without Let's Encrypt)
# Custom database and search service
# Custom load balancer / proxy

=== Step 1: Get the stack ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
! style="width:350px;" |Filename
!Type
!Mandatory
!Comment
|-
| style="width:350px;" |<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed containers
|-
| style="width:350px;" |<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also registers the service at the operating system
|-
| style="width:350px;" |<code>bluespice.service</code>
|service-script
|false
|Proper handling of the containers on reboot
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
|yml
|true
|Main application services/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
|yml
|false
|Database and search/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
|yml
|true
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
|yml
|false, but recommended
|Proxy Service
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional auto-renewal service for "Let's Encrypt" certificates
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional proxy for Kerberos based authenication
|}

For convenience, the <code>bluespice-deploy</code> script wraps the first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy \
-f docker-compose.proxy-letsencrypt.yml \
up -d

This will start the stack with "Let's Encrypt" certificates. For details, please refer to section [[#SSL certificates| SSL certificates]].

===Step 2: Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...
{{Textbox|boxtype=note|header=Different editions|text=The example shows <code>EDITION=pro</code>. Be aware that for <code>pro</code> and <code>farm</code> you need to be logged into <code>docker.bluspice.com</code>.|icon=yes}}

=== Step 3: Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots. Make sure to run this command with in a privileged user context (like <code>root</code>), as it will set permissions on the newly created directories.

=== Step 4: Start the stack ===
{{Textbox
|boxtype=important
|header=Initial installation
|text=When starting the stack the first time, the <code>wiki-task</code> container will automatically perform the installation. It may take a couple of minutes for the process to set up the database and complete. Once it is finished, the password for the default <code>Admin</code> user can be found in <code>$DATADIR/wiki/adminPasssword</code>.
|icon=yes
}}
Use <code>bluespice-deploy up -d</code> to start the stack, once the <code>.env</code> file and the "data directories" are ready. Once all containers are shown as "ready" you can navigate to <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (e.g. <code><nowiki>https://wiki.company.local</nowiki></code>) in your favorite web browser and start using the application.

=== Additional options ===

==== SSL certificates ====
For using Let's Encrypt certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

====Operating system level service====

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

==== Custom wiki application configuration ====
After the initial installation, the <code>${DATADIR}/wiki/bluespice/</code> contains two files that can be used to set custom application configuration as it may be found on [https://www.mediawiki.org mediawiki.org]:

* <code>pre-init-settings.php</code> - Can be used to set config that can be picked up by the init process
* <code>post-init-settings.php</code> - Can be used to manipulate configs that have been set by the init process

==== Custom database and search ====
If you have a MySQL/MariaDB and an OpenSearch server running in your local network, you can remove <code>docker-compose.persistent-data-services.yml</code> entirely from your <code>bluespice-deploy</code> file. Make sure to set the proper variables in the <code>.env</code> file.

====Kerberos proxy====
For implicit authenticationusing Kerberos, an additional proxy must be used: <code>bluespice/kerberos-proxy</code> . The file <code>docker-compose.kerberos-proxy.yml</code> contains a common configuration. It can be used '''instead of''' the regular <code>docker-compose.proxy.yml</code> file inside <code>bluespice-deploy</code> .

Make sure to have the files

* <code>${DATADIR}/kerberos/krb5.conf</code>
* <code>${DATADIR}/kerberos/kerberos.keytab</code>

set up properly.

The file <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> can then be used to set up [[mediawikiwiki:LDAP_hub|"Extension:Auth_remoteuser" and the LDAP stack extensions]].

====SAML authentication====

During the initial installation a certificate for message signing will automatically be created. It can be found in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

In order to configure a remote IdP, one must copy the IdP metadata XML to a file called <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code>. The SP metadata can then be obtained via <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code>. It must be configured in the remote IdP.

{{Textbox
|boxtype=tip
|header=Test authentication
|text= You can test authentication directly within the SimpleSAMLphp application. To do so, navigate to <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> and log in with <code>admin</code> and the <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> found in <code>${DATADIR}/wiki/.wikienv</code>
|icon=yes
}}

Next, the extensions "PluggableAuth" and "SimpleSAMLphp" must be enabled on the wiki. To do so, add

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>[[File:Setup:SAML ConfigManager EN 01.png|thumb|300x300px]]to the <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code>. Run

./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick

to complete the installation.

After that, the authentication plugin configuration can be applied in [[Manual:Extension/BlueSpiceConfigManager|Special:BlueSpiceConfigManager]] under "Authentication".

==== OpenID Connect authentication ====

The extensions "PluggableAuth" and "OpenIDConnect" must be enabled on the wiki. To do so, add<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>to the <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code>. Run

./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick

to complete the installation.

After that, the authentication plugin configuration can be applied in [[Manual:Extension/BlueSpiceConfigManager|Special:BlueSpiceConfigManager]] under "Authentication".

[[de:Setup:Installationsanleitung/Docker]]

Setup:Installation Guide/Docker

2024-11-25T12:57:20Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were some important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, nor for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has completely been reworked
If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

===Overview===
Since version 4.5, BlueSpice MediaWiki can be easily installed using a stack of Docker container images. Everything is build in a modular way to allow different types of setups.

The most common cases are
# "All-in-one" (with and without Let's Encrypt)
# Custom database and search service
# Custom load balancer / proxy

=== Step 1: Get the stack ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
! style="width:350px;" |Filename
!Type
!Mandatory
!Comment
|-
| style="width:350px;" |<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed containers
|-
| style="width:350px;" |<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also registers the service at the operating system
|-
| style="width:350px;" |<code>bluespice.service</code>
|service-script
|false
|Proper handling of the containers on reboot
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
|yml
|true
|Main application services/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
|yml
|false
|Database and search/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
|yml
|true
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
|yml
|false, but recommended
|Proxy Service
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional auto-renewal service for "Let's Encrypt" certificates
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional proxy for Kerberos based authenication
|}

For convenience, the <code>bluespice-deploy</code> script wraps the first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy \
-f docker-compose.proxy-letsencrypt.yml \
up -d

This will start the stack with "Let's Encrypt" certificates. For details, please refer to section [[#SSL certificates| SSL certificates]].

===Step 2: Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...
{{Textbox|boxtype=note|header=Different editions|text=The example shows <code>EDITION=pro</code>. Be aware that for <code>pro</code> and <code>farm</code> you need to be logged into <code>docker.bluspice.com</code>.|icon=yes}}

=== Step 3: Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots. Make sure to run this command with in a privileged user context (like <code>root</code>), as it will set permissions on the newly created directories.

=== Step 4: Start the stack ===
{{Textbox
|boxtype=important
|header=Initial installation
|text=When starting the stack the first time, the <code>wiki-task</code> container will automatically perform the installation. It may take a couple of minutes for the process to set up the database and complete. Once it is finished, the password for the default <code>Admin</code> user can be found in <code>$DATADIR/wiki/adminPasssword</code>.
|icon=yes
}}
Use <code>bluespice-deploy up -d</code> to start the stack, once the <code>.env</code> file and the "data directories" are ready. Once all containers are shown as "ready" you can navigate to <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (e.g. <code><nowiki>https://wiki.company.local</nowiki></code>) in your favorite web browser and start using the application.

=== Additional options ===

==== SSL certificates ====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

====Operating system level service====

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

==== Custom wiki application configuration ====
After the initial installation, the <code>${DATADIR}/wiki/bluespice/</code> contains two files that can be used to set custom application configuration as it may be found on [https://www.mediawiki.org mediawiki.org]:

* <code>pre-init-settings.php</code> - Can be used to set config that can be picked up by the init process
* <code>post-init-settings.php</code> - Can be used to manipulate configs that have been set by the init process

==== Custom database and search ====
If you have a MySQL/MariaDB and an OpenSearch server running in your local network, you can remove <code>docker-compose.persistent-data-services.yml</code> entirely from your <code>bluespice-deploy</code> file. Make sure to set the proper variables in the <code>.env</code> file.

====Kerberos proxy====
For implicit authenticationusing Kerberos, an additional proxy must be used: <code>bluespice/kerberos-proxy</code> . The file <code>docker-compose.kerberos-proxy.yml</code> contains a common configuration. It can be used '''instead of''' the regular <code>docker-compose.proxy.yml</code> file inside <code>bluespice-deploy</code> .

Make sure to have the files

* <code>${DATADIR}/kerberos/krb5.conf</code>
* <code>${DATADIR}/kerberos/kerberos.keytab</code>

set up properly.

The file <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> can then be used to set up [[mediawikiwiki:LDAP_hub|"Extension:Auth_remoteuser" and the LDAP stack extensions]].

====SAML authentication====

During the initial installation a certificate for message signing will automatically be created. It can be found in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

In order to configure a remote IdP, one must copy the IdP metadata XML to a file called <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code>. The SP metadata can then be obtained via <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code>. It must be configured in the remote IdP.

{{Textbox
|boxtype=tip
|header=Test authentication
|text= You can test authentication directly within the SimpleSAMLphp application. To do so, navigate to <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> and log in with <code>admin</code> and the <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> found in <code>${DATADIR}/wiki/.wikienv</code>
|icon=yes
}}

Next, the extensions "PluggableAuth" and "SimpleSAMLphp" must be enabled on the wiki. To do so, add

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>[[File:Setup:SAML ConfigManager EN 01.png|thumb|300x300px]]to the <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code>. Run

./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick

to complete the installation.

After that, the authentication plugin configuration can be applied in [[Manual:Extension/BlueSpiceConfigManager|Special:BlueSpiceConfigManager]] under "Authentication".

==== OpenID Connect authentication ====

The extensions "PluggableAuth" and "OpenIDConnect" must be enabled on the wiki. To do so, add<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>to the <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code>. Run

./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick

to complete the installation.

After that, the authentication plugin configuration can be applied in [[Manual:Extension/BlueSpiceConfigManager|Special:BlueSpiceConfigManager]] under "Authentication".

[[de:Setup:Installationsanleitung/Docker]]

Setup:Installation Guide/Docker

2024-11-25T12:56:09Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were some important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, nor for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has completely been reworked
If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

===Overview===
Since version 4.5, BlueSpice MediaWiki can be easily installed using a stack of Docker container images. Everything is build in a modular way to allow different types of setups.

The most common cases are
# "All-in-one" (with and without Let's Encrypt)
# Custom database and search service
# Custom load balancer / proxy

=== Step 1: Get the stack ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
! style="width:350px;" |Filename
!Type
!Mandatory
!Comment
|-
| style="width:350px;" |<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed containers
|-
| style="width:350px;" |<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also registers the service at the operating system
|-
| style="width:350px;" |<code>bluespice.service</code>
|service-script
|false
|Proper handling of the containers on reboot
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
|yml
|true
|Main application services/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
|yml
|false
|Database and search/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
|yml
|true
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
|yml
|false, but recommended
|Proxy Service
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional auto-renewal service for "Let's Encrypt" certificates
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional proxy for Kerberos based authenication
|}

For convenience, the <code>bluespice-deploy</code> script wraps the first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy \
-f docker-compose.proxy-letsencrypt.yml \
up -d

This will start the stack with "Let's Encrypt" certificates. For details, please refer to section [[#SSL certificates| SSL certificates]].

===Step 2: Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...
{{Textbox|boxtype=note|header=Different editions|text=The example shows <code>EDITION=pro</code>. Be aware that for <code>pro</code> and <code>farm</code> you need to be logged into <code>docker.bluspice.com</code>.|icon=yes}}

=== Step 3: Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots. Make sure to run this command with in a privileged user context (like <code>root</code>), as it will set permissions on the newly created directories.

=== Step 4: Start the stack ===
{{Textbox
|boxtype=important
|header=Initial installation
|text=When starting the stack the first time, the <code>wiki-task</code> container will automatically perform the installation. It may take a couple of minutes for the process to set up the database and complete. Once it is finished, the password for the default <code>Admin</code> user can be found in <code>$DATADIR/wiki/adminPasssword</code>.
|icon=yes
}}
Use <code>bluespice-deploy up -d</code> to start the stack, once the <code>.env</code> file and the "data directories" are ready. Once all containers are shown as "ready" you can navigate to <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (e.g. <code><nowiki>https://wiki.company.local</nowiki></code>) in your favorite web browser and start using the application.

=== Additional options ===

==== SSL certificates ====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

====Operating system level service====

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

==== Custom wiki application configuration ====
After the initial installation, the <code>${DATADIR}/wiki/bluespice/</code> contains two files that can be used to set custom application configuration as it may be found on [https://www.mediawiki.org mediawiki.org]:

* <code>pre-init-settings.php</code> - Can be used to set config that can be picked up by the init process
* <code>post-init-settings.php</code> - Can be used to manipulate configs that have been set by the init process

==== Custom database and search ====
If you have a MySQL/MariaDB and an OpenSearch server running in your local network, you can remove <code>docker-compose.persistent-data-services.yml</code> entirely from your <code>bluespice-deploy</code> file. Make sure to set the proper variables in the <code>.env</code> file.

====Kerberos proxy====
For implicit authenticationusing Kerberos, an additional proxy must be used: <code>bluespice/kerberos-proxy</code> . The file <code>docker-compose.kerberos-proxy.yml</code> contains a common configuration. It can be used '''instead of''' the regular <code>docker-compose.proxy.yml</code> file inside <code>bluespice-deploy</code> .

Make sure to have the files

* <code>${DATADIR}/kerberos/krb5.conf</code>
* <code>${DATADIR}/kerberos/kerberos.keytab</code>

set up properly.

The file <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> can then be used to set up "Extension:Auth_remoteuser".

====SAML authentication====

During the initial installation a certificate for message signing will automatically be created. It can be found in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

In order to configure a remote IdP, one must copy the IdP metadata XML to a file called <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code>. The SP metadata can then be obtained via <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code>. It must be configured in the remote IdP.

{{Textbox
|boxtype=tip
|header=Test authentication
|text= You can test authentication directly within the SimpleSAMLphp application. To do so, navigate to <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> and log in with <code>admin</code> and the <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> found in <code>${DATADIR}/wiki/.wikienv</code>
|icon=yes
}}

Next, the extensions "PluggableAuth" and "SimpleSAMLphp" must be enabled on the wiki. To do so, add

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>[[File:Setup:SAML ConfigManager EN 01.png|thumb|300x300px]]to the <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code>. Run

./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick

to complete the installation.

After that, the authentication plugin configuration can be applied in [[Manual:Extension/BlueSpiceConfigManager|Special:BlueSpiceConfigManager]] under "Authentication".

=== OpenID Connect authentication ===
The extensions "PluggableAuth" and "OpenIDConnect" must be enabled on the wiki. To do so, add<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>to the <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code>. Run

./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick

to complete the installation.

After that, the authentication plugin configuration can be applied in [[Manual:Extension/BlueSpiceConfigManager|Special:BlueSpiceConfigManager]] under "Authentication".

[[de:Setup:Installationsanleitung/Docker]]

Setup:Installation Guide/Docker

2024-10-30T13:50:13Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were some important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, nor for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has completely been reworked
If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

===Overview===
Since version 4.5, BlueSpice MediaWiki can be easily installed using a stack of Docker container images. Everything is build in a modular way to allow different types of setups.

The most common cases are
# "All-in-one" (with and without Let's Encrypt)
# Custom database and search service
# Custom load balancer / proxy

=== Step 1: Get the stack ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
! style="width:350px;" |Filename
!Type
!Mandatory
!Comment
|-
| style="width:350px;" |<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed containers
|-
| style="width:350px;" |<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also registers the service at the operating system
|-
| style="width:350px;" |<code>bluespice.service</code>
|service-script
|false
|Proper handling of the containers on reboot
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
|yml
|true
|Main application services/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
|yml
|false
|Database and search/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
|yml
|true
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
|yml
|false, but recommended
|Proxy Service
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional auto-renewal service for "Let's Encrypt" certificates
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional proxy for Kerberos based authenication
|}

For convenience, the <code>bluespice-deploy</code> script wrapsthe first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy \
-f docker-compose.proxy-letsencrypt.yml \
up -d

This will start the stack with "Let's Encrypt" certificates. For details, please refer to section [[#SSL certificates| SSL certificates]].

===Step 2: Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...

=== Step 3: Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots. Make sure to run this command with in a privileged user context (like <code>root</code>), as it will set permissions on the newly created directories.

=== Step 4: Start the stack ===
{{Textbox
|boxtype=important
|header=Initial installation
|text=When starting the stack the first time, the <code>wiki-task</code> container will automatically perform the installation. It may take a couple of minutes for the process to set up the database and complete. Once it is finished, the password for the default <code>Admin</code> user can be found in <code>$DATADIR/wiki/adminPasssword</code>.
|icon=yes
}}
Use <code>bluespice-deploy up -d</code> to start the stack, once the <code>.env</code> file and the "data directories" are ready. Once all containers are shown as "ready" you can navigate to <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (e.g. <code><nowiki>https://wiki.company.local</nowiki></code>) in your favorite web browser and start using the application.

=== Additional options ===

==== SSL certificates ====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

====Operating system level service====

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

==== Custom wiki application configuration ====
After the initial installation, the <code>${DATADIR}/wiki/bluespice/</code> contains two files that can be used to set custom application configuration as it may be found on [https://www.mediawiki.org mediawiki.org]:

* <code>pre-init-settings.php</code> - Can be used to set config that can be picked up by the init process
* <code>post-init-settings.php</code> - Can be used to manipulate configs that have been set by the init process

==== Custom database and search ====
If you have a MySQL/MariaDB and an OpenSearch server running in your local network, you can remove <code>docker-compose.persistent-data-services.yml</code> entirely from your <code>bluespice-deploy</code> file. Make sure to set the proper variables in the <code>.env</code> file.

====Kerberos proxy====
For implicit authenticationusing Kerberos, an additional proxy must be used: <code>bluespice/kerberos-proxy</code> . The file <code>docker-compose.kerberos-proxy.yml</code> contains a common configuration. It can be used '''instead of''' the regular <code>docker-compose.proxy.yml</code> file inside <code>bluespice-deploy</code> .

Make sure to have the files

* <code>${DATADIR}/kerberos/krb5.conf</code>
* <code>${DATADIR}/kerberos/kerberos.keytab</code>

set up properly.

The file <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> can then be used to set up "Extension:Auth_remoteuser".

====SAML authentication====

During the initial installation a certificate for message signing will automatically be created. It can be found in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

In order to configure a remote IDP, one must copy the IdP metadata XML to a file called <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code>. The SP metadata can then be obtained via <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code>. It must be configured in the remote IdP.

{{Textbox
|boxtype=tip
|header=Test authentication
|text= You can test authentication directly within the SimpleSAMLphp application. To do so, navigate to <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> and log in with <code>admin</code> and the <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> found in <code>${DATADIR}/wiki/.wikienv</code>
|icon=yes
}}

Next, the extensions "PluggableAuth" and "SimpleSAMLphp" must be enabled on the wiki. To do so, add

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>[[File:Setup:SAML ConfigManager EN 01.png|thumb|300x300px]]to the <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code>. Run

./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick

to complete the installation.

After that, the authentication plugin configuration can be applied in [[Manual:Extension/BlueSpiceConfigManager|Special:BlueSpiceConfigManager]] under "Authentication".

Setup:Installation Guide/Docker

2024-10-11T13:17:21Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were some important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, nor for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has completely been reworked
If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

===Overview===
Since version 4.5, BlueSpice MediaWiki can be easily installed using a stack of Docker container images. Everything is build in a modular way to allow different types of setups.

The most common cases are
# "All-in-one" (with and without Let's Encrypt)
# Custom database and search service
# Custom load balancer / proxy

=== Step 1: Get the stack ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
! style="width:350px;" |Filename
!Type
!Mandatory
!Comment
|-
| style="width:350px;" |<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed containers
|-
| style="width:350px;" |<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also registers the service at the operating system
|-
| style="width:350px;" |<code>bluespice.service</code>
|service-script
|false
|Proper handling of the containers on reboot
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
|yml
|true
|Main application services/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
|yml
|false
|Database and search/ run by <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
|yml
|true
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
|yml
|false, but recommended
|Proxy Service
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional auto-renewal service for "Let's Encrypt" certificates
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional proxy for Kerberos based authenication
|}

For convenience, the <code>bluespice-deploy</code> script wrapsthe first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy \
-f docker-compose.proxy-letsencrypt.yml \
up -d

This will start the stack with "Let's Encrypt" certificates. For details, please refer to section [[#SSL certificates| SSL certificates]].

===Step 2: Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...

=== Step 3: Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots.

=== Step 4: Start the stack ===
{{Textbox
|boxtype=important
|header=Initial installation
|text=When starting the stack the first time, the <code>wiki-task</code> container will automatically perform the installation. It may take a couple of minutes for the process to set up the database and complete. Once it is finished, the password for the default <code>Admin</code> user can be found in <code>$DATADIR/wiki/adminPasssword</code>.
|icon=yes
}}
Use <code>bluespice-deploy up -d</code> to start the stack, once the <code>.env</code> file and the "data directories" are ready. Once all containers are shown as "ready" you can navigate to <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (e.g. <code><nowiki>https://wiki.company.local</nowiki></code>) in your favorite web browser and start using the application.

=== Additional options ===

==== SSL certificates ====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

====Operating system level service====

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

==== Custom wiki application configuration ====
After the initial installation, the <code>${DATADIR}/wiki/bluespice/</code> contains two files that can be used to set custom application configuration as it may be found on [https://www.mediawiki.org mediawiki.org]:

* <code>pre-init-settings.php</code> - Can be used to set config that can be picked up by the init process
* <code>post-init-settings.php</code> - Can be used to manipulate configs that have been set by the init process

==== Custom database and search ====
If you have a MySQL/MariaDB and an OpenSearch server running in your local network, you can remove <code>docker-compose.persistent-data-services.yml</code> entirely from your <code>bluespice-deploy</code> file. Make sure to set the proper variables in the <code>.env</code> file.

====Kerberos proxy====
For implicit authenticationusing Kerberos, an additional proxy must be used: <code>bluespice/kerberos-proxy</code> . The file <code>docker-compose.kerberos-proxy.yml</code> contains a common configuration. It can be used '''instead of''' the regular <code>docker-compose.proxy.yml</code> file inside <code>bluespice-deploy</code> .

Make sure to have the files

* <code>${DATADIR}/kerberos/krb5.conf</code>
* <code>${DATADIR}/kerberos/kerberos.keytab</code>

set up properly.

The file <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> can then be used to set up "Extension:Auth_remoteuser".

Setup:Installation Guide/Docker

2024-10-11T13:13:30Z

WikiSysop:

Setup:Installation Guide/Docker

2024-10-11T13:01:56Z

WikiSysop: (username removed) (log details removed)

Setup:Installation Guide/Docker

2024-10-04T17:50:59Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, not for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has been reworked

If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

=== Getting the stack ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
!Filename
!Type
!Mandatory
!Comment
|-
|<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed Containers
|-
|<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also registers the service at the operating system
|-
|<code>bluespice.service</code>
|service-script
|false
|Porper handling of the Containers on reboot
|-
|<code>docker-compose.main.yml</code>
|yml
|true
|Main application services/ run by bluespice-deploy
|-
|<code>docker-compose.persistent-data-services.yml</code>
|yml
|true
|Database and Search/ run by bluespice-deploy
|-
|<code>docker-compose.stateless-services.yml</code>
|yml
|false, but strongly recommended for full functionality
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
|<code>docker-compose.proxy.yml</code>
|yml
|false but recommended
|Proxy Service
|-
|<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional auto-renewal service for "Let's Encrypt"-Certificates
|-
|<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional Proxy for Kerberos-Authenication
|}

For convenience, the <code>bluespice-deploy</code> script starts the first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy \
-f docker-compose.proxy-letsencrypt.yml \
up \
-d \
--remove-orphans

This will start the stack with "Let's Encrypt" certificates.

===Set up operating system service===

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

===Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...

===Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots.

=== Starting the stack ===
Use <code>bluespice-deploy up -d</code> to start the stack, once the <code>.env</code> file and the "data directories" are ready. Once all containers are shown as "ready" you can navigate to <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (e.g. <code><nowiki>https://wiki.company.local</nowiki></code>) in your favorite web browser.

==== Initial installation ====
When starting the container stack the first time, <code>wiki-task</code> will automatically perform the installation. It may take a couple of minutes to complete the process. Once it is finished, the password for he default <code>Admin</code> user can be found in <code>$DATADIR/wiki/adminPasssword</code>.

=== Additional options ===

==== SSL certificates ====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

Setup:Installation Guide/Docker

2024-10-04T17:49:48Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, not for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has been reworked

If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

=== Getting the stack ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
!Filename
!Type
!Mandatory
!Comment
|-
|<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed Containers
|-
|<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also registers the service at the operating system
|-
|<code>bluespice.service</code>
|service-script
|false
|Porper handling of the Containers on reboot
|-
|<code>docker-compose.main.yml</code>
|yml
|true
|Main application services/ run by bluespice-deploy
|-
|<code>docker-compose.persistent-data-services.yml</code>
|yml
|true
|Database and Search/ run by bluespice-deploy
|-
|<code>docker-compose.stateless-services.yml</code>
|yml
|false, but strongly recommended for full functionality
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
|<code>docker-compose.proxy.yml</code>
|yml
|false but recommended
|Proxy Service
|-
|<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional auto-renewal service for "Let's Encrypt"-Certificates
|-
|<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional Proxy for Kerberos-Authenication
|}

For convenience, the <code>bluespice-deploy</code> script starts the first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans

This will start the stack with "Let's Encrypt" certificates.

===Set up operating system service===

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

===Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...

===Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots.

=== Starting the stack ===
Use <code>bluespice-deploy up -d</code> to start the stack, once the <code>.env</code> file and the "data directories" are ready. Once all containers are shown as "ready" you can navigate to <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (e.g. <code><nowiki>https://wiki.company.local</nowiki></code>) in your favorite web browser.

==== Initial installation ====
When starting the container stack the first time, <code>wiki-task</code> will automatically perform the installation. It may take a couple of minutes to complete the process. Once it is finished, the password for he default <code>Admin</code> user can be found in <code>$DATADIR/wiki/adminPasssword</code>.

=== Additional options ===

==== SSL certificates ====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

Setup:Installation Guide/Docker

2024-10-04T17:46:09Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, not for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has been reworked

If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

=== Basic installation ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
!Filename
!Type
!obligatory
!Comment
|-
|<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed Containers
|-
|<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also registers the service at the operating system
|-
|<code>bluespice.service</code>
|service-script
|false
|Porper handling of the Containers on reboot
|-
|<code>docker-compose.main.yml</code>
|yml
|true
|Main Services/ run by bluespice-deploy
|-
|<code>docker-compose.persistent-data-services.yml</code>
|yml
|true
|Database and Search/ run by bluespice-deploy
|-
|<code>docker-compose.stateless-services.yml</code>
|yml
|false but strongly recommended for full functionality
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
|<code>docker-compose.proxy.yml</code>
|yml
|false but recommended
|Proxy Service
|-
|<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional autorenewal service for LetsEncrypt-Certificates
|-
|<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional Proxy for Kerberos-Authenication
|}

For convenience, the <code>bluespice-deploy</code> script starts the first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans

This will start the stack with "Let's Encrypt" certificates.

===Set up operating system service===

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

===Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...

===Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots.

=== Starting the stack ===
Use <code>bluespice-deploy up -d</code> to start the stack, once the <code>.env</code> file and the "data directories" are ready. Once all containers are shown as "ready" you can navigate to <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (e.g. <code><nowiki>https://wiki.company.local</nowiki></code>) in your favorite web browser.

==== Initial installation ====
When starting the container stack the first time, <code>wiki-task</code> will automatically perform the installation. It may take a couple of minutes to complete the process. Once it is finished, the password for he default <code>Admin</code> user can be found in <code>$DATADIR/wiki/adminPasssword</code>.

=== Additional options ===

===== SSL certificates =====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

Setup:Installation Guide/Docker

2024-09-27T15:02:12Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, not for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has been reworked

If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

=== Basic installation ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
!Filename
!Type
!obligatory
!Comment
|-
|<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed Containers
|-
|<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also registers the service at the operating system
|-
|<code>bluespice.service</code>
|service-script
|false
|Porper handling of the Containers on reboot
|-
|<code>docker-compose.main.yml</code>
|yml
|true
|Main Services/ run by bluespice-deploy
|-
|<code>docker-compose.persistent-data-services.yml</code>
|yml
|true
|Database and Search/ run by bluespice-deploy
|-
|<code>docker-compose.stateless-services.yml</code>
|yml
|false but strongly recommended for full functionality
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
|<code>docker-compose.proxy.yml</code>
|yml
|false but recommended
|Proxy Service
|-
|<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional autorenewal service for LetsEncrypt-Certificates
|-
|<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional Proxy for Kerberos-Authenication
|}

For convenience, the <code>bluespice-deploy</code> script starts the first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans

This will start the stack with "Let's Encrypt" certificates.

===Set up operating system service===

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

===Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...

===Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots.

=== Additional options ===

===== SSL certificates =====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

Setup:Installation Guide/Docker

2024-09-27T14:59:02Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, not for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has been reworked

If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

=== Basic installation ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose

The directory contains the following files:
{| class="wikitable"
|+
!Filename
!Type
!obligatory
!Comment
|-
|<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed Containers
|-
|<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also creates service
|-
|<code>bluespice.service</code>
|service-script
|false
|Porper handling of the Containers on reboot
|-
|<code>docker-compose.main.yml</code>
|yml
|true
|Main Services/ run by bluespice-deploy
|-
|<code>docker-compose.persistent-data-services.yml</code>
|yml
|true
|Database and Search/ run by bluespice-deploy
|-
|<code>docker-compose.stateless-services.yml</code>
|yml
|false but strongly recommended for full functionality
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
|<code>docker-compose.proxy.yml</code>
|yml
|false but recommended
|Proxy Service
|-
|<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional autorenewal service for LetsEncrypt-Certificates
|-
|<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional Proxy for Kerberos-Authenication
|}

For convenience, the <code>bluespice-deploy</code> script starts the first four <code>yml</code> files by default. This includes the main wiki application and also required backend services, like a database, search and application cache.

Additional services can be loaded by adding <code>-f <filename> </code>.

Example:
bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans

This will start the stack with "Let's Encrypt" certificates.

===Set up operating system service===

{{Textbox
|boxtype=tip
|header=Adding additional services
|text=expand the <code>ExecStart</code> parameter in the <code>/etc/systemd/system/bluespice.service</code>
Example:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

===Set up environment variables===
Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...

===Prepare data directories===
Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots.

=== Additional options ===

===== SSL certificates =====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

Setup:Installation Guide/Docker

2024-09-27T14:48:31Z

WikiSysop:

{{Textbox
|boxtype=important
|header=Migration from 4.4
|text=With BlueSpice 4.5 there were important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, not for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has been reworked

If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]
|icon=yes
}}

__TOC__

=== Installation ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose
{| class="wikitable"
|+
!Filename
!Type
!obligatory
!Comment
|-
|<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed Containers
|-
|<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also creates service
|-
|<code>bluespice.service</code>
|service-script
|false
|Porper handling of the Containers on reboot
|-
|<code>docker-compose.main.yml</code>
|yml
|true
|Main Services/ run by bluespice-deploy
|-
|<code>docker-compose.persistent-data-services.yml</code>
|yml
|true
|Database and Search/ run by bluespice-deploy
|-
|<code>docker-compose.stateless-services.yml</code>
|yml
|false but strongly recommended for full functionality
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
|<code>docker-compose.proxy.yml</code>
|yml
|false but recommended
|Proxy Service
|-
|<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional autorenewal service for LetsEncrypt-Certificates
|-
|<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional Proxy for Kerberos-Authenication
|}
The <code>bluespice-deploy</code> script starts the first four <code>yml</code> files by default.
% cat bluespice-deploy

docker compose \
-f docker-compose.main.yml \
-f docker-compose.persistent-data-services.yml \
-f docker-compose.stateless-services.yml \
-f docker-compose.proxy.yml \
$@
To add additional services either change script or just add them by hand:
bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -d
For <code>bluespice.service</code> please do also either expand the line in the <code>etc/systemd/system/bluespice.service</code>:
[Unit]
Description=BlueSpice-Docker startup routinie
Requires=docker.service
After=docker.service

[Service]
WorkingDirectory=<WORKDIR>
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
ExecStop=bluespice-deploy down
TimeoutStartSec=0
Restart=on-failure
StartLimitInterval=120
StartLimitBurst=2

[Install]
WantedBy=multi-user.target%

Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...

Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots.

=== Additional options ===

===== SSL certificates =====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

Setup:Installation Guide/Docker

2024-09-27T14:47:43Z

WikiSysop:

{{Textbox|boxtype=important|header=Migration from 4.4|text=With BlueSpice 4.5 there were important changes to the container portfolio:
# There are no "all-in-one" containers anymore. Neither for FREE, not for PRO and FARM editions
# The "distributed-services" setup for PRO and FARM edition has been reworked

If you are upgrading from one of the above-mentioned setups, please refer to the [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|migration guide]]|icon=yes}}

=== Installation ===
Get "docker-compose" files from https://bluespice.com/de/download/
wget <nowiki>https://bluespice.com/filebase/docker-deployment-script</nowiki> \
&& unzip docker-deployment-script \
&& cd docker-deployment-script/compose
{| class="wikitable"
|+
!Filename
!Type
!obligatory
!Comment
|-
|<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper for general start-up of needed Containers
|-
|<code>bluespice-prepare</code>
|bash-script
|false
|Prepare Folder and Permissions before first start also creates service
|-
|<code>bluespice.service</code>
|service-script
|false
|Porper handling of the Containers on reboot
|-
|<code>docker-compose.main.yml</code>
|yml
|true
|Main Services/ run by bluespice-deploy
|-
|<code>docker-compose.persistent-data-services.yml</code>
|yml
|true
|Database and Search/ run by bluespice-deploy
|-
|<code>docker-compose.stateless-services.yml</code>
|yml
|false but strongly recommended for full functionality
|PDF-Renderer/Cache/Formula/Diagram-Service
|-
|<code>docker-compose.proxy.yml</code>
|yml
|false but recommended
|Proxy Service
|-
|<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Additional autorenewal service for LetsEncrypt-Certificates
|-
|<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Additional Proxy for Kerberos-Authenication
|}
The <code>bluespice-deploy</code> script starts the first four <code>yml</code> files by default.
% cat bluespice-deploy

docker compose \
-f docker-compose.main.yml \
-f docker-compose.persistent-data-services.yml \
-f docker-compose.stateless-services.yml \
-f docker-compose.proxy.yml \
$@
To add additional services either change script or just add them by hand:
bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -d
For <code>bluespice.service</code> please do also either expand the line in the <code>etc/systemd/system/bluespice.service</code>:
[Unit]
Description=BlueSpice-Docker startup routinie
Requires=docker.service
After=docker.service

[Service]
WorkingDirectory=<WORKDIR>
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
ExecStop=bluespice-deploy down
TimeoutStartSec=0
Restart=on-failure
StartLimitInterval=120
StartLimitBurst=2

[Install]
WantedBy=multi-user.target%

Create <code>.env</code> file according to existing or state-to-be installation.

Example:
DATADIR=/data/bluespice
VERSION=4.5
EDITION=pro
BACKUP_HOUR=04

WIKI_NAME=BlueSpice
WIKI_LANG=en
WIKI_PASSWORDSENDER=no-reply@wiki.company.local
WIKI_EMERGENCYCONTACT=no-reply@wiki.company.local
WIKI_HOST=wiki.company.local
WIKI_PORT=443
WIKI_PROTOCOL=https

DB_USER=bluespice
DB_PASS=...
DB_HOST=database
DB_NAME=bluespice
DB_PREFIX=

SMTP_HOST=mail.company.local
SMTP_PORT=25
SMTP_USER=...
SMTP_PASS=...
SMTP_ID_HOST=...

Run <code>bluespice-prepare</code> script, helping you set up correct folder structure and permissions. Also installing a service for proper handling of the containers on reboots.

=== Additional options ===

===== SSL certificates =====
For using Let's Encrypt Certificates just add <code>docker-compose.proxy-letsencrypt.yml</code> in your <code>bluespice-deploy</code> file.

{{Textbox
|boxtype=tip
|header=Self-signed certificates
|text=For using self-signend Certificates please put <code><bluespice-wiki.com>.crt</code> and <code><bluespice-wiki.com>.key</code> with the exact name of your Wikis URL in <code>${VOLUMES_DIR}/nginx/certs</code>
|icon=yes
}}

If activating SSL after first creation of wiki please change <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

to <code><nowiki>https://bluespice-wiki.com</nowiki></code>

also link your certificate to the bluespice-container in your <code>docker-compose.yml</code>-File:

<code>- ${VOLUMES_DIR}/nginx/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Please restart containers after changing/adding SSL files.

Setup:Installation Guide/Docker/Migration 4.4 to 4.5

2024-07-24T07:15:35Z

WikiSysop:

== BlueSpice FREE "all-in-one" ==
===Data===
Data has been stored in the directory referenced by <code>WIKI_INSTALL_DIR</code>. Now <code>DATADIR</code> is used.
{| class="cuscosky"
|+
!OLD (<code>bluespice/bluespice-free</code> 4.4)
!NEW (<code>bluespice-deploy/composer</code> 4.5)
!Comment
|-
|<code>$WIKI_INSTALL_DIR/logs/</code>
| -
|Obsolete. New containers log everything to <code>stderr</code> / <code>stdout</code>
|-
|<code>$WIKI_INSTALL_DIR/www/bluespice/w/images/</code>
|<code>$DATADIR/bluespice/images/</code>
|
|-
|<code>$WIKI_INSTALL_DIR/www/bluespice/w/cache/</code>
|
|Obsolete. Cache folder has no persistent data
|-
|<code>$WIKI_INSTALL_DIR/www/bluespice/w/extensions/BlueSpiceFoundation/config/</code>
| -
|Obsolete. All contents of this directory have been migrated to the database in <code>4.4</code> already.
|-
|<code>$WIKI_INSTALL_DIR/www/bluespice/w/extensions/BlueSpiceFoundation/data/</code>
|<code>$DATADIR/bluespice/extensions/BlueSpiceFoundation/data/</code>
|
|}

===Settings===
Data have been stored in the directory referenced by <code>WIKI_INSTALL_DIR</code>.
{| class="cuscosky"
|+
!OLD (<code>bluespice/bluespice-free</code> 4.4)
!NEW (<code>bluespice-deploy/composer</code> 4.5)
!Comment
|-
|<code>$WIKI_INSTALL_DIR/www/bluespice/w/LocalSettings.php</code>
|
*<code>$DATADIR/bluespice/pre-init-settings.php</code>
*<code>$DATADIR/bluespice/post-init-settings.php</code>
| Custom settings must be split up and added to those new files manually.
|}

==BlueSpice PRO "all-in-one"==
===Data===
Data has been stored in the directory referenced by <code>VOLUMES_DIR</code>. Now <code>DATADIR</code> is used.
{| class="cuscosky"
!OLD (<code>bluespice/bluespice-pro</code> 4.2 and 4.3)
!NEW (<code>bluespice-deploy/composer</code> 4.5)
!Comment
|-
|<code>$VOLUMES_DIR/logs/</code>
| -
|Obsolete. New containers log everything to <code>stderr</code> / <code>stdout</code>
|-
|<code>$VOLUMES_DIR/bluespice/images/</code>
|<code>$DATADIR/wiki/bluespice/images/</code>
|
|-
|<code>$VOLUMES_DIR/bluespice/cache/</code>
|
|Obsolete. Cache folder has no persistent data
|-
|<code>$VOLUMES_DIR/bluespice/extensions/BlueSpiceFoundation/config/</code>
| -
|Obsolete. All contents of this directory have been migrated to the database in <code>4.4</code> already. ATTENTION: needs migration
|-
|<code>$VOLUMES_DIR/bluespice/extensions/BlueSpiceFoundation/data/</code>
|<code>$DATADIR/wiki/bluespice/extensions</code><code>/BlueSpiceFoundation/data/</code>
|
|-
|<code>$VOLUMES_DIR/backup</code>
|<code>$DATADIR/wiki/backup</code>
|
|-
|<code>$VOLUMES_DIR/etc</code>
| -
|Obsolete
|-
|<code>$VOLUMES_DIR/mysql</code>
|<code>$DATADIR/database/data and</code> <code>$DATADIR/database/logs</code>
|No direct copy possible
|-
|<code>$VOLUMES_DIR/ssl</code>
|<code>$DATADIR/proxy/certs</code>
|Name CRT and Key file after URL:
wiki.example.com.crt/wiki.example.com.key
|-
|<code>$VOLUMES_DIR/postfix</code>
| -
|Obsolete. Fill in MailConfig in .env (SMTP*)
|-
|<code>$VOLUMES_DIR/startup</code>
| -
|Obsolete
|-
|<code>$VOLUMES_DIR/kerberos</code>
|<code>$DATADIR/kerberos</code>
|<code>Move $VOLUMES_DIR/etc/bluespice/bluespice.keytab here and rename it kerberos.keytab</code>
|}

Additional for Farm:

{| class="cuscosky"
!OLD (<code>bluespice/bluespice-farm</code> 4.2 and 4.3)
!NEW (<code>bluespice-deploy/composer</code> 4.5)
!Comment
|-
|<code>$VOLUMES_DIR/bluespice/_sf_instances/</code>
| <code>$DATADIR/wiki/bluespice/_sf_instances/</code>
|
|-
|<code>$VOLUMES_DIR/bluespice/_sf_archive</code>
|<code>$DATADIR/wiki/bluespice/_sf_archive</code>
|
|}

===Settings===
{| class="cuscosky"
!OLD (<code>bluespice/bluespice-pro</code> 4.4)
!NEW (<code>bluespice-deploy/composer</code> 4.5)
!Comment
|-
|<code>$VOLUMES_DIR/bluespice/LocalSettings.php</code>
|
*<code>$DATADIR/bluespice/pre-init-settings.php</code>
*<code>$DATADIR/bluespice/post-init-settings.php</code>
|Fill in .env wiht relevant data. LocalSettings.php is not longer in use
Custom settings must be split up and added to those new files manually.
|-
|<code>$VOLUMES_DIR/bluespice/settings.php</code>
|
*<code>$DATADIR/bluespice/pre-init-settings.php</code>
*<code>$DATADIR/bluespice/post-init-settings.php</code>
|Custom settings must be split up and added to those new files manually.
|}

==BlueSpice PRO "distributed-services"==
===Data===
{| class="cuscosky"
!OLD (<code>bluespice/bluespice-pro</code> 4.2 and 4.3)
!NEW (<code>bluespice-deploy/composer</code> 4.5)
!Comment
|-
|<code>$VOLUMES_DIR/logs/</code>
| -
|Obsolete. New containers log everything to <code>stderr</code> / <code>stdout</code>
|-
|<code>$VOLUMES_DIR/bluespice/images/</code>
|<code>$DATADIR/wiki/bluespice/images/</code>
|
|-
|<code>$VOLUMES_DIR/bluespice/cache/</code>
|
|Obsolete. Cache folder has no persistent data
|-
|<code>$VOLUMES_DIR/bluespice/extensions/BlueSpiceFoundation/config/</code>
| -
|Obsolete. All contents of this directory have been migrated to the database in <code>4.4</code> already.
'''ATTENTION: might migration'''
|-
|<code>$VOLUMES_DIR/bluespice/extensions/BlueSpiceFoundation/data/</code>
|<code>$DATADIR/wiki/bluespice/extensions</code><code>/BlueSpiceFoundation/data/</code>
|
|-
|<code>$VOLUMES_DIR/backup</code>
|<code>$DATADIR/wiki/backup</code>
|
|-
|<code>$VOLUMES_DIR/mariadb/data</code>
|<code>$DATADIR/database/data</code>
|
|-
|<code>$VOLUMES_DIR/mariadb/logs</code>
|<code>$DATADIR/database/logs</code>
|
|-
|<code>$DATADIR/proxy/certs</code>
|<code>$DATADIR/proxy/certs</code>
|Name CRT and Key file after URL:

* <code>wiki.example.com.crt</code>

* <code>wiki.example.com.key</code>
|-
|<code>$VOLUMES_DIR/kerberos</code>
|<code>$DATADIR/kerberos</code>
|
|}

Additional for Farm:

{| class="cuscosky"
!OLD (<code>bluespice/bluespice-farm</code> 4.2 and 4.3)
!NEW (<code>bluespice-deploy/composer</code> 4.5)
!Comment
|-
|<code>$VOLUMES_DIR/bluespice/_sf_instances/</code>
| <code>$DATADIR/wiki/bluespice/_sf_instances/</code>
|
|-
|<code>$VOLUMES_DIR/bluespice/_sf_archive</code>
|<code>$DATADIR/wiki/bluespice/_sf_archive</code>
|
|}

===Settings===
{| class="cuscosky"
!OLD (<code>bluespice/bluespice-pro</code> 4.4)
!NEW (<code>bluespice-deploy/composer</code> 4.5)
!Comment
|-
|<code>$VOLUMES_DIR/bluespice/LocalSettings.php</code>
|
*<code>$DATADIR/bluespice/pre-init-settings.php</code>
*<code>$DATADIR/bluespice/post-init-settings.php</code>
|Fill in .env wiht relevant data. <code>LocalSettings.php</code> is not longer in use
Custom settings must be split up and added to those new files manually.
|-
|<code>$VOLUMES_DIR/bluespice/settings.php</code>
|
*<code>$DATADIR/bluespice/pre-init-settings.php</code>
*<code>$DATADIR/bluespice/post-init-settings.php</code>
|Custom settings must be split up and added to those new files manually.
|}

Setup:Installation Guide/Advanced/Server configuration for CollabPads

2024-07-08T07:00:39Z

WikiSysop:

{{BSVersion|bsvFrom=4.5|bsvFeature=CollabPads}}

Simultaneous editing of pages by multiple users requires some server preparation. For this, MongoDB and the CollabPadsBackendService must be installed.
==Install MongoDB==
Please install MongoDB [https://www.mongodb.com/docs/manual/administration/install-on-linux/ according to the documentation your Linux distribution.] It can then be started and configured for auto start like this:
sudo systemctl start mongod
sudo systemctl enable mongod
==Install php-mongodb extension==
The CollabPadsBackend service required a special PHP extension in order to be able to communicate with the MongoDB server. This extension is available through [https://pecl.php.net/ PECL]. If you don't have PECL installed already, you can do this for example using
sudo apt install php-devel
sudo pecl install mongodb
Check the path of your PHP version to find the proper INI file. The extension can then be enabled e.g. via
echo "extension=mongodb.so" >> /etc/php/8.2/cli/php.ini
==Install CollabPadsBackendService==
The CollabPadsBackendService is pre-buildt a PHP application that can be downloaded from [https://buildservice.bluespice.com/webservices/4.5.x/CollabPadsBackend.tar.gz buildservice.bluespice.com]. You can download it like this:
cd /opt
wget <nowiki>https://buildservice.bluespice.com/webservices/4.5.x/CollabPadsBackend.tar.gz</nowiki>
tar xzf CollabPadsBackend.tar.gz
To configure the service one must first create a <code>config.php</code> file. An example file is included.
cd CollabPadsBackend
cp config.example.php config.php
vim config.php
Modify <code>config.php`</code> to match your environment. Example:
<?php

return [
'server-id' => 'mediawiki-collabpads-backend',
'ping-interval' => 25000,
'ping-timeout' => 5000,
'port' => 8099, //The port you wish to use
'request-ip' => '127.0.0.1', //The ip you want to open your service
'baseurl' => '<nowiki>https://yourwikiurl.com'</nowiki>,
'db-type' => 'mongo',
'db-host' => '127.0.0.1', // your MongoDB-Host
'db-port' => 27017, // your MongoDB-Port
'db-name' => 'collabpads', // your MongoDB-DB-Name
'db-user' => <nowiki>''</nowiki>, // MongoDB-Username
'db-password' => <nowiki>''</nowiki>, // MongoDB-Password
'log-level' => 'INFO',
'http-client-options' => []
];
Next you should create a proper servicedescriptor for running the application
sudo vim /etc/systemd/system/collabpad.service
Example of <code>collabpad.service</code>:
[Unit]
Description = BlueSpice-CollabpadsBackend
[Service]
Type = simple
User = www-data
ExecStart =/usr/bin/php /opt/CollabpadsBackend/bin/server.php
StandardOutput = file:/var/log/apache2/collabpad.log
[Install]
WantedBy = default.target
Start and configure the service for auto start like this:
sudo systemctl enable collabpad.service
sudo systemctl start collabpad.service
==Configure Apache==
The new service must be reachable by the client. By default the wiki application will try to connect to it using the WebSocket protocol on the <code>/_collabpads</code> subpath relative to the wiki application base URL (<code>$wgServer</code> ).

In order to achieve this, you must add a proper ''URL rewrite'' rule. For the Apache Webserver it looks like this:
RewriteCond %{REQUEST_URI} ^/_collabpads [NC]
RewriteCond %{QUERY_STRING} transport=websocket [NC]
RewriteRule /(.*) ws://127.0.0.1:8099/$1 [P,L]
The webserver needs to be restarted to load the changes:
systemctl restart apache2
You should now be able to use the editing mode ''Edit together''.
[[File:CP edit together.png|alt=Dropdown menu for the edit button with menu item 'Edit together'|center|thumb|206x206px|Edit together]]

[[de:Setup:Installationsanleitung/Kompendium/Servereinrichtung_für_CollabPads]]

How to debug

2024-05-02T08:11:27Z

WikiSysop:

==Help others to help you==
Sometimes things go wrong. In many cases the user is then confronted with cryptic or no error messages at all. This page provides help about getting more information about what exactly went wrong, so it can be fixed quickly. This is especially important when asking for help on locations like [https://community.bluespice.com community.bluespice.com].

Additional information can also be found at [[mediawikiwiki:Manual:How_to_debug|"Manual:How to debug" on MediaWiki.org]].

{{Textbox|boxtype=warning|header=Check for sensitive information|text=Most of the techniques described here will output very detailed information about the error, but also about the system and the context. The output may contain sensitive information like usernames, passwords, pathes, access-keys and many more. Before posting any information retrieved by this kind of debugging on a public location (like [https://community.bluespice.com community.bluespice.com]), make sure to redact all potential sensitive information!|icon=yes}}

== Generic information ==
In general it is a good idea to provide additional context information about the error. Usually this information is easily to access/gather by the one who reports an error and very valueable to anyone trying to help.

Such information can be
* Browser used (Firefox, Chrome, Edge, ...), ideally with the version
* URLs (which page the error occurs on, additional parameters that may play into the error)
* User permission level or role (admin, reader, editor, reviewer, ...)

Again: Be careful if the shared information contains sensible data and redact it if required.

== Server side debugging ==
There are various ways to get more information about errors by changing some configuration on the server side.

=== Wiki application ===

==== Enable detailed error reporting ====
Within you <code>LocalSettings.php</code> file, please add the following lines:<syntaxhighlight lang="php">
$GLOBALS['wgDebugDumpSql'] = true;
$GLOBALS['wgShowExceptionDetails'] = true;

</syntaxhighlight>This will turn error messages like <code>internal_api_error_DBQueryError</code> into a more detailed stack of program calls, including database queries and responses.

==== General debug log ====
Sometimes it can be useful to see all debugging information the application produces. To enable this general debug log please add the following lines within you <code>LocalSettings.php</code> file:<syntaxhighlight lang="php">
if ( isset( $_GET['dodebuglog'] ) ) {
$GLOBALS['wgDebugLogFile'] = "$IP/cache/debug.log";
}

</syntaxhighlight>Be aware that this configuration is set conditionally. It will only be used if the URL accessed in the browser contains some query string like <code>dodebuglog=1</code>. This is to allow a more isolated debug log file. Otherwise other requests (like calls to the <code>load.php</code> entrypoint for CSS and JS content) may also add into this file, which makes analysis more difficult.

===== Important log channels =====
{{Textbox|boxtype=important|header=Channel names must be ''exactly'' like listed here! Watch out for casing and spaces!|text=|icon=yes}}
{| class="wikitable"
!Source (Extension)
!Channel name(s)
!Use case
|-
|MW CORE
|<code>http</code>, <code>HttpError</code>
<code>JobExecutor</code>

<code>LocalFile</code>

<code>exception</code>

<code>DeferredUpdates</code>

<code>Parsoid</code>

<code>resourceloader</code>

<code>runJobs</code>

<code>session</code>, <code>login</code>

...
|
|-
|MWSTAKE COMPONENTS
|<code>ContentProvisioner</code>
<code>runjobs-trigger-runner</code>
|
|-
|Math
|<code>Math</code>
|Math
|-
|PluggableAuth
|<code>PluggableAuth</code>
|LDAP, SAML, OpenIDConnect
|-
|LDAPProvider
|<code>LDAP</code>
<code>MediaWiki\\Extension\\LDAPProvider\\Client</code>
|LDAP
|-
|LDAPAuthentication2
|<code>LDAPAuthentication2</code>
|LDAP
|-
|LDAPGroups
|<code>LDAPGroups</code>
|LDAP
|-
|LDAPUserInfo
|<code>LDAPUserInfo</code>
|LDAP
|-
|LDAPSyncAll
|<code>LDAPSyncAll</code>
|LDAP
|-
|LDAPAuthorization
|<code>LDAPAuthorization</code>
|LDAP
|-
|Auth_remoteuser
|<code>session</code>
|LDAP (SSO/Kerberos)
|-
|SimpleSAMLphp
|<code>SimpleSAMLphp</code>
|SAML
|-
|OpenIDConnect
|<code>OpenID Connect</code>
|OpenIDConnect
|-
|ImportOfficeFiles
|<code>ImportOfficeFiles</code>
<code>ImportOfficeFiles_RemoveOrphanedDirectories</code>

<code>ImportOfficeFiles_UI</code>
|
|-
|Workflows
|<code>workflows</code>
|
|-
|BlueSpiceArticlePreviewCapture
|<code>ArticlePreviewCapture</code>
|
|-
|OAuth
|<code>OAuth</code>
|
|-
|BlueSpiceUEModulePDF, BlueSpiceUEModuleBookPDF
|<code>BS::UEModulePDF</code>
|PDF
|-
|BlueSpiceExtendedSearch
|<code>BSExtendedSearch</code>
|Search
|-
|BlueSpiceWikiFarm
|<code>SimpleFarmerAPI</code>
|Farm operations
|}

=== Clientside output of serverside logs ===
Can be enabled using [[mediawikiwiki:Manual:$wgDebugToolbar|$wgDebugToolbar]]

Example:<syntaxhighlight lang="php">
$GLOBALS['wgDebugToolbar'] = isset( $_GET['dodebugtoolbar'] )
</syntaxhighlight>

With this setting you can append <code>?dodebugtoolbar=1</code> to the URL in the addressbar of your browser.

<gallery>
File:How to debug DebugToolbar1.png
File:How to debug DebugToolbar2.png
File:How to debug DebugToolbar3.png
File:How to debug DebugToolbar4.png
</gallery>

{{Textbox|boxtype=important|header=Incompatible with <code>$bsgDebugLogGroups</code>!|text=If you have any debug log channel wired via <code>$bsgDebugLogGroups</code> the clientside debug toolbar will not show all information. Some panels may be empty.|icon=yes}}

== Client side debugging ==
Many errors occur only on the client and server side debugging will not help. In such cases the webbrowser can be used to retrieve more information.

=== Browser development tools ===
Most modern browsers have sophisticated development tools. Usually they can be accessed by pressing the <code>F12</code> key on the keyboard.

==== JavaScript console ====
When some interface element (button, dialog, ...) does not behave like it should, it is usually worth checking the browsers JavaScript console.

{{Textbox|boxtype=tip|header=Nothing listed?|text=Sometimes it may be required to re-do the action that lead to the error with ''open console'' rather than opening it later.}}

'''Example:'''

[[File:How_to_debug_JS_console_01.png|center|frame]]

One can click the link on the right side of the line to see the location of where the error has emerged from.

'''Example:'''

[[File:How_to_debug_JS_console_02.png|center|frame]]

====Network panel====
Sometimes network communication in the background of the application fails. In such cases, the "Network" panel of the browsers developer tools may reveal more information.

The error is also shown in the "Console" tab.

'''Example:'''

[[File:How_to_debug_Network_panel_01.png|center|frame]]

When in the "Network" panel, one can select the faulty request from the list to get more information.

'''Example:'''

[[File:How_to_debug_Network_panel_02.png|center|frame]]

The various tabs "Header", "Payload", "Response", etc. can provide useful information. When reporting such an issue, you can just "copy" the information using the context menu.

'''Example:'''

[[File:How_to_debug_Network_panel_03.png|center|frame]]

File:How to debug DebugToolbar4.png

2024-05-02T08:10:01Z

WikiSysop:

File:How to debug DebugToolbar3.png

2024-05-02T08:09:22Z

WikiSysop:

File:How to debug DebugToolbar2.png

2024-05-02T08:08:29Z

WikiSysop:

File:How to debug DebugToolbar1.png

2024-05-02T08:07:48Z

WikiSysop:

Archive:Setup:Installation Guide/With Installer

2024-03-21T08:32:02Z

WikiSysop:

== 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.39 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]]. Note: Since BlueSpice 4.3.0, <code>config.template</code> directory no longer exists, so step of renaming it should be skipped
#Run <code>php <installpath-bluespic</code><code>e></code><code>\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]]

Archive:Setup:Installation Guide/Advanced/Backup

2024-03-07T07:31:51Z

WikiSysop:

=== Manual backup ===

==== Backup of the database ====
To back up your database, use the native program <code>mysqldump</code> of MySQL/MariaDB: Open a console, switch to the directory <code><installpath-bluespice></code> and backup your database with the following command:
mysqldump -u <username> -p --lock-tables <database> > database.sql
For <code><username></code> , use the administrative database user, and for <code><database></code> , use the database of your MediaWiki/BlueSpice installation.

{{Textbox|boxtype=important|header=|text=On Windows, make sure that your environment variables are set correctly, so that you can access the command <code>mysqldump</code>.|icon=yes}}

==== Backup of the file system ====
Back up the complete directory <code><installpath-bluespice></code>, which now also includes the database image, to a different location on your server.

'''For security reasons, immediately delete the file<code><installpath-bluespice>/database.sql</code>, since it can be accessed from the browser.'''

=== Using the <code>mediawiki-adm</code> tool ===
To eas backup and restore one can also use the <code>mediawiki-adm</code> tool. It can be downloaded here: https://github.com/hallowelt/misc-mediawiki-adm

'''Example usage:'''
mediawiki-adm wiki-backup \
--mediawiki-root <installpath-bluespice> \
--dest /mnt/backup/
The tool will leave out all unnecessary data (like temporary files and cache database tables)and produce much smaller backup files that the manual method described above. It also allows to create versioned backups.

Archive:Setup:Installation Guide/Webservices/Mathoid

2024-01-10T15:28:45Z

WikiSysop:

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://buildservice.bluespice.com/webservices/REL1_39-4.3.x/mathoid.tar.gz or https://buildservice.bluespice.com/webservices/REL1_39-4.3.x/mathoid.zip|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>

{{Textbox
|boxtype=neutral
|header=PDF-Export integration
|text=The PDF-Export does not support SVGs at the moment. Therefore the SVG needs to be converted into a PNG when embedded into a PDF. This is done automatically, but requires <code>$wgSVGConverter</code> to be set up properly. It is recommended to use <code>rsvg</code> as a converter. On Debian based linux environments it can be installed with

apt install librsvg2-bin

In the <code>LocalSettings.php</code> file it must be configured with

$GLOBALS['wgSVGConverter'] = 'rsvg';
|icon=yes
}}

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

Archive:Setup:Installation Guide/Advanced/Backup

2023-08-03T15:15:12Z

WikiSysop:

===Backup of the database===
To back up your database, use the native program "mysqldump" of MySQL/MariaDB: Open a console, switch to the directory <code><installpath-bluespice></code> and backup your database with the following command:
mysqldump -u <username> -p --lock-tables <database> > database.sql
For <code><username></code> , use the administrative database user, and for <code><database></code> , use the database of your MediaWiki/BlueSpice installation.
{{Messagebox|boxtype=Hint|Note text=In Windows, make sure that your environment variables are set correctly, so that you can access the command "mysqldump".}}
===Backup of the file system===
Back up the complete directory <code><installpath-bluespice></code>, which now also includes the database image, to a different location on your server.

'''For security reasons, immediately delete the file<code><installpath-bluespice>/database.sql</code>, since it can be accessed from the browser.'''

Template:Messagebox

2023-08-03T15:14:55Z

WikiSysop:

<includeonly><templatestyles src="Messagebox/styles.css" /><div class="hw-messagebox notification-{{{boxtype}}} {{#switch: {{{icon}}}|yes=icon|ja=icon}}" {{#if:{{{bgcolor|}}}|style="background:{{{bgcolor}}}"|}}>{{#switch: {{{boxtype}}} | note = Note: | Hinweis = Hinweis: | Hint = Hint: | tip = Tip: | Tipp = Tipp: | warning = Warning! | Warnung = Achtung! | example = Example: | Beispiel = Beispiel: | important = Important! | Wichtig = Wichtig! | neutral = | Neutral = }}{{{Note text}}}</div></includeonly>
<noinclude>
Kopiervorlage:
<pre>
{{Messagebox|boxtype = |Note text =| bgcolor =}}
</pre>
<templatedata>
{
"params": {
"Note text": {
"required": true,
"label": {
"de": "Text"
}
},
"boxtype": {
"example": {
"en": "note, tip, warning, important, example, neutral",
"de": "Hinweis, Tipp, Wichtig, Warnung, Beispiel, Neutral"
},
"type": "string",
"default": "Hint",
"required": true,
"label": {
"de": "Art von Box",
"en": "Type of box"
},
"description": {
"en": "note, tip, warning, important, example, neutral",
"de": "Hinweis, Tipp, Wichtig, Warnung, Beispiel, Neutral"
}
},
"bgcolor": {
"label": {
"de": "Hintergrundfarbe",
"en": "Background color"
},
"description": {
"en": "Background color for neutral box in hex-format (#ececec)",
"de": "Hintergrundfarbe für neutrale Box in Hex-format (#ececec)"
},
"type": "string",
"example": "#ececec",
"suggested": true
},
"icon": {
"label": {
"en": "Show icon",
"de": "Symbol anzeigen"
},
"description": {
"en": "Shows icon before the label",
"de": "Zeigt ein passendes Symbol "
},
"example": {
"en": "yes, no",
"de": "ja, nein"
},
"suggested": true
}
},
"description": {
"de": "Infobox für Hinweise, Warnungen, Tipps, etc.",
"en": "Infobox for notes, warnings, tips, etc."
},
"paramOrder": [
"boxtype",
"icon",
"Note text",
"bgcolor"
]
}
</templatedata>
</noinclude>

Archive:Setup:Installation Guide/Advanced/Backup

2023-08-03T11:45:45Z

WikiSysop:

===Backup of the database===
To back up your database, use the native program "mysqldump" of MySQL/MariaDB: Open a console, switch to the directory <code><installpath-bluespice></code> and backup your database with the following command:
mysqldump -u <username> -p --lock-tables <database> > database.sql
For <code><username></code> , use the administrative database user, and for <code><database></code> , use the database of your MediaWiki/BlueSpice installation.
{{Messagebox|boxtype=Hinweis|Note text=In Windows, make sure that your environment variables are set correctly, so that you can access the command "mysqldump".}}
===Backup of the file system===
Back up the complete directory <code><installpath-bluespice></code>, which now also includes the database image, to a different location on your server.

'''For security reasons, immediately delete the file<code><installpath-bluespice>/database.sql</code>, since it can be accessed from the browser.'''

Archive:Setup:Installation Guide/Advanced/Backup

2023-08-03T11:41:36Z

WikiSysop:

===Backup of the database===
To back up your database, use the native program "mysqldump" of MySQL/MariaDB: Open a console, switch to the directory <code style="box-sizing: inherit; font-family: monospace, Courier; font-size: 13.5px; padding: 1px 4px; color: black; background-color: rgb(249, 249, 249); border-radius: 2px; border: 1px solid rgb(221, 221, 221);"><installpath-bluespice></code> and backup your database with the following command:
mysqldump -u <username> -p --lock-tables <database> > database.sql
For <code style="box-sizing: inherit; font-family: monospace, Courier; font-size: 13.5px; padding: 1px 4px; color: black; background-color: rgb(249, 249, 249); border-radius: 2px; border: 1px solid rgb(221, 221, 221);"><username></code> , use the administrative database user, and for <code style="box-sizing: inherit; font-family: monospace, Courier; font-size: 13.5px; padding: 1px 4px; color: black; background-color: rgb(249, 249, 249); border-radius: 2px; border: 1px solid rgb(221, 221, 221);"><database></code> , use the database of your MediaWiki/BlueSpice installation.
{{Messagebox|boxtype=Hinweis|Note text=In Windows, make sure that your environment variables are set correctly, so that you can access the command "mysqldump".}}
===Backup of the file system===
Back up the complete directory <code style="box-sizing: inherit; font-family: monospace, Courier; font-size: 13.5px; padding: 1px 4px; color: black; background-color: rgb(249, 249, 249); border-radius: 2px; border: 1px solid rgb(221, 221, 221);"><installpath-bluespice></code>, which now also includes the database image, to a different location on your server.

'''For security reasons, immediately delete the file<code style="box-sizing: inherit; font-family: monospace, Courier; font-size: 13.5px; padding: 1px 4px; color: black; background-color: rgb(249, 249, 249); border-radius: 2px; border: 1px solid rgb(221, 221, 221);"><installpath-bluespice>/database.sql</code>, since it can be accessed from the browser.'''

Setup:Installation Guide/Advanced/Maintenance scripts/CreatePDF

2023-06-14T12:00:11Z

WikiSysop:

== Running the script ==
The script to export wiki pages to PDF is executed from: <syntaxhighlight lang="text">
php {MW_ROOT}/extensions/BlueSpiceUniversalExport/maintenance/export.php --specification-file=spec.json
</syntaxhighlight>The specification file <code>spec.json</code> can have the following content:<syntaxhighlight lang="text">
{
"module": "pdf",
"attachments": 1,
"recursive": 1,
"title": "MyPDF",
"target": "localfilesystem",
"target-file-name": "All.pdf",
"target-file-path": "/path/to/target-file"
}
</syntaxhighlight>
{| class="wikitable" style="width: 100%;"
|+
! style="width:200px;" |Key
! style="width:200px;" |Value
!Description
|-
| style="width:200px;" |module
| style="width:200px;" |pdf
|Output type
|-
| style="width:200px;" |attachments
| style="width:200px;" |1
0
|Attachments will be included in the export
|-
| style="width:200px;" |recursive
| style="width:200px;" |1
0
|Linked pages (one level deep) will be included.
|-
| style="width:200px;" |title
| style="width:200px;" |string
|Title of the wiki page that contains the list of pages to be exported. '''The pages need to be links.'''
|-
| style="width:200px;" |target
| style="width:200px;" |localfilesystem
|The file will be exported to a local file system.
|-
| style="width:200px;" |target-file-name
| style="width:200px;" |
|Name of the exported PDF file
|-
| style="width:200px;" |target-file-path
| style="width:200px;" |
|Target file location
|}

== Creating a page list for the export ==
The export list is defined in the wiki page that is shown as the <code>title</code> in the json-file. (In the example above, this is the page <code>MyPDF</code> .)

The page <code>MyPDF</code> now needs to list all pages that will be exported to PDF.

This list can be created with an [[SMW queries|SMW inline query]] (BlueSpice free) or with a [[Manual:Extension/DynamicPageList3|DPL3 list]] (BlueSpice free).
Example of an SMW query to create an export for all pages in the categories <code>Process</code> and <code>Work instruction</code>:

You would add the following to your <code>MyPDF</code> page in the wiki:<syntaxhighlight lang="text">
==All processes==
{{#ask:[[Process:+]]|format=ul|limit=99999}}

==All work instructions==
{{#ask:[[Work instruction:+]]|format=ul|limit=99999}}
</syntaxhighlight>The same list can be created with the following DPL3 syntax:<syntaxhighlight lang="text">
==All processes==
{{#dpl:category=Process}}

==All work instructions==
{{#dpl:category=Work instruction}}
</syntaxhighlight>

== Setting up a CronJob ==
To automate the export, the following CronJob is available:<syntaxhighlight lang="text">
php {MW_ROOT}/extensions/BlueSpiceUniversalExport/maintenance/export.php --specification-file={MW_ROOT}/extensions/BlueSpiceFoundation/data/spec.json
</syntaxhighlight>
__FORCETOC__

Manual:Extension/BlueSpiceConfigManager

2023-06-14T11:55:13Z

WikiSysop:

<bookshelf src="Book:Admin manual" />
{{DISPLAYTITLE:Config manager}}
__TOC__

With the Config manager, a wiki user with ''sysop'' rights can manage wiki-wide settings in one place. In the [[Manual:Extension/BlueSpiceDiscovery/Main navigation|navigation]], it is located at ''Global navigation > Management > Configuration''. This link loads the page ''Special:BluespiceConfigManager.''

==Layout==

===Filter options===
All settings can be accessed through the following filter options:

*'''Feature:''' group by type of functionality the setting belongs to (search, administration...)
*'''Extension:''' group by extension name
*'''Package:''' group by BlueSpice edition and services (BlueSpice free, BlueSpice pro, Matomo) 
[[File:Manual:ConfigManager2a.png|alt=config manager filters|center|thumb|401x401px|config manager filter]]

All settings are available in any type of grouping. Changing the grouping type does not add or remove setting options. It just groups them differently. After settings are adjusted, they can be saved by clicking ''Save'', or cancelled by clicking ''Reset''.

{{Messagebox|boxtype=note|Note text=If a server administrator has configured a setting to no longer be writable, it will be shown as greyed-out in the config manager. You will have to talk to your server administrator about changing such a setting.}}

===Searching for settings===
A search bar is located above the list of settings. Type in a keyword such as "logo" to find the corresponding setting. The search returns settings regardless of the currently selected group. {{Messagebox|boxtype=note|Note text=The search field has to be empty if you want to see the filter menu instead of the search.}} 
[[File:Manual:configmanager-search.png|alt=Config manager search box|center|thumb|400x400px|Config manager search box]]

==Settings by extension==

=== EventBus ===
Eventbus sends notifications to external urls in case something happens in the wiki. For example, if a page is created, an external service could then be started and create a pdf of that page. See the extension's page on [[mediawikiwiki:Extension:EventBus|mediawiki.org]].

=== EnhancedUpload {{Bsvs|bsvFrom=4.3|bsvTo=|bsvFeature=}} ===
Sets the defaults for the [[Manual:Extension/VisualEditor/Insert images#Advanced settings|advanced image settings]] when uploading and embedding an image into the wiki via drag-and-drop functionality. The default settings determine the orientation, type, and size of the image. These can be adjusted after embedding via the "Advanced settings" of the image on the page.

===BlueSpiceFoundation===

====Updating logo and favicon====
{{Messagebox|boxtype=note|icon=|Note text=Since BlueSpice 4.2, the logo and favicon can also be managed via the page [[Manual:Extension/FlexiSkin|Special:Flexiskin]] together with further skin customizations.|bgcolor=}}
*'''Logo path:''' The logo image should be stored in the /images folder of your installation. If you store it in the /skins folder of your BlueSpice installation, it could be overwritten with an upgrade.

'''To upload the logo directly in the wiki:'''

#'''Upload''' the logo on the page from the menu ''Global actions'' > ''File list'' (''Special:ExtendedFilelist'').
#'''Click''' on the thumbnail image of the logo. This opens the logo on a separate page. [[File:Manual:config-logo1.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:config-logo1.png|alt=logo thumbnail image|center|thumb|280x280px|logo thumbnail image]]
#'''Copy''' the relative logo path from the address bar. In a typical Wiki configuration, this path starts with ''/w/....'' . [[File:Manual:config-logo2.png|alt=relative image path|center|thumb|450x450px|relative image path]]
#'''Paste''' the logo path into the text field for the logo. [[File:Manual:config-logo3.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:config-logo3.png|alt=logo path|center|thumb|450x450px|logo path]]
#'''Click''' ''Save''.
#'''Refresh''' the page (Strg+F5). If the uploaded logo is too large, you can add the following code snippet to the page ''MediaWiki:Common.css''. This automatically adjusts the image to the height of the main toolbar:<syntaxhighlight lang="css">
.bs-logo a {background-size: contain;}
</syntaxhighlight>

*'''Favicon path:''' The favicon image should be stored in the ''/images'' folder of your installation. If you store it in the /skins folder of your BlueSpice installation, it could be overwritten with an upgrade. [https://de.wikipedia.org/wiki/Favicon Favicon images] have the file extension ''.ico''.

====System====

*'''Allowed file extensions:''' For security reasons, the types of files that users can upload are restricted. Here, you can allow additional file formats. If a file format is blacklisted in the server configuration, adding this file extension here will not allow this file type to be uploaded. See [https://mediawikiwiki:Manual:$wgFileExtensions mediawiki.org/wiki/Manual:$wgFileExtensions] for more info.

*'''Allowed image extensions:''' The standard web image types are listed here. In general, you want to restrict image uploads to web images. See [https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types] for more on browser-supported image types.

===BlueSpiceArticleInfo===
''BlueSpiceArticleInfo'', together with ''[[Manual:Extension/BlueSpiceAuthors|BlueSpiceAuthors]], [[Manual:Extension/BlueSpiceReaders|BlueSpiceReaders]], and [[Manual:Extension/BlueSpiceExtendedSearch|BlueSpiceExtendedSearch]]'' is part of the ''Page information'' in the quality management tools.

*'''Update interval in seconds:''' Sets the refresh rate for the "Last edit" value. By default, this date is updated every 10 seconds via JavaScript.
[[File:Manual:ArticleInfo.png|link=link=Special:FilePath/ArticleInfo3.jpg|alt=|center|thumb|374x374px|article info]]

===BlueSpiceAuthors===
''BlueSpiceAuthors,'' together with ''[[Manual:Extension/BlueSpiceArticleInfo|BlueSpiceArticleInfo]]'' and ''BlueSpiceReaders'', is part of the ''Page information'' in the quality management tools.

*'''Display authors:''' Show or hide authors on the page information page.
[[File:Manual:PageInformation Authors.png|alt=|center|page=authors in page information|thumb|332x332px|Authors of page]]

===BlueSpiceAvatars===
[[File:Manual:configmanager-instantavatar.png|thumb|101x101px|InstantAvatar|link=Special:FilePath/Manual:configmanager-instantavatar.png]]
An avatar image is automatically generated if the user does not upload a profile picture or if the user decides to create an avatar image in the preferences.

*'''Generator'''
**'''InstantAvatar:''' Generates an avatar image based on using the initials of the Real name or the Username
**'''[[wikipedia:Identicon|Identicon:]]''' Generates an avatar image based on parts of the user's IP address. [[File:Manual:configmanager-identicon.png|alt=Identicon|center|thumb|500x500px|Identicon]]

===BlueSpiceBookshelf===

*'''Show book chapter pager after content:''' Displays previous/next book page navigation at the end of each book page. (1)
*'''Show book chapter pager before content:''' Displays previous/next book page navigation at the beginning of each book page. (2) [[File:Manual:book-pagenav.png|alt=Book navigation|center|thumb|450x450px|Book navigation ]] 
*'''Use the display title from book source on article:''' Shows the title from the book navigation as page title instead of the page name. 
[[File:Manual:bookdisplaytitle.png|alt=book display title|center|thumb|450x450px|book display title]]
{{Messagebox|boxtype=note|Note text=If the page additionally contains a <nowiki>{{DISPLAYTITLE}}</nowiki> tag, the display title of the page is shown instead of the book title.}}

*'''Prepend article table of contents and headlines with book numberation:''' The page TOC does not start with the main heading 1, but with the actual number from the book chapter (see screenshot). If users have activated in their [[Manual:Preferences#Advanced options|user preferences]] to "auto-number headings", the numbering system is matched accordingly. [[File:prepand TOC with book chapter.png|alt=Prepended chapter numbers|center|thumb|650x650px|Prepended chapter numbers]]
*'''Supress namespace prefix of book articles in output:''' The namespace prefix of an article is not shown in PDFs.

===BlueSpiceChecklist===

*'''Mark checklist changes as minor edit:''' If this setting is active, changes to a checklist (for example, checking a checkbox) in view mode are logged as minor edits. If this setting is inactive, a change to the checklist is recorded as a regular version in the page history. [[File:Manual:configmanager-checklistminoredit.png|alt=minor edit|center|thumb|550x550px|minor edit]]

===BlueSpiceExtendedSearch===

*'''External file paths''': External locations to scan for and index files from. These locations are entered in key/value pairs of Physical path and URL prefix.
**''Physical path: S''torage path. For mounted drives, for example: ''X:\Documents''
**''URL prefix:'' All files indexed from the indexed physical location are prefixed in the search results. It should be used if files are available from a web server. By default, the URL prefix is set to the same value as ''Physical path''.

{| class="wikitable" style="width:100%;"
|+Examples for external file paths
!Example file
!Phys. Path
!URL Prefix
!Link in results list
|-
| rowspan="3" |S:\Sales\Info\glossaryy.pdf
| rowspan="3" |S:\
|<nowiki>file:///S:/</nowiki>
|<nowiki>file:///S:/Sales/Info/glossary.pdf</nowiki>
|-
|https://sharepoint/Sales/
documents/
|https://sharepoint/Sales/
documents/Sales/Info/glossary.pdf
|-
|https://intranet/showdocs
inline.aspx?path=
|https://intranet/showdocsinline.aspx?
path=/Sales/Info/glossary.pdf
|-
|/var/www/bluespice/w/mounted_
share/Sales/Info/glossary.pdf
|/var/www/bluespice/w/
mounted_share/
|
|https://wiki.company.local/w/mounted_
share/Sales/Info/glossary.pdf
|}
[[File:Manual:configmanager-addfilepath.png|alt=Add an external file path|center|thumb|650x650px|Add an external file path: (1) confirm the checkmark and (2) save the settings.]]
 

*'''Use simple autocomplete:''' forces a more compact autocomplete (1-column Sales thumbnail preview). [[File:Manual:configuration-autocomplete-simple.1575886540740.png|alt=compact autocomplete|center|thumb|450x450px|compact autocomplete]][[File:Manual:configuration-autocomplete-regular.1575886496796.png|alt=regular autocomplete|center|thumb|450x450px|Salesautocompletey]] 
*'''Automatically set language filter''': This setting applies to multi-languages. It returns search results for a user only in the user's language. Users can set their language in their [[Manual:Preferences|preferences]].
*'''Exclude patterns:''' Files at external file locations can be exluded from search based on regular expression patterns.

===BlueSpiceExtendedStatistics===

*'''Exclude these users:''' Some user groups, like WikiSysop can skew the statistics, for example the statistics for search queries or because they complete automated maintenance tasks. These types of user groups can be excluded from the statistical results.
*'''Maximum number of interval steps:''' Sets the size of the x-axis for the results. For a few days, select the interval ''Day'' or ''Calendar Week'', for periods over one year, select ''Year'' or ''Month''. If you do not get any results for your query, try to adjust the interval accordingly.

===BlueSpiceInsertCategory===

*Insert category with its parent categories
*Preset categories of a page in the upload dialog

===BlueSpiceInsertLink===

*'''Allow unmapped links:''' if there is no prefix in the map, the link will still be inserted. Example: S:\HR. If this setting is unchecked, the link will not be inserted.
*'''Allowed locations for external files''':
{| class="wikitable" style="width:100%;"
!Example file
!Filesystem prefix
!Web accessible Prefix
!Link output
|-
| rowspan="3" |S:\Sales\Info\glossaryy.pdf
| rowspan="3" |S:\
|<nowiki>file:///S:/</nowiki>
|<nowiki>file:///S:/Sales/Info/glossary.pdf</nowiki>
|-
|https://sharepoint/Sales/
documents/
|https://sharepoint/Sales/
documents/Sales/Info/glossary.pdf
|-
|https://intranet/showdocs
inline.aspx?path=
|https://intranet/showdocsinline.aspx?
path=/Sales/Info/glossary.pdf
|-
|/var/www/bluespice/w/mounted_
share/Sales/Info/glossary.pdf
|/var/www/bluespice/w/
mounted_share/
|
|https://wiki.company.local/w/mounted_
share/Sales/Info/glossary.pdf
|}
===BlueSpicePageTemplates===

*'''Force target namespace:''' The page is always created in the target namespace that is associated with the template, even if the user provided a different namespace prefix. In the screenshot below, the user wants to create the page "NewPage" and then selects a template for the QM namespace. The page is, therefore, created as "QM:NewPage" if this setting is activated. [[File:force namespace from template.png|alt=force the namespace of the template|center|thumb|650x650px|force the namespace of the template]]

*'''Hide default templates:''' Hides the default ''Empty page'' template.
*'''Hide template if the page is not to be created in the target namespace:''' Depending on the namespace prefix of the page to be created, templates that are associated with other namespaces will not be shown to the user for selection.

===BlueSpicePermissionManager===

*'''Backup limit:''' Sets the number of backups for the permissions manager. Each time the page ''Special:PermissionManager'' is saved, a backup is created. If the backup limit is set to 5, the last five versions of the permissions configuration are saved as backups.

===BlueSpiceRSSFeeder===

*'''URL whitelist:''' RSS feeds need to be whitelisted here by an administrator before they can be displayed in a wiki page.
*'''Maximum number of allowed redirects:''' If there are URL redirects for any of the whitelisted URLs, the number of redirects needs to be adjusted (usually to 1 or 2).

[[File:Manual:configmanager-RSS.png|alt=RSS Feed settings|center|thumb|450x450px|RSS Feed settings]]
 
===BlueSpiceReaders ===

*'''Number of readers to display:''' Sets the number of readers that are displayed on the Page information in the Quality management tools. [[File:Manual:PageInformation Reader.png|link=link=Special:FilePath/Manual:configmanager-readers.png|alt=displays readers of the page|center|page=readers|thumb|displays readers of the page]] 

=== BlueSpiceSaferEdit===

*'''Interval for lookup for concurrent editings:''' Sets the time in seconds for checking if another person is editing the page.
*'''Show name of current editor:''' Shows or hides the name of the user who is currently editing the page.

===BlueSpiceUEModuleBookPDF===

* Table of Contents
**''Only article titles (indent by grade):'' Only shows the article titles in the main contents table of the PDF. [[File:Manual:configmanager-toc-simple.png|alt=PDF table of contents without article TOCs|center|thumb|450x450px|PDF table of contents without article TOCs]] 
**''Embed article TOCs (No indent of article titles):'' Shows the table of contents for each article in the main contents table of the PDF.[[File:Manual:configmanager-toc-embed.png|alt=Embed article TOCs|center|thumb|450x450px|Embed article TOCs]]

===BlueSpiceUEModuleHTML===

*'''Hide namespace prefix in HTML:''' If activated, the namespace is shown in the HTML main heading.
{{Messagebox|boxtype=note|Note text=If the page contains a "displaytitle" tag in the page source, the page display title is shown and this setting has no effect.}}

===BlueSpiceUEModulePDF===

*'''Hide namespace prefix in PDF:''' If activated, the namespace is shown in the PDF main heading for a page.

[[File:Manual:configmanager-pdfhidenamespace.png|alt=namespace in heading|center|thumb|450x450px|namespace in heading]]
{{Messagebox|boxtype=note|Note text=If the page contains a "displaytitle" tag in the page source, the page display title is shown and this setting has no effect.}}

===BlueSpiceUniversalExport===

*'''Metadata (standard, JSON):''' Additional data to be passed to the rendering template in JSON format. This data can be used in the export template. The template itself is maintened server-side.
*'''Metadata (override, JSON)''': Allows overriding standard data sent to the rendering template in JSON format. Values that are set by default can be overriden with this option.

===BlueSpiceVisualEditorConnector===

*'''Enable VisualEditor for BlueSpice extensions'''
*'''Configuration variable to use a simplified save process'''
*'''Upload type'''
**Original (Here a confirmation of the rights of use/upload is obtained, file name and namespace of the file can be changed, a category can be assigned and a description of the file MUST be given).
**Simple (No confirmation of required rights is obtained here, the name and namespace of the file can be changed, a description and a category can be assigned, but does not have to be specified)
**One click (No confirmation about required rights is obtained here, the image cannot be renamed and no category can be assigned. Only the namespace can, but does not have to be adjusted before uploading)  

===BlueSpiceWhoIsOnline===

*'''Time in seconds until a user is marked as offline:''' The system checks every ''x'' seconds if a user logged out and no longer displayed as online. This can be less frequent than the update inteval for newly logged-in users.
*'''Update interval in seconds:''' The system checks every ''x'' seconds for users.

===BlueSpiceExpiry===

*'''Show watermark for expired pages in PDF:''' Shows the watermark for expired pages in PDFs.
*'''Show watermark for expired pages in print version:''' Shows the watermark for expired pages when a page is printed.
*'''Show watermark for expired pages''': Shows a watermark on the page itself. [[File:Manual:configmanager-watermark.png|alt=watermark|center|thumb|250x250px|watermark]]

===BlueSpiceFlaggedRevsConnector===
{{BSVersion|bsvFrom=|bsvTo=4.2|bsvFeature=BlueSpiceFlaggedRevsConnector|text=It is replaced by [[#Content Stabilization]].}}
'''Export'''

The export settings affect how the pages of a book are generated in the PDF export.

*'''Bookshelf: List approved revisions log:''' Shows a log of stable page versions of pages in the PDF and when these pages were put into accepted status. If editors did not provide a comment when accepting the page, the ''Stable comment'' field for a revision is empty. [[File:Manual:configmanager-bookshelf-revisionslog.png|alt=accepted revisions log|center|thumb|450x450px|accepted revisions log]] 
*'''Bookshelf: List pages without stable revision:''' Displays a list of PDF pages at the beginning of the PDF that only exist as a first draft and have no released version.[[File:configmanager-book-nichtfreigegebeneseiten-EN.png|center|thumb|300x300px|Pages without acceptance feature|link=Special:FilePath/configmanager-book-nichtfreigegebeneseiten-EN.png]] 
*'''Bookshelf: List pages without FlaggedRevs:''' Displays a list of PDF pages that do not have a release mechanism at the beginning of the PDF.

 
[[File:Manual:configmanager-book-listnoflaggedrev.png|alt=Pages with no FlaggedRevs feature.|center|thumb|260x260px|Pages with no FlaggedRevs feature.]]
 

*'''UEModulePDF: Show FlaggedRevs info below main heading''': Prints the latest revision dates (last acceptance and last edit date) below the heading. [[File:Manual:configmanager-bookshelf-flaggedrevsinfo.png|alt=FlaggedRevs info below heading|center|thumb|350x350px|FlaggedRevs info below heading]]

'''Quality assurance'''

*'''Include handling:''' If resources are embedded in a page and those resources are located in namespaces with approval mechanism, then the following settings can be selected. For example: If an approved page contains a template or a file that has been changed after the page itself has been approved, the page will not get another draft version, but instead one of two configurations applies:
**Current versions: Always show the latest version of the embedded resource.
**Stable versions: Always show the stable (=approved) version of a resource.

*'''Show unstable pages for following groups:''' If the group ''user'' is removed from the ''BlueSpiceFlaggedRevs'' configuration, users in this group will not be able to see draft versions when they are added as reviewers in a review process. When the group user is removed, only ''sysop'' and ''reviewer'' users can access drafts. If you want other groups, for example ''editor'', to see draft versions, you need to add them to the configuration. If no user groups are specified in the configuration field, not even reviewers and sysops users will see a visual status indication of a page. They will have access to drafts through the revision history for the page instead.

'''Searching and Navigation'''

*'''Indexing only stable versions:''' Draft versions are excluded from the search results. If a page does not have a stable version, it is not shown as a search result.

=== BlueSpiceSocial ===

* '''Show entrypoint "Timeline":''' Shows a link to the page ''Special:Timeline'' in the main navigation.

===BlueSpiceSocialBlog===

*'''Use teaser text for blog entries in the timeline:''' When you create a blog entry, you can create a teaser text for it by clicking the cogwheel symbol in the blog entry form. If this setting is active, the teaser text will be shown on the page ''Special:Timeline'' instead of the first part of the content.

 [[File:Manual:configmanager-blogteaser.png|center|thumb|380x380px|blog teaser text|link=Special:FilePath/Manual:configmanager-blogteaser.png]]

* '''Show entrypoint "Blog":''' Shows a link to the page ''Special:Blog'' in the main navigation.

===BlueSpiceSocialTopics===

*'''Automatically create all discussion pages.''' If a user creates the first discussion topic for a page using the link in the page footer of a wiki page, the needed discussion page is automatically created first. [[File:Manual:configmanager-socialtopics-create.png|alt=create discussion topic|center|thumb|350x350px|create discussion topic]] A message "This discussion page was created automatically" is inserted on the discussion page. [[File:Manual:configmanager-socialtopics.png|alt=automatically created discussion page|center|thumb|350x350px|automatically created discussion page]] 

If this setting is deactivated, the user is directed to the "Create page" default page first. 

== BlueSpiceDiscovery ==

====Deactivating the Entrypoint links====
[[File:discovery-entrypoint links.png|alt=Entrypoint links for Discovery skin|center|thumb|650x650px|Entrypoint links for Discovery skin]]

====Positioning of skin elements====
[[File:BlueSpice-Discovery2.png|alt=positioning skin elements|center|thumb|600x600px|positioning skin elements]]

*page-sentence: display of page status ([[Manual:Extension/FlaggedRevs|Approval status]], [[Manual:Extension/BlueSpiceExpiry|Expiry]])
*categories: display of [[:de:Handbuch:Kategorien_erstellen_und_nutzen|page categories]]

*rating: display of [[Manual:Extension/BlueSpiceRating|page ratings]]

*recommendations: display of [[Manual:Extension/BlueSpiceRating|page recommendations]]

=== Content Stabilization{{bsvs|bsvFrom=4.3|bsvTo=|bsvFeature=}} ===
The following configuration options are available for page approvals:
[[Datei:Handbuch:config-contentstabilization.png|alt=Screenshot for approval settings|center|mini|650x650px|Settings for page approvals]]

*'''Include handling (1):''' Wenn Ressourcen in eine Seite eingebettet sind '''und sich diese Ressourcen in Namensräumen mit Freigabe befinden''', können die folgenden Einstellungen ausgewählt werden. Es gibt zwei mögliche Einstellungen:

{| class="wikitable" style="width:100%;" data-ve-attributes="{"style":"width:100%;"}"
! style="width:220px;" data-ve-attributes="{"style":"width:220px;"}" |
!Verhalten
|-
| style="width:220px;" data-ve-attributes="{"style":"width:220px;"}" |Stable versions of included pages
|Shows the approved (stable) version of a resource, even if it was approved after the page that includes the resource was approved. (This works only if the resource is located in a namespace with active approval feature).
|-
| style="width:220px;" data-ve-attributes="{"style":"width:220px;"}" |Versions that were current at the time of approval
|Shows the version of the resource which was embedded at the time of the last approval of the wiki page where it is embedded. (This works only if the resource is located in a namespace with active approval feature).
|}For example, if an approved page contains a template that was modified after the page itself was approved, the page will not show a draft version. Approvals work directly via the embedded resource.

*'''Allow viewing of first draft version (2):''' If this setting is activated, then all users with read rights can view the first draft. When disabled, only groups from the "Show unstable pages for following groups" setting can see first drafts.
*'''Update semantic properties from stable pages only (3):''' The property value of the page is read from the stable version of the page and not from the draft version.

*'''Entwurfsseiten für folgende Gruppen anzeigen (4):''' If the group <code>user</code> has been removed from the configuration, users in this group will not be able to see draft versions when they are added as reviewers in a review process. In this case, only users with the roles <code>sysop</code> and <code>reviewer</code> can access drafts unless other groups are specified. These system groups can only access drafts through the site's version history.
{{translation}}
[[Category:Administration]]

Archive:Setup:Installation Guide/Optimization/Cronjobs

2023-06-14T11:46:44Z

WikiSysop:

{{DISPLAYTITLE:Cronjobs}}
__TOC__

This document describes cronjobs an related configurations, which should be set for your BlueSpice (depending on the used version).

==Tips for this Document==
{{Setup-document-note}}

==runJobs.php==
Time-consuming processes will be moved to a processing queue in the background of BlueSpice. With every page impression, a part of these will be processed. For the case that there are lots of processes in the queue and there are relatively litte page impressions, the tasks will not be processed promptly.

For this reason, the queue should be processed regularly by cronjob.

Now create a cronjob (Windows: "Scheduled task") depending on your operating system. The command to execute is:

php <code><installpath-bluespice></code>/maintenance/runJobs.php ''(Linux)''
php.exe <code><installpath-bluespice></code>\maintenance\runJobs.php ''(Windows)''

{{Messagebox|boxtype=Hinweis|Note text=It is recommended to specify the complete path to php.exe under Windows. For more information, see the [[Setup:Installation_Guide/Services_and_system_configuration/Environment_Variables|environment variables]] document.}}
Execute the cronjob every '''10 minutes'''.

[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Optimierungen/Cronjobs]]

User:WikiSysop

2023-06-06T14:41:00Z

WikiSysop: Undo revision 6224 by WikiSysop (talk)

User:WikiSysop

2023-06-06T14:40:33Z

WikiSysop: Undo revision 6225 by WikiSysop (talk)

{{Userpage standard content}}

{{#ask:[[Reference:+]][[Category:Extension]][[Revision ID::!27855]][[Modification date::+]]
|?BSExtensionInfoDescription=Description
|?BSExtensionInfoLicense=License
|?BSExtensionInfoType=Maintainer
|limit=9999
}}

User:WikiSysop

2023-06-06T14:36:06Z

WikiSysop:

User:WikiSysop

2023-06-06T14:34:52Z

WikiSysop:

Archive:Setup:Installation Guide/With Installer

2023-05-24T08:25:43Z

WikiSysop:

== 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]]. Note: Since BlueSpice 4.3.0, <code>config.template</code> directory no longer exists, so step of renaming it should be skipped
#Run <code>php <installpath-bluespic</code><code>e></code><code>\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]]

Archive:Setup:Installation Guide/With Installer

2023-05-24T08:22:55Z

WikiSysop:

== 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]]. Note: Since BlueSpice 4.3 config.template directory no longer exists, so step of renaming it should be skipped
#Run <code>php <installpath-bluespic</code><code>e></code><code>\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]]

Archive:Setup:Installation Guide/With Installer

2023-05-24T08:22:33Z

WikiSysop:

== 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]]. Note: Since BlueSpice 4.3 config.template directory no longer exists, so step of renaming it should be skipped
#Run <code>php <installpath-bluespice></code><code>\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]]

Manual:Extension/Page Forms/Snippets

2023-05-24T06:55:04Z

WikiSysop:

== Providing input values from a (sub-) category ==
=== Using input type "tree" ===
(see official documentation: [[mediawikiwiki:Extension:Page_Forms/Input_types#tree|mediawiki.org/wiki/Extension:Page_Forms/Input_types#tree]] )<syntaxhighlight lang="text">
{{{field|doctype|input type=tree|top category=Document type|depth=1|hideroot|list}}}
</syntaxhighlight>Form display:
[[File:PF tree.png|alt=screenshot of category tree with one value selected|none|thumb|Field type tree]]

Example output of template parameter: <code>doctype=Process</code>

=== Using DPL query (dropdown) ===
(Solution found at: https://www.mediawiki.org/wiki/Extension_talk:DynamicPageList3#Return_page_titles_as_plain_text?<syntaxhighlight lang="text">
{{{field
| doctype
| input type=dropdown
| values = {{#dpl: namespace = Category
| category = Document type
| mode = inline
| format = ,¶%TITLE%,,
| inlinetext = ,
}}
}}}
</syntaxhighlight>Form field:
[[File:PF-subcat-dpl.png|alt=screenshot of the dropdown result for the dpl3 solution|none|thumb|values provided by dpl3 parser function]]

Example template output:

<code>doctype=Process</code>

Using an SMW inline query

<syntaxhighlight lang="text">
{{{field|doctype|input type=dropdown|values={{#ask: [[Subcategory of::Document type]]|format=plainlist|sep=,|link=none|template=SMW Pagename}} }}}
</syntaxhighlight>The above example uses the mapping template ''Template:SMW Pagename'' to avoid showing the namespace prefix "Category:" in the dropdown. Create the template with the following content:<syntaxhighlight lang="text">
{{PAGENAME:{{{1|}}} }}
</syntaxhighlight>Although the category prefix is then not shown in the dropdown, the value the form passes to its associated template parameter still includes the namespace prefix.

Example template output:

<code>doctype=Process</code>
=== Using an SMW concept ===
Create the page Concept:Doctype with the following content:<syntaxhighlight lang="text">
{{#concept:
[[Subcategory of::Documenttype]][[Modification date::+]]
|List of sub categories of the category Documenttype
}}
</syntaxhighlight>Use this concept as the source for the values of your field:<syntaxhighlight lang="text">
{{{field|doctype|input type=dropdown|values from concept=doctype|mapping template=catConcept}}}
</syntaxhighlight>The above example uses the mapping template ''Template:catConcept'' to avoid showing the namespace prefix "Category:" in the dropdown. Create the template with the following content:<syntaxhighlight lang="text">
{{PAGENAME:{{{1|}}} }}
</syntaxhighlight>Although the category prefix is then not shown in the dropdown, the value the form passes to its associated template parameter still includes the namespace prefix.

Example template output:

<code>doctype=Category:Process</code>

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

2023-05-17T13:20:11Z

WikiSysop:

{{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|icon=|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.
 
'''Multiple virtual hosts'''
This guide applies to cases where BlueSpice is being installed on a dedicated server. If you have other virtual hosts configured, you may need to specify an alias for the <code>/w/</code> subfolder. Add the following to your Apache's http-specific configuration: <code>Alias /w/ /path/to/w/</code> (e.g., <code>Alias /w/ /var/www/html/example.com/w/</code>)

|bgcolor=}}

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

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

2023-05-17T13:14:36Z

WikiSysop:

{{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|icon=|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.
 
'''Multiple virtual hosts'''
This guide applies to cases where BlueSpice is being installed on a dedicated server. If you have other virtual hosts configured, you may need to specify an alias for the <code>/w/</code> subfolder by adding the following to your Apache's http-specific configuration: <code>Alias /w/ /path/to/w/</code>).

|bgcolor=}}

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

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

2023-05-17T12:58:47Z

WikiSysop:

{{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.
 
'''Multiple virtual hosts'''
This guide applies to cases where BlueSpice is being installed on a dedicated server. If you have other virtual hosts configured, you may need to specify an alias for the <code>/w/</code> subfolder (e.g., by using <code>Alias /w/ /path/to/w/</code>).

}}

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

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

2023-05-17T12:58:08Z

WikiSysop:

{{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.
 
'''Multiple virtual hosts'''
This guide applies to cases where BlueSpice is being installed on a dedicated server. If you have other virtual hosts configured, you may need to specify an alias for the <code>/w/</code> subfolder (e.g. by using <code>Alias /w/ /path/to/w/</code>).

}}

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

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

2023-05-17T12:57:51Z

WikiSysop:

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

'''Multiple virtual hosts'''
This guide applies to cases where BlueSpice is being installed on a dedicated server. If you have other virtual hosts configured, you may need to specify an alias for the <code>/w/</code> subfolder (e.g. by using <code>Alias /w/ /path/to/w/</code>).

}}

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

Site:Privacy policy

2023-05-17T12:24:39Z

WikiSysop: Created blank page

Community

2023-05-17T12:24:26Z

WikiSysop:

{{Banner|banner-image=pexels-jeffrey-czum-2346289.jpg|image-width=300|imagealign=|banner-title=Community|titlesize=|titlecolor=|banner-text=Be part of the community and exchange your knowledge about wikis and BlueSpice!|textsize=|textcolor=|contentpadding=20px 40px|boxpadding=10px|boxbgcolor=}}
 
<div class="sectionflex col3">
<div>
== Email Support ==
<center>

 

Contact us by email at
 
[mailto:support@hallowelt.com support@hallowelt.com]
</center>
</div>
<div>
== Support forums ==
<center>

 

[http://sourceforge.net/tracker/?func=add&group_id=358032&atid=1494709 Sourceforge bug report]
 
[http://sourceforge.net/p/bluespice/discussion/1249668 Sourceforge help forum]
</center>
</div>
<div>
== Newsletter ==
<center>

 

[https://bluespice.com/newsletter Subscribe to our newsletter. We send 1-2 mails per month.]
</center>
</div>
<div>
== Social Media ==
<center>
 
 
[https://www.facebook.com/BlueSpice.MediaWiki Contact us via Facebook]
 
[https://twitter.com/BlueSpiceTweets Follow us on Twitter!]
</center>
</div>
<div>
== YouTube ==
<center>

 
[https://www.youtube.com/user/BlueSpiceVideo Leave a comment on our videos. We appreciate it!]
</center>
</div>
<div>
== Participate! ==
<center>

 
[[How to become a BlueSpice hacker|BlueSpice hackers wanted!]]
</center>
</div>
</div>

__NODISCUSSION__
__HIDETITLE__
__NOTOC__
[[de:{{FULLPAGENAME}}]]
[[en:Community]]

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

2023-05-17T11:45:36Z

WikiSysop:

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

This guide applies to cases where BlueSpice is being installed on a dedicated server. If you have other virtual hosts configured, you may need to specify an alias for the <code>/w/</code> subfolder (e.g. by using <code>Alias /w/ /path/to/w/</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 (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]]

Reference:MenuEditor

2023-04-11T11:04:17Z

WikiSysop:

{{BSExtensionInfo
|status=stable
|developer=HalloWelt
|type=BlueSpice
|edition=BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud
|compatible=BlueSpice
|category=Content Structuring
|license=GPL v3 only
|features={{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=}}
*Graphical user interface allows editing of the left sidebar as well as the user menu via drag and drop

}}
{{wcagCheck}}
{{translation}}

AutoDoc:MenuEditor

2023-04-11T11:03:27Z

WikiSysop: Created page with "==DescriptionMsg== {{AutoDocDescriptionMsg |name = MenuEditor |desc = {{int:menueditor-desc }} }} ==License== {{AutoDocLicense |name = GPL-3.0-only }} ==Requirements== {{AutoD..."

==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = MenuEditor
|desc = {{int:menueditor-desc
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = 1.35.0
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = MenuEditor
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforeInitialize BeforeInitialize]
|callback = initializeMenus
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BlueSpiceDiscoveryTemplateDataProviderAfterInit BlueSpiceDiscoveryTemplateDataProviderAfterInit]
|callback = editActions
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MediaWikiPerformAction MediaWikiPerformAction]
|callback = editActions
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation::Universal SkinTemplateNavigation::Universal]
|callback = editActions
}}
}}

Reference:MenuEditor

2023-04-11T11:02:12Z

WikiSysop:

{{BSExtensionInfo
|status=stable
|developer=HalloWelt
|type=BlueSpice
|edition=BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud
|compatible=BlueSpice
|category=Content Structuring
|license=GPL v3 only
|features=<div class="hw-messagebox notification-bsversion icon"> is available from BlueSpice [[bsvFrom::4.2]] </div>
*Graphical user interface allows editing of the left sidebar as well as the user menu via drag and drop
*Allows to embed the name of a wiki page, external links as well as interwiki links
}}
{{wcagCheck}}
{{translation}}