Skip to content
dmsforall

Upgrade dmsforall

At the end of this page, your installation runs the new version, and you know how to go back if something fails.

Before you upgrade

Section titled “Before you upgrade”
  1. Read the changelog for every version between yours and the new one. Note any change in configuration variables.
  2. Take a backup, and check that it is complete. See Back up and restore.
  3. Check the free disk space. The migrations and the backups need room.
  4. Plan a short window, and tell your staff. Staff must not work during the upgrade.

Upgrade

Section titled “Upgrade”

  1. Set DFA_VERSION in .env to the new tag. See Verify the images.

  2. Pull the new images and restart the stack:

    Terminal window
    docker compose pull
    docker compose up -d

  3. The migrate service applies the database migrations before the API starts. Check that it finished without an error:

    Terminal window
    docker compose ps -a migrate

  4. Check the health endpoint:

    Terminal window
    curl -s https://garage.example.org/api/v1/sante

  5. Sign in and check one document of each area you use.

If something fails

Section titled “If something fails”
  • The migration failed. The API does not start on the new version, and the previous version keeps running. Read the logs of the migrate service, fix the cause, and run the stack again.
  • The API does not start. Read the logs. A configuration error lists each faulty variable. Fix the variable and start again.
  • The new version misbehaves. Restore the backup taken before the upgrade. This is the supported way to return to the previous state.