Skip to content

Updating

Each kataba release is listed with its changes on the releases page. A release can change the database schema; kataba brings the database up to date with migrations, which apply in order and keep all content.

Back up first

Before an update, download a backup or back up the database and the upload directory. Migrations cannot be undone: going back to the older release means restoring what you backed up.

With Docker

Change the image's tag to the new release, such as mikognn/kataba:1.3.0, in compose.yaml or your docker run command, then pull it and recreate the container:

docker compose pull
docker compose up -d

The container applies pending migrations when it starts, so nothing else is needed. If you build the image from source, check out the new release and run docker compose up -d --build instead.

With Node.js

Stop kataba, then in its directory:

git fetch --tags
git checkout v1.3.0         # the new release
npm install
npx prisma migrate deploy   # apply the new migrations
npm run build
npm start

Packages and backups across releases

Guide packages and backups written by an older kataba can always be read by a newer one. Those written by a newer kataba are refused until the instance has been updated.