Zum Inhalt springen

Aktualisieren ​

Erst eine Sicherung machen, dann neben docker-compose.yml ausführen:

bash
docker compose pull && docker compose down && docker compose up -d

down stoppt jeden Dienst, bevor die neue Version startet, werkbuch ist also offline, solange der Start dauert; die Volumes bleiben. Ohne down erzeugte up -d zuerst werkbuch neu, und das migriert die Datenbank, während die alten Worker mit altem Code gegen das neue Schema weiterlaufen, bis Compose sie erreicht.

Mit der Standalone-Compose-Datei in Dockge oder Portainer: den Stack stoppen, dann das Image neu ziehen und ihn starten (Dockge: Stop, dann Update; Portainer: den Stack stoppen, dann mit neu gezogenem Image aktualisieren).

Beim Start migriert die neue Version die Datenbank, schickt die Einstellungen der Suchindizes an Meilisearch, füllt die Indizes neu, wenn diese Version ihnen Felder bringt, und baut ihre Caches und das OpenAPI-Dokument; Einrichtung nennt jeden Schritt. docker compose restart allein behält das alte Image.

  • Feste Version: zuerst WERKBUCH_IMAGE in der .env ändern (etwa baeroe/werkbuch:0.2.0) oder die Zeile image: der Standalone-Compose-Datei.

  • Compose-Datei: Die Hinweise unten sagen, wann sich docker-compose.yml geändert hat. Dann neu herunterladen und eigene Änderungen in docker-compose.override.yml halten: curl -fsSLO https://raw.githubusercontent.com/baeroe/werkbuch/main/docker-compose.yml Mit der Standalone-Compose-Datei die neue docker-compose.standalone.yml einfügen und die eigenen Werte aus dem Block oben übertragen.

  • MariaDB: Patch-Versionen aktualisieren sich beim Start selbst (MARIADB_AUTO_UPGRADE). Eine neue Hauptversion kommt nur mit einem Hinweis hier.

  • Meilisearch: Eine neue Version von Meilisearch hebt beim Start die Datenbank der Version davor (MEILI_UPGRADE_DB in beiden Compose-Dateien); die Suche behält ihren Index. Nur wenn das nicht geht, stoppt sie mit einem Fehler zur Version ihrer Datenbank (docker compose logs meilisearch), und werkbuch startet nicht. Der Index kommt aus der Datenbank, also ihn löschen und von werkbuch neu bauen lassen:

    bash
    docker compose rm -sf meilisearch
    docker volume rm werkbuch_meili-data     # <projekt>_meili-data, siehe docker volume ls
    docker compose up -d
    docker compose restart werkbuch

    Der Start von werkbuch findet den Index leer und importiert alles; bis dahin ist die Suche leer. up -d allein startet ein werkbuch nicht neu, das noch läuft (etwa beim Weg zurück zum älteren Meilisearch), darum das restart. Nach dem Heben liest ein älteres Meilisearch die Datenbank nicht mehr; zurück geht es nur mit denselben Schritten.

  • Zurück: Migrationen werden nicht zurückgerollt. Die Sicherung wiederherstellen und die alte Version festlegen.

Alle Versionen und ihre Änderungen: https://github.com/baeroe/werkbuch/releases

Hinweise je Version ​

0.3.0 ​

  • Projekte: Der Name eines Projekts mit Stern in der Seitenleiste öffnet seine Items, der Pfeil daneben klappt seine Bereiche auf. Die Einstellungen eines Projekts sind ohne Seitenleiste erreichbar: ein vierter Reiter Einstellungen unter dem Kopf von Items, Wiki, Vorlagen und den Einstellungen, ein Link auf jeder Projektkarte und Projekteinstellungen öffnen … in der Befehlspalette.
  • Kommentare können jetzt auch Tabellen, über das /-Menü und mit dem Menü der Tabelle (alt+F10), wie Beschreibungen und Wiki-Seiten.
  • Die Compose-Dateien haben sich nicht geändert: wie unter Aktualisieren beschrieben aktualisieren.
  • Image baeroe/werkbuch:0.3.0 für linux/amd64 und linux/arm64.

0.2.0 ​

  • Die Compose-Datei hat sich geändert: Der neue Dienst gotenberg (Gotenberg 8.37) macht Wiki-Seiten zu PDFs. docker-compose.yml neu herunterladen (oder die neue Standalone-Datei einfügen und die eigenen Werte übernehmen), dann wie unter Aktualisieren beschrieben aktualisieren. Ohne den Dienst läuft werkbuch wie bisher, nur der Knopf PDF bleibt gesperrt. Siehe Betrieb.
  • Wiki: eine Seite, auch mit ihren Unterseiten, als PDF herunterladen. Der Baum startet eingeklappt und merkt sich je Person und Projekt, was aufgeklappt war.
  • Projekte: Wiki und Vorlagen eines Projekts sind ohne Stern erreichbar: Reiter über Items, Wiki und Vorlagen, Links auf jeder Projektkarte und Wiki öffnen … und Vorlagen öffnen … in der Befehlspalette.
  • Properties: Jede Property steht entweder rechts in der Seitenleiste oder unter der Beschreibung eines Items, einstellbar je Property. Rich-Text-Properties, auch die vorhandenen, stehen standardmäßig unter der Beschreibung.
  • Editor: In Beschreibungen gibt es Tabellen im /-Menü; eine breite Tabelle scrollt in ihrem Rahmen. Bilder in einem Text öffnen sich per Klick (im Editor mit Enter) groß, mit Originalgröße, Original öffnen, Herunterladen und ←/→ durch die Bilder desselben Texts; ein ausgewähltes Bild hat das Menü Bild (alt+F10).
  • Suche: Meilisearch 1.56.1. Es hebt die Datenbank der Version davor selbst (MEILI_UPGRADE_DB in beiden Compose-Dateien).
  • Image baeroe/werkbuch:0.2.0 für linux/amd64 und linux/arm64.

0.1.0 ​

  • Erstes Release: Projekte mit Mitgliedern, Work Items mit eigenen Typen, Properties und Workflows, Liste, Board, Tabelle und Timeline, gespeicherte Views, ein Wiki je Projekt, Vorlagen mit Zeitplänen, Automatisierungen, Benachrichtigungen mit Mail und Live-Updates, Suche, eine REST-API mit ihrer OpenAPI-Referenz, ein MCP-Server für KI-Agenten und signierte Webhooks, auf Englisch und Deutsch.
  • Image baeroe/werkbuch:0.1.0 für linux/amd64 und linux/arm64. Läuft als Docker-Compose-Stack mit MariaDB 11.4 und Meilisearch 1.56, siehe Einrichtung.