Documentation navigation

Updates & changelog

Check for new releases and install them from Mail Settings. Updates are applied when you choose to install them.

Check for updates

  1. Sign in to your MarkRelay Mail app as an administrator.
  2. Open Manage → Settings and find Updates.
  3. Your installed version is checked against the latest stable release automatically. Select Check for updates to check again.

If an update is available, Settings shows the new version and a link to its release notes. An up-to-date installation shows Up to date.

If a check fails, you can keep using the app. Try again later; when a previous check succeeded, Settings keeps that release information and marks it as the last known result. This check does not change your license.

Read the changelog

Visit the Changelog for new features, improvements, and fixes by version. Read the release notes before updating, including any version-specific steps.

Set up one-click updates

Mail installs updates through a Cloudflare deploy hook: a private URL that starts a new build of your Worker. You set it up once, either in Manage → Settings → Updates or when you first select Update.

  1. Open your Cloudflare dashboard and go to Workers & Pages.
  2. Select the Worker running your MarkRelay Mail app. It is named markrelay-mail-app unless you renamed it during deployment.
  3. Open Settings → Builds, find Deploy Hooks, and select Add.
  4. Enter a name, such as update, choose the main branch, and save.
  5. Copy the hook URL.
  6. In Mail, open Manage → Settings → Updates, select Set up next to One-click updates, paste the URL, and select Save. When you are updating, paste it in the update dialog and select Save and update.

Anyone with the hook URL can start a build of your Worker, so treat it like a password. Mail does not show it again after saving. If it leaks, delete the hook in Cloudflare, add a new one, and save the new URL in Mail.

Install an update

You update the existing Worker; you do not need to create a new deployment or activate your license again.

  1. Open Manage → Settings → Updates. When a new version is available, select Update, then Update now. The first time, add the deploy hook in the same dialog.
  2. Cloudflare builds your Worker with the latest release, runs its database migrations, and deploys it. This usually takes a minute or two.
  3. Mail reloads once the new version is live and shows the new version number.

Your existing database, stored files, and configured resource names are preserved. No Git commands or repository synchronization are needed.

Updating from an earlier version

If Settings has no Updates section yet, make one commit to your copy of the repository on GitHub, for example by editing README.md in the browser. Cloudflare builds and installs the latest release. Then set up one-click updates as described above.

If you pinned a release

If you configured the RELEASE_REF build variable, the build installs that reference instead of the latest release. Change it to the desired release, or remove it to follow the latest release, before updating.

If the update does not complete

  • The update does not start: Mail shows the reason from Cloudflare. If the hook was deleted, add a new one and save it in Mail.
  • The build failed: while updating, Mail shows the build ID. In Cloudflare, open your Worker → Deployments and check that build's log for the reported error, then start the update again from Mail.
  • The version stayed the same: check for a pinned RELEASE_REF, confirm the hook belongs to the correct Worker and the main branch, and refresh the browser.
  • A newly announced version does not appear yet: release information is cached briefly. Wait a few minutes and check again.

Need help? Contact support with your installed version, commit, and the relevant build error. Never include passwords, activation codes, or deployment tokens.