BlueSpice - Benutzerbeiträge [de]

Setup:Installationsanleitung/Docker

2025-10-28T12:22:37Z

Hjing: Bump version 5.1.3

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.3.zip \
&& unzip 5.1.3.zip \
&& cd bluespice-deploy-5.1.3/compose
</syntaxhighlight>

{{Textbox|boxtype=note|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflicht
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |nein
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |ja
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |nein
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |ja
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |ja
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |nein, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |nein
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |ja
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |nein
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten fünf <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche <code>yml</code> Dienst-Dateien können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie Ihre <code>.env</code> aus der Vorlagendatei <code>.env.sample</code>.

Beispiel:
<pre>
DATADIR=/data/bluespice
VERSION=5.1.3
EDITION=free
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
WIKI_BASE_PATH=

DB_USER=benutzername_eintragen_oder_verwenden
DB_PASS=PASSWORT_EINTRAGEN_ODER_VERWENDEN
DB_ROOT_USER=root
DB_ROOT_PASS=$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=...

LETSENCRYPT=false
</pre>

{{Textbox|boxtype=note|header=Verschiedene Editionen|text=Zum Bereitstellen der <code>pro</code>- oder <code>farm</code>-Edition benötigen Sie Anmeldeinformationen für das private Register <code>docker.bluespice.com</code>. <br>Bitte melden Sie sich an, indem Sie <code>docker login docker.bluespice.com</code> ausführen.|icon=yes}}

== Schritt 3: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/initialAdminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Handbuch:Erweiterung/BlueSpiceExtendedSearch

2025-08-07T07:37:55Z

Hjing:

{{DISPLAYTITLE:Suche (Titelsuche und Volltextsuche}}

Die Erweiterung '''ExtendedSearch''' ersetzt die MediaWiki-Suchmaschine. Die Erweiterung basiert auf [https://opensearch.org/ OpenSearch]. Seiten und Dateien werden sofort indexiert und sind daher ohne Verzögerung für die Suche verfügbar.

==Funktionen==

Die Suche unterscheidet zwischen folgenden Suchoptionen:

#'''Titelsuche''' ([[Handbuch:Erweiterung/BlueSpiceExtendedSearch#Schnellsuche|Schnellsuche]] oder auch Autovervollständigungssuche)
#'''Volltextsuche ('''[[Handbuch:Erweiterung/BlueSpiceExtendedSearch#Such-Center (erweiterte Suche)|Erweiterte Suche]] oder auch Such-Center)

Standardmäßig werden folgende Suche in den Suchindex aufgenommen:

*'''Wikiseiten:''' Alle Inhaltsseiten mit Ausnahme der Seiten im MediaWiki Namensraum.
*'''Spezialseiten:''' Alle Seiten im Namensraum Spezial.
*'''Hochgeladene Dateien:''' Dateien, die im Wiki gepflegt werden - für Textdateien wie Word-Dokumente und PDFs umfasst dies auch Inhalt und Metadaten.
*'''Externe Dateien (falls konfiguriert):''' Dateien von beliebigen Speicherorten aus zugänglichen Speicherpfaden (z. B. auf zugemounteten Laufwerken)
=== Unterschiedlicher Suchkontext ===
Wenn Sie von der Hauptseite oder einer Wikiseite aus die Suche starten, so wird eine '''reine Titelsuche''' durchgeführt. Über die Eingabetaste wechseln Sie in das '''Such-Center zur Volltextsuche'''. Diese beiden Suchfunktionen unterscheiden sich generell folgendermaßen:

{| class="wikitable" style="width: 100%;"
|+Unterschied zwischen Titelsuche und Volltextsuche
! style="" |
! style="width:40%;" |Titelsuche
! style="" |Volltextsuche
|-
! style="" |Suchumfang
| style="width:40%;" |nur die Seitentitel werden durchsuch
| style="" |Seiteninhalte werden durchsucht
|-
! style="" |Suchergebnis
| style="width:40%;" |höchstens 10 Ergebnisse (beste Treffer) werden angezeigt
| style="" |alle Ergebnisse werden angezeigt
|-
! style="" |[[Handbuch:Erweiterung/BlueSpiceExtendedSearch#Suchoperatoren|Suchoperatoren]]
| style="width:40%;" |werden nicht unterstützt
| style="" |werden unterstützt
|-
! style="" |[[Handbuch:Erweiterung/BlueSpiceExtendedSearch#Auto-complete .22Pillen.22|Namensräume]]
| style="width:40%;" |die Suche kann auf einen Namensraum beschränkt werden
| style="" |Suche kann auf Namensräume beschränkt werden (in Kombination mit weiteren Filtern)
|-
! style="" |[[Handbuch:Erweiterung/BlueSpiceExtendedSearch#Auto-complete .22Pillen.22|Kategorien]]
| style="width:40%;" |über das Suchpräfix "Kategorie:" werden Seiten im Namensraum "Kategorie" gesucht
| style="" |Suche kann auf Kategorien beschränkt werden (in Kombination mit weiteren Filtern)
|-
! style="" |[[Handbuch:Erweiterung/BlueSpiceExtendedSearch#Unterseiten|Unterseiten]]
| style="width:40%;" |Die Suche wird automatisch auf Unterseiten beschränkt, wenn ein Seitenname im Suchfeld mit einem Schrägstrich endet
| style="" |die Unterseitensyntax wird im Volltext nicht erkannt, funktioniert aber eingeschränkt für Seitentitel.
Zum Beispiel werden die Unterseiten der Seite "BlueSpice" über "BlueSpice/*" gefunden, können aber nicht differenzierter über mehrere Wildcards zusätzlich eingeschränkt werden.
|-
! style="" |[[Handbuch:Erweiterung/BlueSpiceBookshelf|Bücher]]
| style="" |Die Suche kann auf den Buch-Kontext des Buches der gerade geladenen Buchseite eingeschränkt werden. Ist die gerade geladene Seite nicht mit einem Buch verknüpft, greift dieser Mechanismus nicht.
| style="" |Suche kann auf Bücher beschränkt werden (in Kombination mit weiteren Filtern)
|}
==Schnellsuche==

=== Zuletzt angesehen ===
Wenn Sie den Cursor im Suchfeld platzieren, wird eine Liste der Seiten angezeigt, die Sie bei einer kürzlich durchgeführten Suche gefunden und aufgerufen haben. Alle vorgeschlagenen Seiten, die Sie nicht interessieren, können Sie aus dieser Ansicht entfernen: Klicken Sie hierzu auf das <code>x</code> rechts neben dem Seitennamen. Sobald Sie mit der Eingabe beginnen, verschwinden die Standardvorschläge.
[[Datei:BlueSpiceExtendedSearch 1708515691246.png|alternativtext=Suchfeld des Wikis mit 3 zuletzt angesehenen Seiten|zentriert|mini|300x300px|Seitenvorschläge basierend auf den zuletzt vom Benutzer über die Suche erreichten Seiten im Wiki]]

=== Titelsuche ===
Die wichtigste Suchfunktion ist das Suchfeld in der Kopfzeile des Wikis. Sofern Sie noch nicht zum Such-Center gewechselt sind, sucht dieses Feld nach einem Seitennamen oder Anzeigetitel, der den genauen Suchbegriff enthält.

Die Titelsuche führt keine Volltextsuche durch. Hierzu muss die Volltextsuche (=[[Handbuch:Erweiterung/BlueSpiceExtendedSearch#Erweiterte Suche (Such-Center)|Such Center]]) aktiviert werden. Drücken Sie dazu einfach die Eingabetaste, nachdem Sie einen Suchbegriff in das Suchfeld eingegeben haben.

'''So funktioniert die Titelsuche:'''
#Die '''Groß-/Kleinschreibung''' wird '''nicht berücksichtigt''': "qual" oder "Qual" liefern dieselben Ergebnisse.
#Die Suchergebnisse sind '''auf 10 Seitentitel begrenzt'''. In den meisten Fällen dient das Suchfeld lediglich als Sprungbrett zu bekannten Seiten (z. B. um zu einer Teamseite, der Seite „Prozesse“ oder einer anderen bekannten Seite zu gelangen, die der Benutzer schnell erreichen möchte).
#'''Rechtschreibfehler''' führen in der Regel zu keinen Ergebnissen: „Qalität“ ergibt nicht „Qualität“. Abhängig von der Version Ihres Wikis kann die Suche Vorschläge liefern („Vielleicht suchst du auch nach…“).
#Mehrere Suchbegriffe können in '''beliebiger Reihenfolge''' angegeben werden, um Ergebnisse zu erzielen („toc download“ findet Seiten genauso wie „download toc“).
# '''Suchoperatoren''' wie <code>""</code>, <code>OR</code> und <code>AND</code> werden nicht unterstützt. Sie werden jedoch in der [[Handbuch:Erweiterung/BlueSpiceExtendedSearch#Erweiterte Suche (Such-Center)|Volltextsuche]] unterstützt.
#Die '''Sortierreihenfolge''' der Ergebnisse basiert auf einer Kombination aus dem besten Titel-Match und dem letzten Bearbeitungsdatum der Seite. (Technische Details finden Sie auf der [[Referenz:BlueSpiceExtendedSearch|Referenzseite zur Erweiterung ExtendedSearch.]] Bei lokalem Hosting des Wikis sind Konfigurationsänderungen möglich. In Cloud-Wikis gibt es keine Konfigurationsoptionen.)
#Die Suche bietet einen Filter (Screenshot-Anmerkung 1) für die Suche:
#*in Unterseiten der aktuellen Seite (sofern vorhanden)
#*im Namensraum der aktuellen Seite
#*im Buch der aktuellen Seite (sofern Sie sich in einem Buch befinden)
#*im gesamten Wiki
#Ein Treffer zeigt folgende Informationen an (Screenshot-Anmerkung 2):
##Seitentitel
##Unter dem Seitentitel das Namensraumpräfix der Seite. Handelt es sich bei dem Ergebnis um eine Unterseite, wird der Pfad der Unterseite neben dem Namensraumpräfix angezeigt.
##Basiert der Titeltreffer auf dem Anzeigetitel einer Seite, wird der Originaltitel in Klammern angezeigt.
##Wenn die Seite auf eine andere Seite umgeleitet wird, wird der Weiterleitungslink mit einem Weiterleitungspfeil vor dem Titel der Zielseite angezeigt. Wenn die Zielseite einen Anzeigetitel hat, wird nur dieser angezeigt. Andernfalls wird der vollständige Pfad der Zielseite angezeigt.[[Datei:Handbuch:titelsuche.png|alternativtext=10 Resultate für den Suchbegriff "Visu"|zentriert|mini|711x711px|Titelsuche]]

=== Auto-complete Pillen ===

Die Suchleiste für die automatische Vervollständigung unterstützt sogenannte Pillen für Namensraum und Unterseiten.[[Datei:extendedsearch-pille.png|mini|"Pillen"-Funktion|zentriert|verweis=Special:FilePath/extendedsearch-pille.png|alt=Beispiel von Durchsuchung in nur einen Namensraum]]Wenn ein Benutzer zum Beispiel "Handbuch:" eingibt, wird eine Pille für den Namensraum "Handbuch" erstellt und ein eingegebener Begriff nur im Namensraum "Handbuch" gesucht.
==== Unterseiten ====
Unterseitentitel in Namensräumen werden, wenn Sie den direkten Seitenpfad eingeben, nur gefunden, wenn das Namensraumpräfix mitangegeben wird.
Zum Beispiel wird die Unterseite "Bilder" mit dem Pfad <code>Handbuch:Erweiterung/VisualEditor/Bilder</code> über folgende Suchbegriffe gefunden:

* "Handbuch:Erweiterung/Bil"
* "Handbuch:VisualEditor/Bil"
* "Handbuch:Bil"
Die Seite wird nicht gefunden über:
* "VisualEditor/Bil"
* "Erweiterung/Bil"

===Datumssuche===
<span style="color: rgb(51, 51, 51)">Die (Titel-)Suche erkennt gewisse Datumsformate und im Such-Center werden diese mit Anführungszeichen umgeben.</span>
<gallery widths="400" heights="200">
Datei:extendedsearch-datum1.png|alt=Suche durch Datumsformat 1|Datumsformat 1
Datei:extendedsearch-datum2.png|alt=Suche durch Datumsformat 2|Datumsformat 2
</gallery>

==Erweiterte Suche (Such-Center)==
Sobald Sie die Suche über das Lupen-Symbol oder die Eingabetaste auslösen, wechseln Sie in das Such-Center.

Dies ist eine spezielle Seite, die die volle Funktionalität der Suche bietet. Die Suche im Such-Center erfolgt über die gleiche Suchleiste, die auch für die automatische Vervollständigung verwendet wird. Hier wird nun jedoch eine Volltextsuche durchgeführt, die auch die Metadaten von Dokumenten miteinbezieht. Die Suchmaschine durchsucht hierbei nicht den Wikitext einer Wikiseite, sondern den vom Browser ausgegebenen Inhalt.<br />
[[Datei:extendedsearch-searchcenter.png|alternativtext=Such-Center|zentriert|mini|550x550px|Such-Center]]

===Suchoperatoren===
{{Hinweisbox|boxtype=Wichtig|icon=|Note text=Suchoperatoren funktionieren nur im Such-Center (Volltextsuche). In der Titelsuche können keine Suchoperatoren angegeben werden.

Wenn Sie nach '''zusammenhängenden Wörtern suchen''', sollten diese aus Performanzgründen in Anführungszeichen (") gesetzt werden, um eine eindeutige Suche zu unterstützen.|bgcolor=}}

Die Suchoperatoren müssen in '''Großbuchstaben und in englischer Bezeichnung''' geschrieben werden.

==== AND ====
*<code>Qualität AND Doku</code>: Gibt Seiten zurück, die sowohl den genauen Begriff <code>Qualität</code> als auch den genauen Begriff <code>Doku</code> enthalten.
*<code>Qualität* AND Doku</code>: Wenn auch <code>Qualitätswerkzeug</code> berücksichtigt werden soll, geben Sie einen "Wildcard"-Stern mit an.

'''Vergleiche''': Die Suche <code>Qualität Doku</code> ist automatisch eine Wildcard-Suche und liefert alle Seiten, die '''sowohl''' <code>Qualität*</code> '''als auch''' <code>Doku*</code> enthalten. Sie liefert im Normalfall somit mehr Ergebnisse als die Suche <code>Qualität* AND Doku</code> (da hier die genau Bezeichnung <code>Doku</code> gesucht wird).

==== <code>"</code> (Anführungszeichen) ====
Anführungszeichen bei einem Suchbegriff lösen entsprechend eine AND Suche für alle Begriffe aus:

* <code>"Qualität" Doku</code>: gleiches Ergebnis wie <code>Qualität AND Doku</code> (d.h. auch <code>Doku</code> wird präzise gesucht).

==== NOT ====

* <code>Qualität* NOT Doku*</code>: Gibt Seiten zurück, die mit <code>Qualität</code> beginnende Wörter enthalten, aber nicht mit <code>Doku</code> beginnende Wörter.

==== OR ====
*<code>Qualität OR Doku</code>: Gibt Seiten zurück, die entweder den genauen Begriff <code>Qualität</code> oder den genauen Begriff <code>Doku</code> enthalten.

==== <code>*</code> (wildcard) ====
*<code>'''Qualität*'''</code>: Gibt Seiten zurück, die Wörter enthalten, die mit dem Begriff <code>Qualität</code> beginnen.

=== Elemente im Such-Center ===

*'''Trefferanzahl''': Zeigt an, wie viele Treffer eine Suche zurückgegeben hat. Dies kann ungefähr oder genau sein. Die Annäherung beruht auf der dynamischen Überprüfung der Berechtigungen zum Anzeigen der einzelnen Seiten in den Ergebnissen. Einige Ergebnisse werden dem Benutzer möglicherweise nicht angezeigt, wenn das Ereignis mit seinen entsprechenden Berechtigungen nicht übereinstimmt.
*'''Suchaktionen''' : [[Datei:suchaktionen.png|alternativtext=Menüs für Filter und Suchaktionen|zentriert|mini|200x200px|Suchaktionen]]
**'''Einen Filter hinzufügen''' - dargestellt durch ein "Trichter"-Symbol - öffnet ein Dialogfeld, in dem der Benutzer den Filtertyp auswählen kann, der auf die Suche angewendet werden soll.
**'''Suchoptionen''' - dargestellt durch ein "Hamburgermenü"-Symbol - öffnen ein Dialogfeld, in dem der Benutzer die Einstellungen für die aktuelle Suche ändern kann. Es bietet Optionen wie Anzahl der Ergebnisse pro Seite, Sortierfeld und Reihenfolge.
***'''Suche exportieren''' - öffnet einen Dialog zum Exportieren der aktuellen Suchergebnisse auf eine bestimmte Seite.<br />
*'''Filter:''' Filter werden in Form von Pillen unterhalb der Trefferanzahl angezeigt. Über die Filterschaltfläche können zusätzliche Filter gesetzt werden. Die verfügbaren Filter variieren je nach BlueSpice-Version. Aktive Filter können durch Klicken auf das „x“ in jeder Filterpille entfernt werden.<br />[[Datei:Handbuch:extendedSearch2.png|alt=Erweiterte Suche mit hervorgehobenen Namensraumfilterungen|zentriert|mini|850x850px|Bearbeitungsfilter]]

Wenn für einen bestimmten Suchbegriff eine exakte Übereinstimmung vorliegt, wird das Ergebnis, das genau übereinstimmt, als "hervorgehobenes" Ergebnis angezeigt. Dieses Ergebnis zeigt ein Vorschaubild der Seite an und zeigt immer einen Inhaltsausschnitt an, unabhängig davon, ob der Inhalt Übereinstimmungen enthält oder nicht.

====Ergebnisrelevanz====
Alle angemeldeten Benutzer können bestimmte Ergebnisse als "Favoriten" markieren, indem sie auf das Stecknadel-Symbol in der oberen rechten Ecke der Ergebnisse klicken.
Dateien, die als "Favoriten" markiert sind, werden bei zukünftigen Suchvorgängen höher bewertet.
Die Relevanzeinstellungen eines Benutzers wirken sich nicht auf die Suche anderer Benutzer aus. Wenn ein Benutzer das Ergebnis als "Favorit" markiert, wird es nur für diesen Benutzer und nicht für einen der anderen Benutzer höher gewertet.
Sie können die Markierung der Ergebnisse als "Favorit" aufheben, indem Sie erneut auf das Symbol klicken.
==== Suchergebnisse exportieren====
Nach dem Ausführen der Suche können Benutzer mit Adminrechten die Ergebnisse mithilfe des Befehls "Exportieren" aus dem Menü "Extras" auf eine bestimmte Seite exportieren (speichern).
Im Exportdialog kann der Benutzer den Namen für die Liste eingeben, das Format auswählen und angeben, ob die eventuell vorhandene Liste überschrieben oder an die Liste angehängt werden soll. Die Liste wird nach ''MediaWiki:PageCollection/LISTENNAME'' exportiert.

Es werden nur gültige Wikiseiten exportiert. Die in einer Liste enthaltenen Seiten können in der Buchfunktion über ''Massenimport > Quelle: Seitensammlung'' in ein Buch mit aufgenommen werden.[[Datei:extendedsearch-export-dialog.png|mini|400x400px|Export-Dialog|zentriert|verweis=Special:FilePath/extendedsearch-export-dialog.png|alternativtext=Extendedsearch-Export-Dialog mit Seitensammlung]]
==Konfiguration==
In der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]], unter Einstellungen für die Erweiterung BlueSpiceExtendedSearch, stehen folgende Konfigurationsoptionen zur Verfügung ('''nur für On-Premise Installationen'''):{{#dpl:title=Handbuch:Erweiterung/BlueSpiceConfigManager|include=#BlueSpiceExtendedSearch}}

==Spezialseite "Sucheinstellungen"==
''Die Seite Spezial:Sucheinstellungen'' ist eine spezielle Seite für Wiki-Administratoren.
Diese Seite enthält Statistiken zu den in der Suche indexierten Dokumenten.

{{Translation}}

[[Category:Suche]]

Handbuch:Erweiterung/BlueSpiceExtendedSearch

2025-08-07T07:37:07Z

Hjing:

Setup:Installationsanleitung/Docker

2025-07-24T10:45:56Z

Hjing: Improve default value for db settings

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.1.zip \
&& unzip 5.1.1.zip \
&& cd bluespice-deploy-5.1.1/compose
</syntaxhighlight>

{{Textbox|boxtype=note|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflicht
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |nein
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |ja
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |nein
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |ja
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |ja
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |nein, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |nein
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |ja
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |nein
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten fünf <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche <code>yml</code> Dienst-Dateien können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie Ihre <code>.env</code> aus der Vorlagendatei <code>.env.sample</code>.

Beispiel:
<pre>
DATADIR=/data/bluespice
VERSION=5.1.1
EDITION=free
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
WIKI_BASE_PATH=

DB_USER=benutzername_eintragen_oder_verwenden
DB_PASS=PASSWORT_EINTRAGEN_ODER_VERWENDEN
DB_ROOT_USER=root
DB_ROOT_PASS=$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=...

LETSENCRYPT=false
</pre>

{{Textbox|boxtype=note|header=Verschiedene Editionen|text=Zum Bereitstellen der <code>pro</code>- oder <code>farm</code>-Edition benötigen Sie Anmeldeinformationen für das private Register <code>docker.bluespice.com</code>. <br>Bitte melden Sie sich an, indem Sie <code>docker login docker.bluespice.com</code> ausführen.|icon=yes}}

== Schritt 3: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/initialAdminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Setup:Installationsanleitung/Docker

2025-07-21T12:34:13Z

Hjing: /* Schritt 2: Umgebungsvariablen einrichten */

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.1.zip \
&& unzip 5.1.1.zip \
&& cd bluespice-deploy-5.1.1/compose
</syntaxhighlight>

{{Textbox|boxtype=note|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflicht
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |nein
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |ja
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |nein
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |ja
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |ja
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |nein, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |nein
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |ja
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |nein
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten fünf <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche <code>yml</code> Dienst-Dateien können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie Ihre <code>.env</code> aus der Vorlagendatei <code>.env.sample</code>.

Beispiel:
<pre>
DATADIR=/data/bluespice
VERSION=5.1.1
EDITION=free
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
WIKI_BASE_PATH=

DB_USER=bluespice
DB_PASS=...(Pflichtfeld)
DB_ROOT_USER=root
DB_ROOT_PASS=$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=...

LETSENCRYPT=false
</pre>

{{Textbox|boxtype=note|header=Verschiedene Editionen|text=Zum Bereitstellen der <code>pro</code>- oder <code>farm</code>-Edition benötigen Sie Anmeldeinformationen für das private Register <code>docker.bluespice.com</code>. <br>Bitte melden Sie sich an, indem Sie <code>docker login docker.bluespice.com</code> ausführen.|icon=yes}}

== Schritt 3: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/initialAdminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Setup:Installationsanleitung/Docker

2025-07-21T12:27:26Z

Hjing: /* Schritt 1: Den Stack abrufen */

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.1.zip \
&& unzip 5.1.1.zip \
&& cd bluespice-deploy-5.1.1/compose
</syntaxhighlight>

{{Textbox|boxtype=note|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflicht
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |nein
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |ja
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |nein
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |ja
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |ja
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |nein, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |nein
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |ja
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |nein
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten fünf <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche <code>yml</code> Dienst-Dateien können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie basierend auf der Beispieldatei <code>.env.sample</code> Ihre neue <code>.env</code>-Konfigurationsdatei oder bearbeiten Sie Ihre vorhandene Konfigurationsdatei.

Beispiel:
<pre>
DATADIR=/data/bluespice
VERSION=5.1.1
EDITION=free
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
WIKI_BASE_PATH=

DB_USER=bluespice
DB_PASS=...(Pflichtfeld)
DB_ROOT_USER=root
DB_ROOT_PASS=$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=...

LETSENCRYPT=false
</pre>

{{Textbox|boxtype=note|header=Verschiedene Editionen|text=Zum Bereitstellen der <code>pro</code>- oder <code>farm</code>-Edition benötigen Sie Anmeldeinformationen für das private Register <code>docker.bluespice.com</code>. <br>Bitte melden Sie sich an, indem Sie <code>docker login docker.bluespice.com</code> ausführen.|icon=yes}}

== Schritt 3: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/initialAdminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Setup:Installationsanleitung/Docker

2025-07-21T12:26:05Z

Hjing: /* Schritt 2: Umgebungsvariablen einrichten */

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.1.zip \
&& unzip 5.1.1.zip \
&& cd bluespice-deploy-5.1.1/compose
</syntaxhighlight>

{{Textbox|boxtype=warning|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflicht
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |nein
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |ja
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |nein
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |ja
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |ja
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |nein, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |nein
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |ja
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |nein
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten fünf <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche <code>yml</code> Dienst-Dateien können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie basierend auf der Beispieldatei <code>.env.sample</code> Ihre neue <code>.env</code>-Konfigurationsdatei oder bearbeiten Sie Ihre vorhandene Konfigurationsdatei.

Beispiel:
<pre>
DATADIR=/data/bluespice
VERSION=5.1.1
EDITION=free
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
WIKI_BASE_PATH=

DB_USER=bluespice
DB_PASS=...(Pflichtfeld)
DB_ROOT_USER=root
DB_ROOT_PASS=$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=...

LETSENCRYPT=false
</pre>

{{Textbox|boxtype=note|header=Verschiedene Editionen|text=Zum Bereitstellen der <code>pro</code>- oder <code>farm</code>-Edition benötigen Sie Anmeldeinformationen für das private Register <code>docker.bluespice.com</code>. <br>Bitte melden Sie sich an, indem Sie <code>docker login docker.bluespice.com</code> ausführen.|icon=yes}}

== Schritt 3: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/initialAdminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Setup:Installationsanleitung/Docker

2025-07-21T11:52:58Z

Hjing: /* Schritt 1: Den Stack abrufen */

__TOC__

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.1.zip \
&& unzip 5.1.1.zip \
&& cd bluespice-deploy-5.1.1/compose
</syntaxhighlight>

{{Textbox|boxtype=warning|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflicht
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |nein
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |ja
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |nein
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |ja
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |ja
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |nein, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |nein
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |ja
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |nein
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten fünf <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche <code>yml</code> Dienst-Dateien können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie die Datei <code>.env</code> entsprechend der vorhandenen oder zukünftigen Installation.

Beispiel:<syntaxhighlight lang="text">
DATADIR=/data/bluespice
VERSION=5.1
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=...

</syntaxhighlight>

== Schritt 3: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/initialAdminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Datei:Setup:Installationsanleitung Docker-Achitektur.png

2025-07-21T11:04:16Z

Hjing: Hjing lud eine neue Version von Datei:Setup:Installationsanleitung Docker-Achitektur.png hoch

Setup:Installationsanleitung/Docker

2025-07-21T09:46:00Z

Hjing: /* Schritt 3: Stack starten */

__TOC__

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.1.zip \
&& unzip 5.1.1.zip \
&& cd bluespice-deploy-5.1.1/compose
</syntaxhighlight>

{{Textbox|boxtype=warning|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflicht
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |nein
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |ja
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |nein
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |ja
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |nein, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |ja
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |nein
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |ja
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |nein
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten vier <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche Dienste können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie die Datei <code>.env</code> entsprechend der vorhandenen oder zukünftigen Installation.

Beispiel:<syntaxhighlight lang="text">
DATADIR=/data/bluespice
VERSION=5.1
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=...

</syntaxhighlight>

== Schritt 3: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/initialAdminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Setup:Installationsanleitung/Docker

2025-07-18T09:21:12Z

Hjing: Remove prepare script usage

__TOC__

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.1.zip \
&& unzip 5.1.1.zip \
&& cd bluespice-deploy-5.1.1/compose
</syntaxhighlight>

{{Textbox|boxtype=warning|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflicht
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |nein
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |ja
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |nein
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |ja
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |nein, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |ja
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |nein
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |ja
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |nein
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten vier <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche Dienste können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie die Datei <code>.env</code> entsprechend der vorhandenen oder zukünftigen Installation.

Beispiel:<syntaxhighlight lang="text">
DATADIR=/data/bluespice
VERSION=5.1
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=...

</syntaxhighlight>

== Schritt 3: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/adminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Setup:Installationsanleitung/Docker

2025-07-18T09:19:31Z

Hjing:

__TOC__

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.1.zip \
&& unzip 5.1.1.zip \
&& cd bluespice-deploy-5.1.1/compose
</syntaxhighlight>

{{Textbox|boxtype=warning|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflicht
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |nein
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |ja
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |nein
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |ja
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |nein, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |nein
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |ja
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |nein
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |ja
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |nein
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten vier <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche Dienste können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie die Datei <code>.env</code> entsprechend der vorhandenen oder zukünftigen Installation.

Beispiel:<syntaxhighlight lang="text">
DATADIR=/data/bluespice
VERSION=5.1
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=...

</syntaxhighlight>

== Schritt 3: Datenverzeichnisse vorbereiten ==
Ausführen Das Skript <code>bluespice-prepare</code> hilft Ihnen beim Einrichten der richtigen Ordnerstruktur und Berechtigungen. Außerdem wird ein Dienst für die ordnungsgemäße Handhabung der Container bei Neustarts installiert. Stellen Sie sicher, dass Sie diesen Befehl in einem privilegierten Benutzerkontext (wie <code>root</code>) ausführen, da er Berechtigungen für die neu erstellten Verzeichnisse festlegt.
{{Textbox|boxtype=note|header=Different editions|text=Das Beispiel zeigt <code>EDITION=pro</code>. Beachten Sie, dass Sie für <code>pro</code> und <code>farm</code> bei <code>docker.bluespice.com</code> angemeldet sein müssen.|icon=yes}}

== Schritt 4: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/adminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Setup:Installationsanleitung/Docker

2025-07-18T09:17:26Z

Hjing: Fix variable names

__TOC__

== Übersicht ==
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

== Architektur ==
<drawio filename="Setup:Installationsanleitung_Docker-Achitektur" alt="Diagramm der BlueSpice Docker Stack-Architektur" />

'''Hinweise'''
* Interne HTTP-Verbindungen können nicht standardmäßige Ports verwenden. Diese sind neben den jeweiligen Diensten angegeben.
** HTTP (unsicher) wird nur für die interne Kommunikation innerhalb des virtuellen Netzwerks verwendet, in dem der Stack betrieben wird. Alle Verbindungen zum Client verwenden TLS.
* Proprietäre Ports (insbesondere für Datenbankverbindungen) sind neben den jeweiligen Diensten angegeben.
* Je nach Setup können zusätzliche Dienste und Ports genutzt werden. Einige Beispiele:
** Bei Verwendung der LDAP-basierten Authentifizierung wird eine LDAPS-Verbindung (Port <code>636</code>) von den <code>bluespice/wiki</code>-Containern zum LDAP-Server aufgebaut.
** Bei Verwendung der Kerberos-Authentifizierung wird eine Verbindung (Port <code>88</code>) von den <code>bluespice/kerberos-proxy</code>-Containern zum Kerberos-Server aufgebaut.
** Bei Verwendung von DeepL- oder OpenAI-Diensten wird eine HTTPS-Verbindung (Port <code>443</code>) von den <code>bluespice/wiki</code>-Containern zum jeweiligen Dienst aufgebaut.
** Bei Verwendung der OpenIDConnect-Authentifizierung wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>bluespice/wiki</code>-"Task"-Container zum Authentifizierungsanbieter aufgebaut.
** Bei Verwendung von "Let's Encrypt" Certbot wird eine HTTPS-Verbindung (Port <code>443</code>) vom <code>acme-companion</code>-Container zum Dienst „Let’s Encrypt“ aufgebaut.

== Schritt 1: Den Stack abrufen ==
Von https://github.com/hallowelt/bluespice-deploy/releases/latest die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/tags/5.1.1.zip \
&& unzip 5.1.1.zip \
&& cd bluespice-deploy-5.1.1/compose
</syntaxhighlight>

{{Textbox|boxtype=warning|header=PRO und FARM Editionen|text=Alle Servicekonfigurationen für die PRO- und FARM-Edition sind bereits enthalten, das Hauptanwendungsimage <code>bluespice/wiki</code> muss jedoch separat bezogen werden. Siehe [[{{FULLPAGENAME}}/Pro und Farm Edition|Pro und Farm Edition]] für weitere Details.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
! style="" |Typ
! style="" |Pflichtfeld
! style="" |Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
| style="" |bash-script
| style="" |false
| style="" |Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
| style="" |yml
| style="" |true
| style="" |Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
| style="" |yml
| style="" |false
| style="" |Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
| style="" |yml
| style="" |true
| style="" |PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
| style="" |yml
| style="" |false, aber empfohlen
| style="" |Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
| style="" |yml
| style="" |false
| style="" |Zusätzlicher Service zur automatischen Verlängerung von „Let's Encrypt“-Zertifikaten
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
| style="" |yml
| style="" |false
| style="" |Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|-
| style="width:350px;" |<code>docker-compose.helper-service.yml</code>
| style="" |yml
| style="" |true
| style="" |Verschiedene Hilfscontainers für Dateisystem-Vorbereitung, Major-Upgrades und Backups
|-
| style="width:350px;" |<code>docker-compose.collabpads-service.yml</code>
| style="" |yml
| style="" |true
| style="" |Backend-Dienst für [[Referenz:CollabPads|CollabPads]] (in den Pro- und Farm-Editionen enthalten)
|-
| style="width:350px;" |<code>.env.sample</code>
| style="" |Text
| style="" |false
| style="" |Beispiel zum Erstellen von <code>.env</code>, das wichtige Umgebungsvariablen definiert
|-
| style="width:350px;" |<code>bluespice.service.demo</code>
| style="" |service-script
| style="" |false
| style="" |Richtige Handhabung der Container beim Neustart
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten vier <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche Dienste können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

== Schritt 2: Umgebungsvariablen einrichten ==
Erstellen Sie die Datei <code>.env</code> entsprechend der vorhandenen oder zukünftigen Installation.

Beispiel:<syntaxhighlight lang="text">
DATADIR=/data/bluespice
VERSION=5.1
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=...

</syntaxhighlight>

== Schritt 3: Datenverzeichnisse vorbereiten ==
Ausführen Das Skript <code>bluespice-prepare</code> hilft Ihnen beim Einrichten der richtigen Ordnerstruktur und Berechtigungen. Außerdem wird ein Dienst für die ordnungsgemäße Handhabung der Container bei Neustarts installiert. Stellen Sie sicher, dass Sie diesen Befehl in einem privilegierten Benutzerkontext (wie <code>root</code>) ausführen, da er Berechtigungen für die neu erstellten Verzeichnisse festlegt.
{{Textbox|boxtype=note|header=Different editions|text=Das Beispiel zeigt <code>EDITION=pro</code>. Beachten Sie, dass Sie für <code>pro</code> und <code>farm</code> bei <code>docker.bluespice.com</code> angemeldet sein müssen.|icon=yes}}

== Schritt 4: Stack starten ==
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/adminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

== Zusätzliche Optionen ==

=== SSL-Zertifikate ===
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

=== Dienst auf Betriebssystemebene ===
{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

=== Benutzerdefinierte Wiki-Anwendungskonfiguration ===
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init-Prozess übernommen werden kann
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

=== Benutzerdefinierte Datenbank und Suche ===
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

=== Kerberos-Proxy ===
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

=== SAML-Authentifizierung ===
Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

=== OpenID Connect-Authentifizierung ===
Die Erweiterungen „PluggableAuth“ und „OpenIDConnect“ müssen im Wiki aktiviert sein. Fügen Sie dazu<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'OpenIDConnect'
] );
</syntaxhighlight>zur Datei <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> hinzu. Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Anschließend kann die Konfiguration des Authentifizierungs-Plugins in der [[Handbuch:Erweiterung/BlueSpiceConfigManager|Konfigurationsverwaltung]] unter „Authentifizierung“ angewendet werden.
[[en:Setup:Installation_Guide/Docker]]

Handbuch:Erweiterung/Lingo

2025-06-24T09:15:33Z

Hjing:

Mit [[Handbuch:Wikitext|Wikitext]]-Syntax läßt sich im Wiki ein Glossar erstellen (über die vorinstallierte Erweiterung ''Lingo''). Taucht ein Begriff auf einer Wikiseite auf, so wird über die Maus die Definition angezeigt.

== Glossar anlegen ==
'''So erstellen Sie das Glossar:'''
#'''Erstellen''' Sie die Seite "Glossar" im Hauptnamensraum, falls sie noch nicht existiert.
#'''Geben''' Sie den Begriff und die zugehörige Begriffsdefinition im Quelltext der Seite '''ein'''.
#'''Speichern''' Sie die Seite.

Merkmale eines Begriffs:

*Ein Begriff kann mehrere Definitionen anzeigen (siehe Beispiel ''AA'')
*Eine Begriffsdefinition kann weiterführende Links enthalten (Siehe Beispiel ''Reisehinweis'')
[[Datei:glossar.png|mini|alternativtext=Begriff mit Begriffsdefinition.|zentriert|300x300px|Begriff mit Begriffsdefinition.]]<syntaxhighlight lang="text">
;AA
:Auswärtiges Amt
:Ausschuss für Auswärtige Angelegenheiten

;Reisehinweis
:Informationen zu den für Reisende relevanten Besonderheiten eines Landes, den Einreisebestimmungen in fremde Länder, zu Zollvorschriften und strafrechtlichen Vorschriften und zu medizinischen Hinweisen. -> [[Sicherheitshinweis]] -> [[Reisewarnung]]

;U.S.A.
;USA
:United States of America
</syntaxhighlight>

== Glossardefinition verbergen ==
Wenn auf einer Seite keine Begriffsdefinitionen angezeigt werden sollen, fügen Sie die Anweisung <nowiki>__NOGLOSSARY__</nowiki> an einer beliebigen Stelle im Quelltext dieses Artikels einfügen.

In einigen Fällen kann es erforderlich sein, nur Teile einer Seite auszuschließen. Dies kann erreicht werden, indem dieser Teil in ein HTML-Element eingeschlossen und class="noglossary" angegeben wird:<syntaxhighlight lang="text">
<span class="noglossary">In diesem Fließttext innerhalb eines Absatzes wird keine Definition angezeigt</span>

<div class="noglossary">In diesem Seitenabschnitt wird keine Definition angezeigt</div>
</syntaxhighlight>Als Abkürzung für <nowiki><span class="noglossary"> können Sie einfach das Tag ‎<noglossary> verwenden:</nowiki><syntaxhighlight lang="text">
<noglossary>In diesem Fließttext innerhalb eines Absatzes wird keine Definition angezeigt</noglossary>
</syntaxhighlight>

== Anzeige als Tabelle mit Inhaltsverzeichnis als Sprunglinks ==
[[Datei:Glossar-Anpassung.png|alternativtext=Alphabetisches Glossar als Tabelle mit Sprunglinks zu Seitenbeginn|zentriert|mini|650x650px|angepasstes Glossar]]

So formatieren Sie das Glossar als Tabelle mit Sprunglinks zu den alphabetischen Einträgen:

# '''Kopieren''' Sie ans Ende der Seite <code>MediaWiki:Common.css</code> folgende Formatierungsanweisungen und speichern Sie die Seite:<syntaxhighlight lang="css">
/*Glossar als Tabelle formatieren */

#glossar h2 {font-size:1.4em; margin:0}
#glossar dl {
border: 1px solid #d8d8d9;
display: grid;
grid-template-columns: 200px 1fr;
}

#glossar dt,
#glossar dd {
border-bottom: 1px solid #aeaeae;
padding: 8px;
margin:0;
}

#glossar dt:last-of-type,
#glossar dd:last-of-type {
border-bottom: none;
}

#glossar dt{
font-weight: bold;
grid-column: 1;
}

#glossar dd {
border-left: 1px solid #aeaeae;
margin-left: 0;
grid-column: 2;
}

/* TOC auf der Glossar-Seite als Sprunglinks anzeigen.*/

.page-Glossar .tocnumber {display:none} /*hide numbering if set*/
.page-Glossar .toctext {padding-left:10px;} /*adds left-padding if no numbers are shown*/
.page-Glossar .toctitle {display:none} /*hide title if set*/
.page-Glossar #toc {background:#efefef}
.page-Glossar ul > li.toclevel-1 {display:inline-block}
.page-Glossar ul ul {display:none}
.page-Glossar ul > li.toclevel-1:after {content:'|'; padding-left:10px}
.page-Glossar ul > li.toclevel-1:last-child:after {content:''; padding-left:10px}
.page-Glossar .toc {width:100%;}
</syntaxhighlight>
# '''Fügen''' Sie im Quelltext der Seite ''Glossa''r ein <nowiki><div id="glossar">-Tag als Container ein. Dieses muss am Ende der Seite als </nowiki><code><nowiki></div></nowiki></code> geschlossen werden.
# '''Fügen''' Sie die Glossar-Einträge dazwischen ein.
# '''Geben''' Sie zu Beginn jedes alphabetischen Abschnitts den entsprechenden Buchstaben als Überschrift an.
# '''Stellen''' Sie in den Seitenoptionen die Einstellung ''Inhaltsverzeichnis erzwingen'' ein.[[Datei:Inhaltsverzeichnis erzwingen.png|alternativtext=geöffnetes Seitenoptionsmenü|zentriert|mini|450x450px|Inhalstverzeichnis erzwingen]]
# '''Speichern''' Sie die Seite.

Der Quelltext der Glossar-Seite sollte am Ende so aussehen:<syntaxhighlight lang="text">
<div id="glossar">

==N==
;Namensraum
:Organisationsprinzip in Mediawiki. Namensräume können einzeln verrechtet werden.

;NMV
:Neubaumietenverordnung

==R==
;RSS
:Real Simple Syndication. Anzeigeprotokoll für Newsfeeds.

==U==
;UNO
:United Nations Organisation

</div>

__INHALTSVERZEICHNIS_ERZWINGEN__
</syntaxhighlight>
__INHALTSVERZEICHNIS_ERZWINGEN__

Setup:Installationsanleitung/Migration von MediaWiki auf BlueSpice

2025-06-17T16:29:55Z

Hjing:

==Kompatibilitätscheck==
Vor der Migration ist es wichtig, die Kompatibilität Ihrer derzeitigen MediaWiki-Installation und der gewünschten Version von BlueSpice abzuklären:

*BlueSpice Version 3.x basiert auf MediaWiki 1.31.x
*BlueSpice Version 4.x vor 4.3 basiert auf MediaWiki 1.35.x
*BlueSpice Version 4.x nach 4.3 basiert auf MediaWiki 1.39.x
*BlueSpice Version 5.x basiert auf MediaWiki 1.43.x

==Backup==
Erstellen Sie ein vollständiges Backup Ihrer derzeitigen MediaWiki-Installation. Die Befehle können je nach Betriebssystem von den folgenden Angaben abweichen.

#Erstellen Sie ein Verzeichnis, in dem das Backup gespeichert wird:<syntaxhighlight>
mkdir -p /opt/mediawiki-migration-backup/{db,web}
</syntaxhighlight>
#Erstellen Sie eine Dump-Datei der Datenbank:<syntaxhighlight>
mysqldump -u DB_USER_OR_ROOT -p MEDIAWIKI_DATABASE_NAME > /opt/mediawiki-migration-backup/db/database.sql
</syntaxhighlight>
#Kopieren Sie alles aus dem Web-Rootverzeichnis in das Backup-Verzeichnis:<syntaxhighlight>
cp -Rvf /PATH/TO/MEDIAWIKI/FOLDER/* /opt/mediawiki-migration-backup/web/
</syntaxhighlight><br />Wir werden dieses Backup später auch im Migrationsprozess benutzen.

==Vorbereitung der Migration==
Sie können ein separates Benutzerkonto und eine separate Datenbank für BlueSpice erstellen. Dieser Schritt ist optional, aber empfohlen. Die folgenden Schritte basieren auf einem solchen separat erstellten Benutzer und einer separat erstellten Datenbank. Wenn Sie sich dafür entscheiden, keinen separaten Benutzer und keine separate Datenbank zu erstellen, dann ersetzen Sie die folgenden Befehle entsprechend.

#Erstellen Sie einen MySQL/MariaDB Benutzer über MySQL CLI:<syntaxhighlight lang="text">
CREATE USER 'bluespice'@'localhost' IDENFITIED BY 'PleaseChooseAComplexPassword';
</syntaxhighlight>
#Erstellen Sie eine Datenbank für BlueSpice über MySQL CLI:<syntaxhighlight lang="text">
CREATE DATABASE bluespice;
</syntaxhighlight>
#Gewähren Sie die dem bluespice Benutzer die nötigen Berechtigungen für die bluespice Datenbank über MySQL CLI:<syntaxhighlight lang="text">
GRANT ALL PRIVILEGES ON bluespice.* TO 'bluespice'@'localhost';
FLUSH PRIVILEGES;
</syntaxhighlight>Jetzt haben wir eine leere SQL Datenbank und können mit dem Importieren beginnen.

==Daten importieren==

#Importieren Sie den SQL-Dump aus dem vorher erstellten Backup:<syntaxhighlight lang="text">
mysql -u bluespice -p bluespice < /opt/mediawiki-migration-backup/db/database.sql
</syntaxhighlight>Geben Sie nach diesem Befehl das Passwort ein, das Sie für den bluespice Datenbankbenutzer gewählt haben.
#Bereiningen Sie das alte Installationsverzeichnis und erstellen Sie ein neues:<syntaxhighlight lang="text">
rm -Rf /PATH/TO/MEDIAWIKI/FOLDER/
</syntaxhighlight>and<syntaxhighlight lang="text">
mkdir -p /PATH/TO/MEDIAWIKI/FOLDER/
</syntaxhighlight>
#Extrahieren Sie das BlueSpice Installationspaket und legen Sie es in das Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ : <syntaxhighlight lang="text">
cd /PATH/TO/MEDIAWIKI/FOLDER/
</syntaxhighlight>
#Kopieren Sie das Verzeichnis ''images'' aus dem alten Backup zum neuen Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ :<syntaxhighlight lang="text">
cp -Rf /opt/mediawiki-migration-backup/images
</syntaxhighlight>
#Legen Sie die korrekten Berechtigungen (je nach Betriebssystem) zum Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ fest.

==Konfigurationseinstellungen==

{{Textbox|boxtype=important|header=|text=Wenn Sie mit <code>bluespice-deploy</code> auf [[Setup:Installationsanleitung/Docker|eine Docker-Installation]] migrieren, enthält Ihre neue Installation keine konkrete <code>LocalSettings.php</code>.

Stattdessen können Sie Ihre benutzerdefinierten Einstellungen in <code>pre-init-settings.php</code> oder <code>post-init-settings.php</code> hinzufügen.

Weitere Informationen finden Sie unter [[Setup:Installationsanleitung/Docker#Benutzerdefinierte_Wiki-Anwendungskonfiguration]].|icon=yes}}
#Erstellen Sie im Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ eine neue Datei ''LocalSettings.php'' und kopieren Sie folgenden Inhalt in diese Datei:<syntaxhighlight lang="text">
"$wgResourceBasePath/resources/assets/wiki.png" ];

## in the following, UPO means: this setting also exists as a user preference option

$wgEnableEmail = true;
$wgEnableUserEmail = true; # UPO

$wgEmergencyContact = "nomail@localhost.localdomain";
$wgPasswordSender = "nomail@localhost.localdomain";

$wgEnotifUserTalk = false; # UPO
$wgEnotifWatchlist = false; # UPO
$wgEmailAuthentication = true;

## Database settings
$wgDBtype = "mysql";
$wgDBserver = "YOUR_DATABASE_SERVER";
$wgDBname = "bluespice";
$wgDBuser = "bluespice";
$wgDBpassword = "PleaseChooseAComplexPassword";

# MySQL specific settings
$wgDBprefix = "";

# MySQL table options to use during installation or update
$wgDBTableOptions = "ENGINE=InnoDB, DEFAULT CHARSET=binary";

# Shared database table
# This has no effect unless $wgSharedDB is also set.
$wgSharedTables[] = "actor";

## Shared memory settings
$wgMainCacheType = CACHE_NONE;
$wgMemCachedServers = [];

## To enable image uploads, make sure the 'images' directory
## is writable, then set this to true:
$wgEnableUploads = false;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";

# InstantCommons allows wiki to use images from https://commons.wikimedia.org
$wgUseInstantCommons = false;

# Periodically send a pingback to https://www.mediawiki.org/ with basic data
# about this MediaWiki instance. The Wikimedia Foundation shares this data
# with MediaWiki developers to help guide future development efforts.
$wgPingback = false;

## If you use ImageMagick (or any other shell command) on a
## Linux server, this will need to be set to the name of an
## available UTF-8 locale. This should ideally be set to an English
## language locale so that the behaviour of C library functions will
## be consistent with typical installations. Use $wgLanguageCode to
## localise the wiki.
$wgShellLocale = "C.UTF-8";

## Set $wgCacheDirectory to a writable directory on the web server
## to make your wiki go slightly faster. The directory should not
## be publicly accessible from the web.
#$wgCacheDirectory = "$IP/cache";

# Site language code, should be one of the list in ./languages/data/Names.php
$wgLanguageCode = "en";

$wgSecretKey = "68a265061a4101d0d3dee2a06eeb734abaa6710a7dbe103838f2a26a50fc7835";

# Changing this will log out all existing sessions.
$wgAuthenticationTokenVersion = "1";

# Site upgrade key. Must be set to a string (default provided) to turn on the
# web installer while LocalSettings.php is in place
$wgUpgradeKey = "8775d57b99d672b8";

## For attaching licensing metadata to pages, and displaying an
## appropriate copyright notice / icon. GNU Free Documentation
## License and Creative Commons licenses are supported so far.
$wgRightsPage = ""; # Set to the title of a wiki page that describes your license/copyright
$wgRightsUrl = "";
$wgRightsText = "";
$wgRightsIcon = "";

# Path to the GNU diff3 utility. Used for conflict resolution.
$wgDiff3 = "/usr/bin/diff3";

## Default skin: you can change the default skin. Use the internal symbolic
## names, ie 'vector', 'monobook':
$wgDefaultSkin = "bluespicediscovery";

# End of automatically generated settings.
# Add more configuration options below.

# This is the main settings file for all BlueSpice extensions and settings
# It will include all files in "$IP/settings.d/" directory
require_once "$IP/LocalSettings.BlueSpice.php";

$wgUserMergeProtectedGroups = array();
$wgUserMergeUnmergeable = array();
$wgMetaNamespace = 'Project';
$bsgGroupRoles['*']['reader'] = false;

# Convenience for debugging
# $wgShowSQLErrors = true;
# $wgDebugDumpSql = true;
# $wgShowExceptionDetails = true;
# $wgShowDBErrorBacktrace = true;
</syntaxhighlight>
#Bearbeiten Sie diese ''LocalSettings.php'' und passen Sie die Werte Ihrer Installation entsprechend an. Diese aktuelle ''LocalSettings.php'' kann sich von Ihrer bisherigen MediaWiki-Installation unterscheiden, da BlueSpice ein separates Verzeichnis für Konfigurationsanpassungen benutzt (''settings.d''). <br />

==Migration des Systems==

#Führen Sie folgendes Skript aus, um die Migration zu starten:<syntaxhighlight lang="text">
php /PATH/TO/MEDIAWIKI/FOLDER/maintenance/update.php --quick
</syntaxhighlight>BlueSpice sollte nun erreichbar sein.
#Führen Sie zum Abschluss noch folgende Skripte aus: (Bereiten Sie [[Archiv:Setup:Installationsanleitung/Systemvorbereitung/Linux/OpenSearch|OpenSearch]] vor, bevor Sie den Suchindex starten.):<syntaxhighlight lang="text">
php /PATH/TO/MEDIAWIKI/FOLDER/maintenance/rebuildall.php

php /PATH/TO/MEDIAWIKI/FOLDER/extensions/BlueSpiceExtendedSearch/maintenance/initBackends.php --quick
php /PATH/TO/MEDIAWIKI/FOLDER/extensions/BlueSpiceExtendedSearch/maintenance/rebuildIndex.php --quick

php /PATH/TO/MEDIAWIKI/FOLDER/maintenance/runJobs.php --memory-limit=max
</syntaxhighlight><br />

Die Migration ist komplett und BlueSpice ist nun einsatzbereit!

Sie können Ihre alten Anmeldedaten zum Login benutzen.

==Nach der Migration==
Bitte überprüfen und bereinigen Sie Ihre Seiten <code>MediaWiki:Common.js</code> und <code>MediaWiki:Common.css</code> und prüfen Sie, ob veraltete Skriptteile und Stilregeln vorhanden sind, die möglicherweise nicht mit der BlueSpice-Oberfläche kompatibel sind. Standardmäßig enthält BlueSpice auf diesen beiden Seiten keine funktionierenden Inhalte.

Fragen?

Hilfe finden Sie im [https://community.bluespice.com BlueSpice-Hilfeforum].

<br />
[[de:{{FULLPAGENAME}}]]
[[en:Setup:Installation_Guide/Migration_from_MediaWiki_to_BlueSpice]]

Setup:Installationsanleitung/Migration von MediaWiki auf BlueSpice

2025-06-17T16:15:05Z

Hjing: /* Konfigurationseinstellungen */

==Kompatibilitätscheck==
Vor der Migration ist es wichtig, die Kompatibilität Ihrer derzeitigen MediaWiki-Installation und der gewünschten Version von BlueSpice abzuklären:

*BlueSpice Version 3.x basiert auf MediaWiki 1.31.x
*BlueSpice Version 4.x vor 4.3 basiert auf MediaWiki 1.35.x
*BlueSpice Version 4.x nach 4.3 basiert auf MediaWiki 1.39.x
*BlueSpice Version 5.x basiert auf MediaWiki 1.43.x

==Backup==
Erstellen Sie ein vollständiges Backup Ihrer derzeitigen MediaWiki-Installation. Die Befehle können je nach Betriebssystem von den folgenden Angaben abweichen.

#Erstellen Sie ein Verzeichnis, in dem das Backup gespeichert wird:<syntaxhighlight>
mkdir -p /opt/mediawiki-migration-backup/{db,web}
</syntaxhighlight>
#Erstellen Sie eine Dump-Datei der Datenbank:<syntaxhighlight>
mysqldump -u DB_USER_OR_ROOT -p MEDIAWIKI_DATABASE_NAME > /opt/mediawiki-migration-backup/db/database.sql
</syntaxhighlight>
#Kopieren Sie alles aus dem Web-Rootverzeichnis in das Backup-Verzeichnis:<syntaxhighlight>
cp -Rvf /PATH/TO/MEDIAWIKI/FOLDER/* /opt/mediawiki-migration-backup/web/
</syntaxhighlight><br />Wir werden dieses Backup später auch im Migrationsprozess benutzen.

==Vorbereitung der Migration==
Sie können ein separates Benutzerkonto und eine separate Datenbank für BlueSpice erstellen. Dieser Schritt ist optional, aber empfohlen. Die folgenden Schritte basieren auf einem solchen separat erstellten Benutzer und einer separat erstellten Datenbank. Wenn Sie sich dafür entscheiden, keinen separaten Benutzer und keine separate Datenbank zu erstellen, dann ersetzen Sie die folgenden Befehle entsprechend.

#Erstellen Sie einen MySQL/MariaDB Benutzer über MySQL CLI:<syntaxhighlight lang="text">
CREATE USER 'bluespice'@'localhost' IDENFITIED BY 'PleaseChooseAComplexPassword';
</syntaxhighlight>
#Erstellen Sie eine Datenbank für BlueSpice über MySQL CLI:<syntaxhighlight lang="text">
CREATE DATABASE bluespice;
</syntaxhighlight>
#Gewähren Sie die dem bluespice Benutzer die nötigen Berechtigungen für die bluespice Datenbank über MySQL CLI:<syntaxhighlight lang="text">
GRANT ALL PRIVILEGES ON bluespice.* TO 'bluespice'@'localhost';
FLUSH PRIVILEGES;
</syntaxhighlight>Jetzt haben wir eine leere SQL Datenbank und können mit dem Importieren beginnen.

==Daten importieren==

#Importieren Sie den SQL-Dump aus dem vorher erstellten Backup:<syntaxhighlight lang="text">
mysql -u bluespice -p bluespice < /opt/mediawiki-migration-backup/db/database.sql
</syntaxhighlight>Geben Sie nach diesem Befehl das Passwort ein, das Sie für den bluespice Datenbankbenutzer gewählt haben.
#Bereiningen Sie das alte Installationsverzeichnis und erstellen Sie ein neues:<syntaxhighlight lang="text">
rm -Rf /PATH/TO/MEDIAWIKI/FOLDER/
</syntaxhighlight>and<syntaxhighlight lang="text">
mkdir -p /PATH/TO/MEDIAWIKI/FOLDER/
</syntaxhighlight>
#Extrahieren Sie das BlueSpice Installationspaket und legen Sie es in das Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ : <syntaxhighlight lang="text">
cd /PATH/TO/MEDIAWIKI/FOLDER/
</syntaxhighlight>
#Kopieren Sie das Verzeichnis ''images'' aus dem alten Backup zum neuen Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ :<syntaxhighlight lang="text">
cp -Rf /opt/mediawiki-migration-backup/images
</syntaxhighlight>
#Legen Sie die korrekten Berechtigungen (je nach Betriebssystem) zum Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ fest.

==Konfigurationseinstellungen==

{{Textbox|boxtype=important|header=|text=Wenn Sie mit <code>bluespice-deploy</code> auf [[Setup:Installationsanleitung/Docker|eine Docker-Installation]] migrieren, enthält Ihre neue Installation keine konkrete <code>LocalSettings.php</code>.

Stattdessen können Sie Ihre benutzerdefinierten Einstellungen in <code>pre-init-settings.php</code> oder <code>post-init-settings.php</code> hinzufügen.

Weitere Informationen finden Sie unter [[Setup:Installationsanleitung/Docker#Benutzerdefinierte_Wiki-Anwendungskonfiguration]].|icon=yes}}
#Erstellen Sie im Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ eine neue Datei ''LocalSettings.php'' und kopieren Sie folgenden Inhalt in diese Datei:<syntaxhighlight lang="text">
"$wgResourceBasePath/resources/assets/wiki.png" ];

## in the following, UPO means: this setting also exists as a user preference option

$wgEnableEmail = true;
$wgEnableUserEmail = true; # UPO

$wgEmergencyContact = "nomail@localhost.localdomain";
$wgPasswordSender = "nomail@localhost.localdomain";

$wgEnotifUserTalk = false; # UPO
$wgEnotifWatchlist = false; # UPO
$wgEmailAuthentication = true;

## Database settings
$wgDBtype = "mysql";
$wgDBserver = "YOUR_DATABASE_SERVER";
$wgDBname = "bluespice";
$wgDBuser = "bluespice";
$wgDBpassword = "PleaseChooseAComplexPassword";

# MySQL specific settings
$wgDBprefix = "";

# MySQL table options to use during installation or update
$wgDBTableOptions = "ENGINE=InnoDB, DEFAULT CHARSET=binary";

# Shared database table
# This has no effect unless $wgSharedDB is also set.
$wgSharedTables[] = "actor";

## Shared memory settings
$wgMainCacheType = CACHE_NONE;
$wgMemCachedServers = [];

## To enable image uploads, make sure the 'images' directory
## is writable, then set this to true:
$wgEnableUploads = false;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";

# InstantCommons allows wiki to use images from https://commons.wikimedia.org
$wgUseInstantCommons = false;

# Periodically send a pingback to https://www.mediawiki.org/ with basic data
# about this MediaWiki instance. The Wikimedia Foundation shares this data
# with MediaWiki developers to help guide future development efforts.
$wgPingback = false;

## If you use ImageMagick (or any other shell command) on a
## Linux server, this will need to be set to the name of an
## available UTF-8 locale. This should ideally be set to an English
## language locale so that the behaviour of C library functions will
## be consistent with typical installations. Use $wgLanguageCode to
## localise the wiki.
$wgShellLocale = "C.UTF-8";

## Set $wgCacheDirectory to a writable directory on the web server
## to make your wiki go slightly faster. The directory should not
## be publicly accessible from the web.
#$wgCacheDirectory = "$IP/cache";

# Site language code, should be one of the list in ./languages/data/Names.php
$wgLanguageCode = "en";

$wgSecretKey = "68a265061a4101d0d3dee2a06eeb734abaa6710a7dbe103838f2a26a50fc7835";

# Changing this will log out all existing sessions.
$wgAuthenticationTokenVersion = "1";

# Site upgrade key. Must be set to a string (default provided) to turn on the
# web installer while LocalSettings.php is in place
$wgUpgradeKey = "8775d57b99d672b8";

## For attaching licensing metadata to pages, and displaying an
## appropriate copyright notice / icon. GNU Free Documentation
## License and Creative Commons licenses are supported so far.
$wgRightsPage = ""; # Set to the title of a wiki page that describes your license/copyright
$wgRightsUrl = "";
$wgRightsText = "";
$wgRightsIcon = "";

# Path to the GNU diff3 utility. Used for conflict resolution.
$wgDiff3 = "/usr/bin/diff3";

## Default skin: you can change the default skin. Use the internal symbolic
## names, ie 'vector', 'monobook':
$wgDefaultSkin = "bluespicediscovery";

# End of automatically generated settings.
# Add more configuration options below.

# This is the main settings file for all BlueSpice extensions and settings
# It will include all files in "$IP/settings.d/" directory
require_once "$IP/LocalSettings.BlueSpice.php";

$wgUserMergeProtectedGroups = array();
$wgUserMergeUnmergeable = array();
$wgMetaNamespace = 'Project';
$bsgGroupRoles['*']['reader'] = false;

# Convenience for debugging
# $wgShowSQLErrors = true;
# $wgDebugDumpSql = true;
# $wgShowExceptionDetails = true;
# $wgShowDBErrorBacktrace = true;
</syntaxhighlight>
#Bearbeiten Sie diese ''LocalSettings.php'' und passen Sie die Werte Ihrer Installation entsprechend an. Diese aktuelle ''LocalSettings.php'' kann sich von Ihrer bisherigen MediaWiki-Installation unterscheiden, da BlueSpice ein separates Verzeichnis für Konfigurationsanpassungen benutzt (''settings.d''). <br />

==Migration des Systems==

#Führen Sie folgendes Skript aus, um die Migration zu starten:<syntaxhighlight lang="text">
php /PATH/TO/MEDIAWIKI/FOLDER/maintenance/update.php --quick
</syntaxhighlight>BlueSpice sollte nun erreichbar sein.
#Führen Sie zum Abschluss noch folgende Skripte aus:<syntaxhighlight lang="text">
php /PATH/TO/MEDIAWIKI/FOLDER/maintenance/rebuildall.php
# Schließlich für den Suchindex (ElasticSearch 6.x und ingest-attachment Plugins müssen installiert sein)
php /PATH/TO/MEDIAWIKI/FOLDER/extensions/BlueSpiceExtendedSearch/maintenance/initBackends.php --quick
php /PATH/TO/MEDIAWIKI/FOLDER/extensions/BlueSpiceExtendedSearch/maintenance/rebuildIndex.php --quick
php /PATH/TO/MEDIAWIKI/FOLDER/maintenance/runJobs.php --memory-limit=max
</syntaxhighlight><br />

Die Migration ist komplett und BlueSpice ist nun einsatzbereit!

Sie können Ihre alten Anmeldedaten zum Login benutzen.

==Nach der Migration==
Bitte überprüfen und bereinigen Sie Ihre Seiten <code>MediaWiki:Common.js</code> und <code>MediaWiki:Common.css</code> und prüfen Sie, ob veraltete Skriptteile und Stilregeln vorhanden sind, die möglicherweise nicht mit der BlueSpice-Oberfläche kompatibel sind. Standardmäßig enthält BlueSpice auf diesen beiden Seiten keine funktionierenden Inhalte.

Fragen?

Hilfe finden Sie im [https://community.bluespice.com BlueSpice-Hilfeforum].

<br />
[[de:{{FULLPAGENAME}}]]
[[en:Setup:Installation_Guide/Migration_from_MediaWiki_to_BlueSpice]]

Setup:Installationsanleitung/Migration von MediaWiki auf BlueSpice

2025-06-17T16:13:52Z

Hjing:

==Kompatibilitätscheck==
Vor der Migration ist es wichtig, die Kompatibilität Ihrer derzeitigen MediaWiki-Installation und der gewünschten Version von BlueSpice abzuklären:

*BlueSpice Version 3.x basiert auf MediaWiki 1.31.x
*BlueSpice Version 4.x vor 4.3 basiert auf MediaWiki 1.35.x
*BlueSpice Version 4.x nach 4.3 basiert auf MediaWiki 1.39.x
*BlueSpice Version 5.x basiert auf MediaWiki 1.43.x

==Backup==
Erstellen Sie ein vollständiges Backup Ihrer derzeitigen MediaWiki-Installation. Die Befehle können je nach Betriebssystem von den folgenden Angaben abweichen.

#Erstellen Sie ein Verzeichnis, in dem das Backup gespeichert wird:<syntaxhighlight>
mkdir -p /opt/mediawiki-migration-backup/{db,web}
</syntaxhighlight>
#Erstellen Sie eine Dump-Datei der Datenbank:<syntaxhighlight>
mysqldump -u DB_USER_OR_ROOT -p MEDIAWIKI_DATABASE_NAME > /opt/mediawiki-migration-backup/db/database.sql
</syntaxhighlight>
#Kopieren Sie alles aus dem Web-Rootverzeichnis in das Backup-Verzeichnis:<syntaxhighlight>
cp -Rvf /PATH/TO/MEDIAWIKI/FOLDER/* /opt/mediawiki-migration-backup/web/
</syntaxhighlight><br />Wir werden dieses Backup später auch im Migrationsprozess benutzen.

==Vorbereitung der Migration==
Sie können ein separates Benutzerkonto und eine separate Datenbank für BlueSpice erstellen. Dieser Schritt ist optional, aber empfohlen. Die folgenden Schritte basieren auf einem solchen separat erstellten Benutzer und einer separat erstellten Datenbank. Wenn Sie sich dafür entscheiden, keinen separaten Benutzer und keine separate Datenbank zu erstellen, dann ersetzen Sie die folgenden Befehle entsprechend.

#Erstellen Sie einen MySQL/MariaDB Benutzer über MySQL CLI:<syntaxhighlight lang="text">
CREATE USER 'bluespice'@'localhost' IDENFITIED BY 'PleaseChooseAComplexPassword';
</syntaxhighlight>
#Erstellen Sie eine Datenbank für BlueSpice über MySQL CLI:<syntaxhighlight lang="text">
CREATE DATABASE bluespice;
</syntaxhighlight>
#Gewähren Sie die dem bluespice Benutzer die nötigen Berechtigungen für die bluespice Datenbank über MySQL CLI:<syntaxhighlight lang="text">
GRANT ALL PRIVILEGES ON bluespice.* TO 'bluespice'@'localhost';
FLUSH PRIVILEGES;
</syntaxhighlight>Jetzt haben wir eine leere SQL Datenbank und können mit dem Importieren beginnen.

==Daten importieren==

#Importieren Sie den SQL-Dump aus dem vorher erstellten Backup:<syntaxhighlight lang="text">
mysql -u bluespice -p bluespice < /opt/mediawiki-migration-backup/db/database.sql
</syntaxhighlight>Geben Sie nach diesem Befehl das Passwort ein, das Sie für den bluespice Datenbankbenutzer gewählt haben.
#Bereiningen Sie das alte Installationsverzeichnis und erstellen Sie ein neues:<syntaxhighlight lang="text">
rm -Rf /PATH/TO/MEDIAWIKI/FOLDER/
</syntaxhighlight>and<syntaxhighlight lang="text">
mkdir -p /PATH/TO/MEDIAWIKI/FOLDER/
</syntaxhighlight>
#Extrahieren Sie das BlueSpice Installationspaket und legen Sie es in das Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ : <syntaxhighlight lang="text">
cd /PATH/TO/MEDIAWIKI/FOLDER/
</syntaxhighlight>
#Kopieren Sie das Verzeichnis ''images'' aus dem alten Backup zum neuen Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ :<syntaxhighlight lang="text">
cp -Rf /opt/mediawiki-migration-backup/images
</syntaxhighlight>
#Legen Sie die korrekten Berechtigungen (je nach Betriebssystem) zum Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ fest.

==Konfigurationseinstellungen==

{{Textbox|boxtype=important|header=|text=Wenn Sie mit <code>bluespice-deploy</code> auf [[Setup:Installation_Guide/Docker|eine Docker-Installation]] migrieren, enthält Ihre neue Installation keine konkrete <code>LocalSettings.php</code>.

Stattdessen können Sie Ihre benutzerdefinierten Einstellungen in <code>pre-init-settings.php</code> oder <code>post-init-settings.php</code> hinzufügen.

Weitere Informationen finden Sie unter [[Setup:Installation_Guide/Docker#Benutzerdefinierte_Wiki-Anwendungskonfiguration]].|icon=yes}}
#Erstellen Sie im Verzeichnis /PATH/TO/MEDIAWIKI/FOLDER/ eine neue Datei ''LocalSettings.php'' und kopieren Sie folgenden Inhalt in diese Datei:<syntaxhighlight lang="text">
"$wgResourceBasePath/resources/assets/wiki.png" ];

## in the following, UPO means: this setting also exists as a user preference option

$wgEnableEmail = true;
$wgEnableUserEmail = true; # UPO

$wgEmergencyContact = "nomail@localhost.localdomain";
$wgPasswordSender = "nomail@localhost.localdomain";

$wgEnotifUserTalk = false; # UPO
$wgEnotifWatchlist = false; # UPO
$wgEmailAuthentication = true;

## Database settings
$wgDBtype = "mysql";
$wgDBserver = "YOUR_DATABASE_SERVER";
$wgDBname = "bluespice";
$wgDBuser = "bluespice";
$wgDBpassword = "PleaseChooseAComplexPassword";

# MySQL specific settings
$wgDBprefix = "";

# MySQL table options to use during installation or update
$wgDBTableOptions = "ENGINE=InnoDB, DEFAULT CHARSET=binary";

# Shared database table
# This has no effect unless $wgSharedDB is also set.
$wgSharedTables[] = "actor";

## Shared memory settings
$wgMainCacheType = CACHE_NONE;
$wgMemCachedServers = [];

## To enable image uploads, make sure the 'images' directory
## is writable, then set this to true:
$wgEnableUploads = false;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";

# InstantCommons allows wiki to use images from https://commons.wikimedia.org
$wgUseInstantCommons = false;

# Periodically send a pingback to https://www.mediawiki.org/ with basic data
# about this MediaWiki instance. The Wikimedia Foundation shares this data
# with MediaWiki developers to help guide future development efforts.
$wgPingback = false;

## If you use ImageMagick (or any other shell command) on a
## Linux server, this will need to be set to the name of an
## available UTF-8 locale. This should ideally be set to an English
## language locale so that the behaviour of C library functions will
## be consistent with typical installations. Use $wgLanguageCode to
## localise the wiki.
$wgShellLocale = "C.UTF-8";

## Set $wgCacheDirectory to a writable directory on the web server
## to make your wiki go slightly faster. The directory should not
## be publicly accessible from the web.
#$wgCacheDirectory = "$IP/cache";

# Site language code, should be one of the list in ./languages/data/Names.php
$wgLanguageCode = "en";

$wgSecretKey = "68a265061a4101d0d3dee2a06eeb734abaa6710a7dbe103838f2a26a50fc7835";

# Changing this will log out all existing sessions.
$wgAuthenticationTokenVersion = "1";

# Site upgrade key. Must be set to a string (default provided) to turn on the
# web installer while LocalSettings.php is in place
$wgUpgradeKey = "8775d57b99d672b8";

## For attaching licensing metadata to pages, and displaying an
## appropriate copyright notice / icon. GNU Free Documentation
## License and Creative Commons licenses are supported so far.
$wgRightsPage = ""; # Set to the title of a wiki page that describes your license/copyright
$wgRightsUrl = "";
$wgRightsText = "";
$wgRightsIcon = "";

# Path to the GNU diff3 utility. Used for conflict resolution.
$wgDiff3 = "/usr/bin/diff3";

## Default skin: you can change the default skin. Use the internal symbolic
## names, ie 'vector', 'monobook':
$wgDefaultSkin = "bluespicediscovery";

# End of automatically generated settings.
# Add more configuration options below.

# This is the main settings file for all BlueSpice extensions and settings
# It will include all files in "$IP/settings.d/" directory
require_once "$IP/LocalSettings.BlueSpice.php";

$wgUserMergeProtectedGroups = array();
$wgUserMergeUnmergeable = array();
$wgMetaNamespace = 'Project';
$bsgGroupRoles['*']['reader'] = false;

# Convenience for debugging
# $wgShowSQLErrors = true;
# $wgDebugDumpSql = true;
# $wgShowExceptionDetails = true;
# $wgShowDBErrorBacktrace = true;
</syntaxhighlight>
#Bearbeiten Sie diese ''LocalSettings.php'' und passen Sie die Werte Ihrer Installation entsprechend an. Diese aktuelle ''LocalSettings.php'' kann sich von Ihrer bisherigen MediaWiki-Installation unterscheiden, da BlueSpice ein separates Verzeichnis für Konfigurationsanpassungen benutzt (''settings.d''). <br />

==Migration des Systems==

#Führen Sie folgendes Skript aus, um die Migration zu starten:<syntaxhighlight lang="text">
php /PATH/TO/MEDIAWIKI/FOLDER/maintenance/update.php --quick
</syntaxhighlight>BlueSpice sollte nun erreichbar sein.
#Führen Sie zum Abschluss noch folgende Skripte aus:<syntaxhighlight lang="text">
php /PATH/TO/MEDIAWIKI/FOLDER/maintenance/rebuildall.php
# Schließlich für den Suchindex (ElasticSearch 6.x und ingest-attachment Plugins müssen installiert sein)
php /PATH/TO/MEDIAWIKI/FOLDER/extensions/BlueSpiceExtendedSearch/maintenance/initBackends.php --quick
php /PATH/TO/MEDIAWIKI/FOLDER/extensions/BlueSpiceExtendedSearch/maintenance/rebuildIndex.php --quick
php /PATH/TO/MEDIAWIKI/FOLDER/maintenance/runJobs.php --memory-limit=max
</syntaxhighlight><br />

Die Migration ist komplett und BlueSpice ist nun einsatzbereit!

Sie können Ihre alten Anmeldedaten zum Login benutzen.

==Nach der Migration==
Bitte überprüfen und bereinigen Sie Ihre Seiten <code>MediaWiki:Common.js</code> und <code>MediaWiki:Common.css</code> und prüfen Sie, ob veraltete Skriptteile und Stilregeln vorhanden sind, die möglicherweise nicht mit der BlueSpice-Oberfläche kompatibel sind. Standardmäßig enthält BlueSpice auf diesen beiden Seiten keine funktionierenden Inhalte.

Fragen?

Hilfe finden Sie im [https://community.bluespice.com BlueSpice-Hilfeforum].

<br />
[[de:{{FULLPAGENAME}}]]
[[en:Setup:Installation_Guide/Migration_from_MediaWiki_to_BlueSpice]]

User blog:Hjing

2025-06-13T13:25:43Z

Hjing: Haupt-Blogseite erstellt

Setup:Installationsanleitung/Docker

2025-02-25T14:51:24Z

Hjing: fix data directory

{{Textbox
|boxtype=important
|header=Migration von 4.4
|text=Mit BlueSpice 4.5 gab es einige wichtige Änderungen am Container-Portfolio:
# Es gibt keine „All-in-One“-Container mehr. Weder für die ''free'' noch für die ''pro'' oder ''farm'' Editionen
# Das „Distributed-Services“-Setup für die ''pro'' und ''farm'' Editionen wurde komplett überarbeitet.
Wenn Sie von einem der oben genannten Setups aktualisieren, lesen Sie bitte den [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|Migrationsleitfaden]].
|icon=yes
}}

__TOC__

===Übersicht===
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

===Schritt 1: Den Stack abrufen===
Von https://github.com/hallowelt/bluespice-deploy die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/heads/main.zip \
&& unzip main.zip \
&& cd bluespice-deploy-main/compose
</syntaxhighlight>

{{Textbox|boxtype=important|header=PRO edition Stack|text=Aktuell ist nur der FREE edition Stack auf GitHub verfügbar. Wir planen auch den PRO Stack zu veröffentlichen. In der Zwischenzeit, kontaktieren Sie bitte unser Sales-Team, wenn Sie den PRO Stack zur Selbstinstallation benötigen.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
!Typ
!Pflichtfeld
!Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>bluespice-prepare</code>
|bash-script
|false
|Ordner und Berechtigungen vor dem ersten Start vorbereiten, registriert den Dienst auch beim Betriebssystem
|-
| style="width:350px;" |<code>bluespice.service</code>
|service-script
|false
|Richtige Handhabung der Container beim Neustart
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
|yml
|true
|Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
|yml
|false
|Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
|yml
|true
|PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
|yml
|false, aber empfohlen
|Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Zusätzlicher automatischer Erneuerungsdienst für „Let’s Encrypt“-Zertifikate
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten vier <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche Dienste können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

Beispiel:<syntaxhighlight lang="text">
bluespice-deploy \
-f docker-compose.proxy-letsencrypt.yml \
up -d
</syntaxhighlight>Dadurch wird der Stapel mit „Let’s Encrypt“-Zertifikaten gestartet. Weitere Einzelheiten finden Sie im Abschnitt [[#SSL-Zertifikate| SSL-Zertifikate]].

===Schritt 2: Umgebungsvariablen einrichten===
Erstellen Sie die Datei <code>.env</code> entsprechend der vorhandenen oder zukünftigen Installation.

Beispiel:<syntaxhighlight lang="text">
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=...
</syntaxhighlight>

===Schritt 3: Datenverzeichnisse vorbereiten===
Ausführen Das Skript <code>bluespice-prepare</code> hilft Ihnen beim Einrichten der richtigen Ordnerstruktur und Berechtigungen. Außerdem wird ein Dienst für die ordnungsgemäße Handhabung der Container bei Neustarts installiert. Stellen Sie sicher, dass Sie diesen Befehl in einem privilegierten Benutzerkontext (wie <code>root</code>) ausführen, da er Berechtigungen für die neu erstellten Verzeichnisse festlegt.

===Schritt 4: Stack starten===
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/adminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

===Zusätzliche Optionen===

====SSL-Zertifikate====
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

Wenn Sie SSL nach der ersten Erstellung des Wikis aktivieren, ändern Sie bitte <code>$wgServer</code> in <code>$DATADIR/wiki/bluespice/pre-init-settings.php</code>

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

verknüpfen Sie Ihr Zertifikat auch mit dem Bluespice-Container in Ihrer <code>docker-compose.yml</code>-Datei:

<code>- $DATADIR/proxy/certs/<FQDNofyourWiki>.crt:/usr/local/share/ca-certificates/<FQDNofyourWiki>.crt:ro</code>

Bitte starten Sie Container nach dem Ändern/Hinzufügen von SSL-Dateien neu.

====Dienst auf Betriebssystemebene====

{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

====Benutzerdefinierte Wiki-Anwendungskonfiguration====
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init übernommen werden kann Prozess
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

====Benutzerdefinierte Datenbank und Suche====
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

====Kerberos-Proxy====
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

====SAML-Authentifizierung====

Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

[[en:Setup:Installation_Guide/Docker]]

Setup:Installationsanleitung/Docker

2025-02-24T07:28:11Z

Hjing: Fix certificate directory

{{Textbox
|boxtype=important
|header=Migration von 4.4
|text=Mit BlueSpice 4.5 gab es einige wichtige Änderungen am Container-Portfolio:
# Es gibt keine „All-in-One“-Container mehr. Weder für die ''free'' noch für die ''pro'' oder ''farm'' Editionen
# Das „Distributed-Services“-Setup für die ''pro'' und ''farm'' Editionen wurde komplett überarbeitet.
Wenn Sie von einem der oben genannten Setups aktualisieren, lesen Sie bitte den [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|Migrationsleitfaden]].
|icon=yes
}}

__TOC__

===Übersicht===
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

===Schritt 1: Den Stack abrufen===
Von https://github.com/hallowelt/bluespice-deploy die „docker-compose“-Dateien abrufen.

Beispiel:
<syntaxhighlight lang="text">
wget https://github.com/hallowelt/bluespice-deploy/archive/refs/heads/main.zip \
&& unzip main.zip \
&& cd bluespice-deploy-main/compose
</syntaxhighlight>

{{Textbox|boxtype=important|header=PRO edition Stack|text=Aktuell ist nur der FREE edition Stack auf GitHub verfügbar. Wir planen auch den PRO Stack zu veröffentlichen. In der Zwischenzeit, kontaktieren Sie bitte unser Sales-Team, wenn Sie den PRO Stack zur Selbstinstallation benötigen.|icon=yes}}

Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
!Typ
!Pflichtfeld
!Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>bluespice-prepare</code>
|bash-script
|false
|Ordner und Berechtigungen vor dem ersten Start vorbereiten, registriert den Dienst auch beim Betriebssystem
|-
| style="width:350px;" |<code>bluespice.service</code>
|service-script
|false
|Richtige Handhabung der Container beim Neustart
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
|yml
|true
|Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
|yml
|false
|Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
|yml
|true
|PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
|yml
|false, aber empfohlen
|Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Zusätzlicher automatischer Erneuerungsdienst für „Let’s Encrypt“-Zertifikate
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten vier <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche Dienste können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

Beispiel:<syntaxhighlight lang="text">
bluespice-deploy \
-f docker-compose.proxy-letsencrypt.yml \
up -d
</syntaxhighlight>Dadurch wird der Stapel mit „Let’s Encrypt“-Zertifikaten gestartet. Weitere Einzelheiten finden Sie im Abschnitt [[#SSL-Zertifikate| SSL-Zertifikate]].

===Schritt 2: Umgebungsvariablen einrichten===
Erstellen Sie die Datei <code>.env</code> entsprechend der vorhandenen oder zukünftigen Installation.

Beispiel:<syntaxhighlight lang="text">
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=...
</syntaxhighlight>

===Schritt 3: Datenverzeichnisse vorbereiten===
Ausführen Das Skript <code>bluespice-prepare</code> hilft Ihnen beim Einrichten der richtigen Ordnerstruktur und Berechtigungen. Außerdem wird ein Dienst für die ordnungsgemäße Handhabung der Container bei Neustarts installiert. Stellen Sie sicher, dass Sie diesen Befehl in einem privilegierten Benutzerkontext (wie <code>root</code>) ausführen, da er Berechtigungen für die neu erstellten Verzeichnisse festlegt.

===Schritt 4: Stack starten===
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/adminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

===Zusätzliche Optionen===

====SSL-Zertifikate====
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.
{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${DATADIR}/proxy/certs</code> ein
|icon=yes
}}

Wenn Sie SSL nach der ersten Erstellung des Wikis aktivieren, ändern Sie bitte <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

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

verknüpfen Sie Ihr Zertifikat auch mit dem Bluespice-Container in Ihrer <code>docker-compose.yml</code>-Datei:

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

Bitte starten Sie Container nach dem Ändern/Hinzufügen von SSL-Dateien neu.

====Dienst auf Betriebssystemebene====

{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

====Benutzerdefinierte Wiki-Anwendungskonfiguration====
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init übernommen werden kann Prozess
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

====Benutzerdefinierte Datenbank und Suche====
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

====Kerberos-Proxy====
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

====SAML-Authentifizierung====

Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

[[en:Setup:Installation_Guide/Docker]]

Setup:Installationsanleitung/Docker

2025-01-07T07:52:44Z

Hjing: Fix typo in script of /* Schritt 1: Den Stack abrufen */

{{Textbox
|boxtype=important
|header=Migration von 4.4
|text=Mit BlueSpice 4.5 gab es einige wichtige Änderungen am Container-Portfolio:
# Es gibt keine „All-in-One“-Container mehr. Weder für die ''free'' noch für die ''pro'' oder ''farm'' Editionen
# Das „Distributed-Services“-Setup für die ''pro'' und ''farm'' Editionen wurde komplett überarbeitet.
Wenn Sie von einem der oben genannten Setups aktualisieren, lesen Sie bitte den [[{{FULLPAGENAME}}/Migration_4.4 to 4.5|Migrationsleitfaden]].
|icon=yes
}}

__TOC__

===Übersicht===
Seit Version 4.5 kann BlueSpice MediaWiki einfach mithilfe eines Stapels von Docker-Container-Images installiert werden. Alles ist modular aufgebaut, um verschiedene Arten von Setups zu ermöglichen.

Die häufigsten Fälle sind
#„All-in-one“ (mit und ohne Let’s Encrypt)
#Benutzerdefinierte Datenbank und Suchdienst
#Benutzerdefinierter Load Balancer / Proxy

===Schritt 1: Den Stack abrufen===
Von https://bluespice.com/de/download/ die „docker-compose“-Dateien abrufen<syntaxhighlight lang="text">
wget https://bluespice.com/filebase/docker-deployment-script \
&& unzip docker-deployment-script \
&& cd bluespice-deploy-main/compose
</syntaxhighlight>Das Verzeichnis enthält die folgenden Dateien:
{| class="wikitable"
|+
! style="width:350px;" |Dateiname
!Typ
!Pflichtfeld
!Kommentar
|-
| style="width:350px;" |<code>bluespice-deploy</code>
|bash-script
|false
|Wrapper für den allgemeinen Start der benötigten Container
|-
| style="width:350px;" |<code>bluespice-prepare</code>
|bash-script
|false
|Ordner und Berechtigungen vor dem ersten Start vorbereiten, registriert den Dienst auch beim Betriebssystem
|-
| style="width:350px;" |<code>bluespice.service</code>
|service-script
|false
|Richtige Handhabung der Container beim Neustart
|-
| style="width:350px;" |<code>docker-compose.main.yml</code>
|yml
|true
|Hauptanwendungsdienste/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.persistent-data-services.yml</code>
|yml
|false
|Datenbank und Suche/ ausgeführt von <code>bluespice-deploy</code>
|-
| style="width:350px;" |<code>docker-compose.stateless-services.yml</code>
|yml
|true
|PDF-Renderer/Cache/Formel/Diagramm-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy.yml</code>
|yml
|false, aber empfohlen
|Proxy-Dienst
|-
| style="width:350px;" |<code>docker-compose.proxy-letsencrypt.yml</code>
|yml
|false
|Zusätzlicher automatischer Erneuerungsdienst für „Let’s Encrypt“-Zertifikate
|-
| style="width:350px;" |<code>docker-compose.kerberos-proxy.yml</code>
|yml
|false
|Zusätzlicher Proxy für Kerberos-basierte Authentifizierung
|}

Der Einfachheit halber umschließt das Skript <code>bluespice-deploy</code> standardmäßig die ersten vier <code>yml</code>-Dateien. Dies umfasst die Haupt-Wiki-Anwendung und auch erforderliche Backend-Dienste wie eine Datenbank, eine Suche und einen Anwendungscache.

Zusätzliche Dienste können durch Hinzufügen von <code>-f <filename> </code> geladen werden.

Beispiel:<syntaxhighlight lang="text">
bluespice-deploy \
-f docker-compose.proxy-letsencrypt.yml \
up -d
</syntaxhighlight>Dadurch wird der Stapel mit „Let’s Encrypt“-Zertifikaten gestartet. Weitere Einzelheiten finden Sie im Abschnitt [[#SSL-Zertifikate| SSL-Zertifikate]].

===Schritt 2: Umgebungsvariablen einrichten===
Erstellen Sie die Datei <code>.env</code> entsprechend der vorhandenen oder zukünftigen Installation.

Beispiel:<syntaxhighlight lang="text">
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=...
</syntaxhighlight>

===Schritt 3: Datenverzeichnisse vorbereiten===
Ausführen Das Skript <code>bluespice-prepare</code> hilft Ihnen beim Einrichten der richtigen Ordnerstruktur und Berechtigungen. Außerdem wird ein Dienst für die ordnungsgemäße Handhabung der Container bei Neustarts installiert. Stellen Sie sicher, dass Sie diesen Befehl in einem privilegierten Benutzerkontext (wie <code>root</code>) ausführen, da er Berechtigungen für die neu erstellten Verzeichnisse festlegt.

===Schritt 4: Stack starten===
{{Textbox
|boxtype=important
|header=Erstinstallation
|text=Wenn Sie den Stapel zum ersten Mal starten, führt der Container <code>wiki-task</code> die Installation automatisch durch. Es kann einige Minuten dauern, bis der Vorgang die Datenbank eingerichtet und abgeschlossen hat. Sobald er abgeschlossen ist, finden Sie das Passwort für den Standardbenutzer <code>Admin</code> in <code>$DATADIR/wiki/adminPassword</code>.
|icon=yes
}}
Verwenden Sie <code>bluespice-deploy up -d</code>, um den Stack zu starten, sobald die <code>.env</code>-Datei und die „Datenverzeichnisse“ bereit sind. Sobald alle Container als „bereit“ angezeigt werden, können Sie in Ihrem bevorzugten Webbrowser zu <code>$WIKI_PROTOCOL://$WIKI_HOST:$WIKI_PORT</code> (z. B. <code><nowiki>https://wiki.company.local</nowiki></code>) navigieren und mit der Verwendung der Anwendung beginnen.

===Zusätzliche Optionen===

====SSL-Zertifikate====
Um Let’s Encrypt-Zertifikate zu verwenden, fügen Sie einfach <code>docker-compose.proxy-letsencrypt.yml</code> in Ihre <code>bluespice-deploy</code>-Datei ein.{{Textbox
|boxtype=tip
|header=Selbstsignierte Zertifikate
|text=Um selbstsignierte Zertifikate zu verwenden, geben Sie bitte <code><bluespice-wiki.com>.crt</code> und <code><bluespice-wiki.com>.key</code> mit dem genauen Namen der URL Ihres Wikis in <code>${VOLUMES_DIR}/nginx/certs</code> ein
|icon=yes
}}

Wenn Sie SSL nach der ersten Erstellung des Wikis aktivieren, ändern Sie bitte <code>$wgServer</code> in <code>${VOLUMES_DIR}/bluespice-data/LocalSettings.php</code>

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

verknüpfen Sie Ihr Zertifikat auch mit dem Bluespice-Container in Ihrer <code>docker-compose.yml</code>-Datei:

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

Bitte starten Sie Container nach dem Ändern/Hinzufügen von SSL-Dateien neu.

====Dienst auf Betriebssystemebene====

{{Textbox
|boxtype=tip
|header=Zusätzliche Dienste hinzufügen
|text=Erweitern Sie den Parameter <code>ExecStart</code> in <code>/etc/systemd/system/bluespice.service</code>
Beispiel:
ExecStart=<WORKDIR>/bluespice-deploy -f docker-compose.proxy-letsencrypt.yml up -f -d --remove-orphans
|icon=yes
}}

====Benutzerdefinierte Wiki-Anwendungskonfiguration====
Nach der Erstinstallation enthält <code>${DATADIR}/wiki/bluespice/</code> zwei Dateien, mit denen Sie eine benutzerdefinierte Anwendungskonfiguration festlegen können, wie sie unter [https://www.mediawiki.org mediawiki.org] zu finden ist:

*<code>pre-init-settings.php</code> - Kann verwendet werden, um eine Konfiguration festzulegen, die vom Init übernommen werden kann Prozess
*<code>post-init-settings.php</code> - Kann verwendet werden, um Konfigurationen zu manipulieren, die vom Init-Prozess festgelegt wurden

====Benutzerdefinierte Datenbank und Suche====
Wenn Sie einen MySQL/MariaDB- und einen OpenSearch-Server in Ihrem lokalen Netzwerk laufen haben, können Sie <code>docker-compose.persistent-data-services.yml</code> vollständig aus Ihrer <code>bluespice-deploy</code>-Datei entfernen. Stellen Sie sicher, dass Sie die richtigen Variablen in der <code>.env</code>-Datei festlegen.

====Kerberos-Proxy====
Für die implizite Authentifizierung mit Kerberos muss ein zusätzlicher Proxy verwendet werden: <code>bluespice/kerberos-proxy</code> . Die Datei <code>docker-compose.kerberos-proxy.yml</code> enthält eine gemeinsame Konfiguration. Es kann '''anstelle''' der regulären Datei <code>docker-compose.proxy.yml</code> in <code>bluespice-deploy</code> verwendet werden.

Stellen Sie sicher, dass die Dateien

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

richtig eingerichtet sind.

Die Datei <code>${DATADIR}/wiki/bluespice/pre-init-settings.php</code> kann dann verwendet werden, um „Extension:Auth_remoteuser“ einzurichten.

====SAML-Authentifizierung====

Während der Erstinstallation wird automatisch ein Zertifikat zur Nachrichtensignierung erstellt. Es befindet sich in <code>${DATADIR}/wiki/simplesamlphp/certs/</code>.

Um einen Remote-IDP zu konfigurieren, muss man die IdP-Metadaten-XML in eine Datei namens <code>${DATADIR}/wiki/simplesamlphp/simplesamlphp/saml_idp_metadata.xml</code> kopieren. Die SP-Metadaten können dann über <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/saml/sp/metadata.php/default-sp</nowiki></code> abgerufen werden. Sie müssen im Remote-IdP konfiguriert werden.

{{Textbox
|boxtype=tip
|header=Authentifizierung testen
|text= Sie können die Authentifizierung direkt in der SimpleSAMLphp-Anwendung testen. Navigieren Sie dazu zu <code><nowiki>https://{{$WIKI_HOST}}/_sp/module.php/admin</nowiki></code> und melden Sie sich mit <code>admin</code> und dem <code>INTERNAL_SIMPLESAMLPHP_ADMIN_PASS</code> an, der sich in <code>${DATADIR}/wiki/.wikienv</code> befindet
|icon=yes
}}

Als nächstes müssen die Erweiterungen „PluggableAuth“ und „SimpleSAMLphp“ im Wiki aktiviert werden. Fügen Sie dazu in <code>${DATADIR}/wiki/bluespice/post-init-settings.php</code> Folgendes hinzu:

<syntaxhighlight lang="php">
wfLoadExtensions( [
'PluggableAuth',
'SimpleSAMLphp'
] );
</syntaxhighlight>
[[Datei:Installationsanleitung Docker Authentifizierungseinstellung.png|alternativtext=Konfigurationsverwaltung mit ausgewählter Funktion "Authentifizierung"|mini|300x300px|Authentifizierungs-Einstellungen]]
Führen Sie folgenden Befehl aus, um die Installation abzuschließen.<syntaxhighlight lang="text">
./bluespice-deploy exec wiki-task /app/bluespice/w/maintenance/update.php --quick
</syntaxhighlight>Danach kann die Konfiguration des Authentifizierungs-Plugins in [[Handbuch:Erweiterung/BlueSpiceConfigManager|Spezial:BlueSpiceConfigManager]] unter „Authentifizierung“ angewendet werden.

[[en:Setup:Installation_Guide/Docker]]

Referenz:NumberHeadings

2024-10-29T15:14:51Z

Hjing:

{{BSExtensionInfo
|status=stable
|developer=HalloWelt
|type=MediaWiki
|edition=BlueSpice pro, BlueSpice farm, BlueSpice cloud
|compatible=MediaWiki
|category=Inhaltliche Strukturierung
|bsvFrom=4.5
|features=Diese Erweiterung bietet eine Konfigurationseinstellung, die die Inhaltsverzeichnisnummern mit jeder Abschnittsüberschrift anzeigt.
|license=GPL v3 only
}}

Benutzer:Hjing

2024-10-29T15:13:49Z

Hjing: create user page