Der "Space-Exporter" ist ein Hilfswerkzeug für Confluence-Admins die Ihre Instanz/Ihre Spaces in das BayernCollab migrieren wollen. Das Skript erzeugt für alle Spaces (global und personal) ein XML-ZIP über die normale Backup-Funktion von Confluence.
Das LRZ stellt das Tool ohne Gewähr zur Verfügung. Getestet wurde es für die Confluence-Versionen 7.x und 8.x.
Inspiriert wurde das Tool einen Atlassian Artikel. Teile des Workflows für Confluence Systeme mit Version <8.3.0 verwenden Code Snippets des Artikels.

Einschränkung: Einige Addons (z.B. Flowboard, Confiforms, Translation Macro, Team Calendar) speichern Ihre Daten außerhalb des normalen Space-Contents in separaten Datenbank-Tabellen. Der Atlassian-Export-Mechanismus kann diese Informationen nicht mitsichern, folglich führt ein Import ins BayernCollab zu fehlenden Daten. Für die uns bekannten Addons stellen wir separate Anleitungen zur Verfügung um auch diese Inhalte mitzumigrieren.

Voraussetzung

Confluence in der Version 7.x oder 8.x
Linux oder Windows-System mit Python 3
Das vom LRZ bereitgestellte Space-Exporter-Tool. Aktuellste Version vom 7.11.2023 gibt es hier zum Download
- Nach dem Entpacken müssen die Python-Dependencies aus der requirements.txt installiert sein (die space-export-runner-blueprint.sh erledigt den nötigen Aufruf)

Confluence-Instanz-Admin Account (Username, Passwort) sowie ein Personal Access Token des Admin-Accounts

Bedienung

Setzen der Umgebungs-Variablen im Skript "space-export-runner-blueprint.sh"

CONFLUENCE_USER  --> Account vom Admin
CONFLUENCE_PW    --> das Passwort
CONFLUENCE_TOKEN --> ein PAT Token vom Admin
CONFLUENCE_HOST  --> die URL im Format https://<fqdn>
WOR_DIR          --> Verzeichnis, in dem das Python-Script liegt (und in dessen Unterordner der Export geschrieben wird) kann default bleiben wenn space-export-runner-blueprint.sh und space_export_trigger.py im selben Ordner liegen

Skript-Aufruf
Durch Aufruf der space-export-runner-blueprint.sh wird der Export gestartet.
Dabei wird ein Unterordner "space-export-files" angelegt und dort je Space eine ZIP-Datei erzeugt. Im Ordner des Skripts wird eine Textdatei angelegt, die alle Spacekeys der Instanz enthält.
Diese Textdatei muss dann später im Mgmt-Portal unter Bereichsimport als erstes hochgeladen werden, danach kann man einen Space (ZIP-Datei) hochladen.

Upload ins BayernCollab

Login ins Management-Webinterface
Klicken Sie auf "Bereichsimport" und laden Sie zunächst die Spacekey-Textdatei hoch. Anschließend können Sie ZIP-Dateien per Drag&Drop hochladen.
Nach ein paar Sekunden - Minuten sollte dann in der Liste ein Eintrag auftauchen.
Nach erfolgreicher Konvertierung können Sie per Klick auf "Import" den Space ins BayernCollab übernehmen.