Skip to content

Upgrade Preview ​

v1 preview

Supported public self-hosting is not available during beta. This page records the responsibilities the v1 upgrade guide must cover; it is not an executable procedure.

Planned Upgrade Contract ​

The public v1 documentation is intended to define:

  1. Supported source and release versions.
  2. Required database or search migrations.
  3. Backup and recovery checks before an upgrade.
  4. Service rebuild and restart order.
  5. Health, realtime, search, email, Widget, and API verification after an upgrade.
  6. Rollback boundaries for releases that change stored data.

Operator Responsibility ​

Self-hosted teams will own upgrade timing, tested backups, storage capacity, service compatibility, observability, and incident recovery. An AGPLv3 release provides source access; it does not turn production operations into a maintenance-free process.

Final commands and version-specific migration notes will be published with the public v1 repository and release notes.

Prepare an Upgrade Review ​

Keep a record of the installed application version, relevant service versions, and the configuration your team changed. When the public release notes become available, compare their requirements with that record before scheduling maintenance. Pay particular attention to changes that affect stored data, search indexes, or external integrations.

Plan a recovery checkpoint that includes both database records and owned attachment storage. A backup is useful only if the team can restore it and verify that the recovered application can read the expected data. Decide who can approve an upgrade and who will handle a failed verification.

Define Successful Verification ​

After the final v1 procedure is available, use its checks as the minimum verification set. Include the workflows your organization relies on, such as receiving a customer conversation, opening a public portal, finding an existing record, and sending expected email.

Do not assume that restarting an older application version reverses a data migration. Follow the release-specific rollback boundaries and recovery instructions. The configuration preview and installation preview provide planning context until the supported operational documentation is published.