Upgrading
Make a backup first, then run next to docker-compose.yml:
docker compose pull && docker compose down && docker compose up -ddown stops every service before the new version starts, so werkbuch is offline for as long as the start takes; the volumes stay. Without down, up -d would create werkbuch anew first, and it migrates the database while the old workers keep running the old code against the new schema until Compose reaches them.
With the standalone compose file in Dockge or Portainer: stop the stack, then pull the image again and start it (Dockge: Stop, then Update; Portainer: stop the stack, then update it with the image pulled again).
On start the new version migrates the database, sends the settings of the search indexes to Meilisearch, fills the indexes again when this version adds fields to them, and builds its caches and the OpenAPI document; Setup lists every step. docker compose restart alone keeps the old image.
Pinned version: change
WERKBUCH_IMAGEin.envfirst (e.g.baeroe/werkbuch:0.2.0), or theimage:line of the standalone compose file.Compose file: the notes below say when
docker-compose.ymlchanged. Download it again and keep your own changes indocker-compose.override.yml:curl -fsSLO https://raw.githubusercontent.com/baeroe/werkbuch/main/docker-compose.ymlWith the standalone compose file, paste the new docker-compose.standalone.yml and copy your values from the block at the top into it.MariaDB: patch versions upgrade themselves on start (
MARIADB_AUTO_UPGRADE). A new major version only comes with a note here.Meilisearch: a new version of Meilisearch upgrades the database of the version before when it starts (
MEILI_UPGRADE_DBin both compose files); the search keeps its index. Only if it cannot, it stops with an error about the version of its database (docker compose logs meilisearch), andwerkbuchdoes not start. The index comes from the database, so delete it and let werkbuch build it again:bashdocker compose rm -sf meilisearch docker volume rm werkbuch_meili-data # <project>_meili-data, see docker volume ls docker compose up -d docker compose restart werkbuchThe start of
werkbuchfinds the index empty and imports everything; until then the search is empty.up -dalone does not start awerkbuchthat is still running (going back to the older Meilisearch, for example), hence therestart. Once upgraded, an older Meilisearch no longer reads the database; going back only works with the same steps.Going back: migrations are not rolled back. Restore the backup and pin the old version.
All versions and their changes: https://github.com/baeroe/werkbuch/releases
Notes per version
0.3.0
- Projects: the name of a starred project in the sidebar opens its items, the arrow beside it unfolds its parts. The settings of a project are reachable without the sidebar: a fourth tab Settings below the header of its items, wiki, templates and settings, a link on every project card, and Open project settings … in the command palette.
- Comments take tables too, from the
/menu and with the menu of the table (alt+F10), like descriptions and wiki pages. - The compose files did not change: update as described in Upgrading.
- Image
baeroe/werkbuch:0.3.0forlinux/amd64andlinux/arm64.
0.2.0
- The compose file changed: a new service
gotenberg(Gotenberg 8.37) turns wiki pages into PDFs. Downloaddocker-compose.ymlagain (or paste the new standalone file and copy your values into it), then update as described in Upgrading. Without the service werkbuch runs as before, only the PDF button stays disabled. See Operations. - Wiki: download a page, or a page with its subpages, as PDF. The tree starts folded and remembers what you opened, per person and project.
- Projects: the wiki and the templates of a project are reachable without a star: tabs above the items, wiki and templates, links on every project card, and Open wiki … and Open templates … in the command palette.
- Properties: every property shows either in the side panel or below the description of an item, set per property in its settings. Rich text properties, the existing ones too, go below the description by default.
- Editor: descriptions take tables from the
/menu; a wide table scrolls inside its frame. Images in a text open large on a click (or Enter in an editor), with Actual size, Open original, Download and←/→through the images of the same text; a selected image has an Image menu (alt+F10). - Search: Meilisearch 1.56.1. It upgrades the database of the version before by itself (
MEILI_UPGRADE_DBin both compose files). - Image
baeroe/werkbuch:0.2.0forlinux/amd64andlinux/arm64.
0.1.0
- First release: projects with members, work items with your own types, properties and workflows, list, board, table and timeline, saved views, a wiki per project, templates with schedules, automations, notifications with mail and live updates, search, a REST API with its OpenAPI reference, an MCP server for AI agents and signed webhooks, in English and German.
- Image
baeroe/werkbuch:0.1.0forlinux/amd64andlinux/arm64. Runs as a Docker Compose stack with MariaDB 11.4 and Meilisearch 1.56, see Setup.