Migrate your database

When you are upgrading Zero-TOTP, you may need to migrate your database to the new version. If this is the case, it will be mentioned in the release notes and the API will refuse to start.

To avoid any data loss, you will have to perform the migration yourself after having made a backup of your database.

How to migrate your database

1 - Backup your database

Before performing any migration, it is highly recommended to backup your database. You can follow the Backup and restore documentation to backup your database.

2 - Run the migration script

Zero-TOTP provides a built-in migration script, directly in the API docker container to help you migrate your database.

You can run the migration script using the following command:

docker compose exec api /bin/sh -c "./admin-toolbox.sh db-migrate"

Follow the instructions to complete the migration.

3 - Restart the API

After the migration is complete, you will need to restart the API to apply the changes. You can do this by running:

docker compose restart api