Skip to main content

Anleitung zur Migration zu ELN.UP

Diese Anleitung behandelt den Umzug bestehender elabFTW-Instanzen zum zentralen ELN.UP-Dienst. Sprechen Sie uns gerne an, falls Sie weitere Unterstützung benötigen.

Voraussetzungen

  • Eine lauffähige eLabFTW-Instanz, die vom ZIM betreut wird
  • Eine dezentrale eLabFTW-Instanz
  • SysAdmin-Zugriff auf die dezentrale Instanz
  • Zugang zu einer root shell auf dem Host der dezentralen Instanz

Die dezentrale Instanz muss sich auf genau demselben Versionsstand wie die ZIM-Instanz befinden. Im- und Exporte zwischen verschiedenen Versionen werden nicht unterstützt und werden fehlschlagen.

Vorbereitungen

  • Die dezentrale Instanz auf den gleichen Versionsstand wie die ZIM-Instanz bringen.

    Aufgrund der vielfältigen Möglichkeiten zum Deployment von eLabFTW und der schnellen Entwicklung können hier nicht alle Szenarien abgedeckt werden. Stattdessen ist die offizielle Anleitung (https://doc.elabftw.net/how-to-update.html) heranzuziehen.

    Das ZIM unterstützt in komplizierten Szenarios gerne individuell. Wenden Sie sich hierfür an den ELN support (eln-serviceuni-potsdamde).
  • In der Standardkonfiguration dürfen docker container eine Größe von 10 GB nicht überschreiten. Sollen sehr große dezentrale Instanzen exportiert werden, kann es daher ratsam sein, ein volume auf den Exportpfad im container zu mappen sodass die Daten direkt auf das Hostdateiverzeichnis geschrieben werden. Hierzu in der elabftw.yml im Schüssel volumes des eLabFTW-Services den Eintrag "- /var/elabftw/exports:/elabftw/exports" ergänzen:

volumes:
    # this is where you will keep the uploaded files persistently
    # for Windows users it might look like this
    # - D:\Users\Nico\elab-data\web:/elabftw/uploads
    # host:container
    - /var/elabftw/web:/elabftw/uploads
    # mapping of exports folder
    - /var/elabftw/exports:/elabftw/exports

Export

  • Die ID des zu exportierenden Teams feststellen.
    • Mit Sysadmin account einloggen
    • Zu Sysadmin panel > Teams navigieren
    • In der Teams list stehen sämtliche Teams der dezentralen Instanz. Die ID ist in der ersten Spalte vermerkt.
  • Root shell auf dem dezentralen ELN-host öffnen
  • Den folgenden Befehl anpassen und ausführen. Die Zahl am Ende gibt die Team-ID des zu exportierenden Teams an, ggf. muss auch der Name des elabftw-containers an die eigene Umgebung angepasst werden.
    $ docker exec elabftw bin/console export:eln -vv 1
    Je nach Größe der Instanz kann dieser Vorgang einige Minuten dauern.
  • Der Exportbefehl gibt am Ende den benötigten Befehl zum Kopieren des ELN-Archivs vom Container auf den Host aus:

    Copy the generated archive from the container to the current directory with:
    docker cp elabftw:/elabftw/cache/elab/export-elabftw-2024-11-25_14-27-45-team-1.eln .

    Ggf. Ist wieder der Name des elabftw-containers anzupassen.

  • Das so erzeugte ELN-Archiv ist dem ZIM zuzuleiten, wo es dann von den Systembetreuer:innen in die zentrale Instanz importiert wird

Der Ex- und Import erfolgt einzeln für jedes Team einer Instanz. Soll mehr als ein Team migriert werden müssen diese Schritte für jedes Team wiederholt werden.