The update check and the live update: feed, verification, window and rollback
-
Written for 6.3.4. hMailServer 6.3.6 (6 October 2026) is signed by the GitLab pipeline at the group path and installs by the live update from 6.3.4 or 6.3.5; from 6.3.6 the Control Panel installs an update with one click where the service is not an administrator, and on Linux a 6.3.4 or 6.3.5 server installs 6.3.6 with its package manager rather than by the live update, whose apply step on those versions is the one 6.3.6 fixes. See the 6.3.6 announcement. hMailServer 6.3.7 (17 October 2026), a security release signed at the same group path, was what the feed offered before 6.3.8: from 6.3.6 the live update installs it, with 6.3.6's file as its rollback image and no schema step between them; on Windows a service running as LocalSystem installs it itself, and under
NT SERVICE\hMailServeran administrator presses Install update on the Control Panel's Server status page on the server, one Windows prompt; on Linux 6.3.6's own helper applies it to the generic packages and both AppImages, while a server from a per-distribution package upgrades with its package manager. From 6.3.4 or 6.3.5 what 6.3.6's notes said still holds, and a server whoseUpdateSigningIdentity,UpdateSigningIssuerandUpdateSourceRepositorystill name the project's first path refuses 6.3.7 until the three are cleared, on 6.3.6 by deleting their lines from[Settings]inhMailServer.iniwith an editor run as an administrator (on Linuxsudo hmailserver --set-setting <name>=) and restarting the service. In 6.3.7's Control Panel, Updates is a page of its own under Maintenance. See the 6.3.7 announcement. hMailServer 6.3.8 (2 November 2026), a security release signed at the same group path, with the project's id, 86730559, in the certificate, is what the feed now offers: from 6.3.7 or 6.3.6 the live update installs it, with the running version's own file as its rollback image and no schema step between them, a service running as LocalSystem by itself and one underNT SERVICE\hMailServerby Install update on the server; from 6.3.4 or 6.3.5 what 6.3.7's notes said still holds; a server from one of 6.3.6's or 6.3.7's per-distribution packages is offered the generic package, which apt refuses on Debian 12 and dnf on Enterprise Linux 9, so upgrade it with its release's own package of 6.3.8; the three settings that name the project's first path refuse 6.3.8 too until they are cleared; and a server from 6.2.28 to 6.3.3, or from 6.3.3's AArch64 packages or AppImages, installs 6.3.8 by hand, once. See the 6.3.8 announcement.This topic covers the update check and the live update as 6.3.4 has them. The one thing to know first: no live update installs 6.3.4. It carries an Authenticode signature and no Sigstore bundle, so a server of any version that is offered it says it cannot be verified and downloads nothing. Every server installs 6.3.4 by hand, as Upgrading to 6.3.4 describes. A server from 6.2.28 to 6.3.3 has a second reason to do it soon: its live update will refuse 6.3.5, the first release to be signed on GitLab.
Four steps, and where each is done
Each step is separate and opt-in, and only applying runs anything.
Step Control Panel (Windows) REST COM (Windows) Check Check for updates on Server status POST /api/v1/update/checkStatus.CheckForUpdateDownload and verify Download update POST /api/v1/update/downloadStatus.DownloadUpdateApply Install update POST /api/v1/update/installStatus.InstallUpdateRead the verdict the Server card of Server status GET /api/v1/updateStatus.UpdateState,Status.AvailableVersion,Status.UpdateLastError,Status.UpdateApplyOutcomeThe Control Deck's Update view does all four on either platform; on Linux there is no Control Panel and no COM. The state is 0 not checked, 1 up to date, 2 a newer release exists, 3 downloaded and verified, 4 installing, or 5 the last step failed (
lastErrorsays why). An on-demand check reads the feed whether or not the scheduled check is on. Starting an install from the Control Panel closes it, because the installer replaces its files.Turning the check on
UpdateCheckEnabledis 0 by default, because a server must not call out to anyone until its administrator says it may. At 1 the server reads the feed at startup and then everyUpdateCheckHours(24; below 1 is taken as 1, and the server sets no ceiling although the Control Panel's label says "1 to 168").UpdateChannelisstableby default;prereleasemakes pre-releases eligible.What it sends. A plain
GETof the feed with nothing but theUser-Agentthe server always sends: no identifier, no configuration, no counts. Since 6.3.4 it no longer sends GitHub'sX-GitHub-Api-Versionheader.Where the result shows. The application log, the Control Panel's Server status page, the Deck's Update view, COM, and
GET /api/v1/update, which adds the release's page and date, the installer's address, size and digest, and the last apply's outcome.Setting the keys since 6.3.4. Use the Updates card of the Control Panel's API & monitoring page (in 6.3.7 Updates is a page of its own under Maintenance, and Ctrl+K takes the old title to it),
PUT /api/v1/settings/ini/{name}with{"value": "..."}(administrator password only),hmctl ini set, or on Linuxhmailserver --set-setting; the Deck has no editor for these keys. Every key here applies when it is saved, but a value stored with--set-settingwhile the service runs reaches it only at its next save, reinitialise or restart. Do not edit the[Settings]lines inhMailServer.ini: the database is the settings store, and Settings: when a save takes effect explains what happens to a line edited in the file.curl -u Administrator:pw -X PUT -H "Content-Type: application/json" -d '{"value":"1"}' http://127.0.0.1:8443/api/v1/settings/ini/UpdateCheckEnabled curl -u Administrator:pw -X POST http://127.0.0.1:8443/api/v1/update/checkThe feed
Since 6.3.4 a server reads
https://updates.progressiverobot.comwithout being told:/releases/latest, the newest stable release, on the stable channel, and/releases.json, every release, on the pre-release channel. GitLab Pages serves it from the project's releases. For the rollback the server looks one release up at/releases/tags/v<version>. Every address a server builds is a file answered 200, and the server follows no redirect.A release has the shape of GitHub's Releases API, and each installer's Sigstore bundle is an asset of its own, named after its file with
.cosign.bundleadded. A download is held to the size and thedigestthe feed gives. Since 6.3.4, a version with a suffix (6.3.5-rc1,6.3.5rc1) is a pre-release whatever the feed'sprereleaseflag says, so the stable channel passes over it.A mirror.
UpdateFeedUrlpoints the server at another feed, for a network without Internet access; empty is the built-in feed. It must be https unless it is on this machine. It may serve one release or a list, and the rollback's lookup keeps everything up to/releasesof the value and adds/tags/v<version>, so the mirror answers that path too. A mirror changes where the server looks, not whom it trusts: every installer is still verified against the signers compiled in.Through a proxy.
HttpProxy=host:port(or[ipv6]:port) sends every web request the server makes as a client through a forward proxy: the feed, the installer and its bundle, and the JWKS and token-introspection fetches of OAuth 2. An https address is tunnelled withCONNECT, and the certificate is verified against the real host. There is no place for credentials; a proxy that demands them refuses. A refusal readsThe proxy <host:port> refused CONNECT to <host:port>: <its status line>, and a value without a port fails withHttpProxy must be host:port (or [ipv6]:port)., never quietly going direct. ACME and the outbound-relay OAuth2 token request do not use it.Download and verification
Download update,
POST /api/v1/update/download,Status.DownloadUpdateorUpdateAutoDownload=1fetches the installer and its bundle into the data directory'sUpdatesfolder (Data\Updateson Windows; on Linux the file is the.debor.rpmthis server was installed from) and checks them without cosign and without the network:- the file's SHA-256 is the one signed and the one the transparency log recorded;
- the certificate chains to Sigstore's Fulcio authority at the moment the log recorded the signature;
- the certificate is one of this project's signers, whole;
- the signature verifies under the certificate's key, and the log vouches for the entry under its own key.
A file that fails is deleted, and the reason is in
Status.UpdateLastErrorand the log. Nothing is run.The two signers, since 6.3.4. A certificate must match one entry whole.
The GitHub workflow The GitLab CI pipeline Signs Every release from 6.2.19 to 6.3.3 The releases from 6.3.5 on: 6.3.5 at the path the project began at, 6.3.6 and later at the group path hmailserver/hmailserverIdentity begins https://github.com/Progressiverobot/hmailserver/.github/workflows/sign-release.yml@https://gitlab.com/Progressiverobot/hmailserver//.gitlab-ci.yml@refs/tags/vfor 6.3.5; from 6.3.6,https://gitlab.com/hmailserver/hmailserver//.gitlab-ci.yml@refs/tags/v, the path the project moved to on 29 September 2026Issuer https://token.actions.githubusercontent.comhttps://gitlab.comRepository id 1267388815, required86730559, checked when the certificate carries oneHeld to Certificates issued before 18 September 2026, and releases up to 6.3.3 The tag the certificate names The pipeline is also trusted at the path of the group
hmailserverthe project is to move to, where the id86730559is required whatever any setting says. A server from 6.2.28 to 6.3.3 trusts the GitHub workflow alone.Further checks since 6.3.4. A file signed for one tag is refused as any other release. On Windows the installer's version resource must name the release it is installed as; on Linux the update helper installs nothing that is not an upgrade. On Windows only SYSTEM, the Administrators and the service's account may change the
Updatesfolder; one that is a link, owned by anyone else or beyond repair is refused withHM6894, and nothing is downloaded or applied: delete it, and the server makes it again.Authenticode.
UpdateRequireAuthenticode=1adds, on Windows only, a check that the installer carries an Authenticode signature Windows trusts (no revocation check, no publisher pin). The installers have been signed since 6.3.1; 1 refuses earlier ones. It is on top of the Sigstore check, which cannot be turned off.The trust settings
UpdateTrustRootsFile,UpdateLogPublicKeyFile,UpdateSigningIdentity,UpdateSigningIssuerandUpdateSourceRepositoryare for a site that signs its own releases. Leave them empty; set, the last three replace their part of every signer.Applying an update
On Windows, Install update,
POST /api/v1/update/install,Status.InstallUpdateor the unattended window does this, in order:- Verifies the downloaded installer once more.
- Fetches and verifies the running version's installer as a rollback image, where the feed still offers it.
- Issues a single-use token for the database upgrade: 32 random bytes in a file only the machine's administrators can read, good for one hour and one use, given to the installer as
/upgradetoken=<hex>in place of the administrator password. - Drains, since 6.3.4: the SMTP, IMAP, POP3 and ManageSieve listeners close at the socket, so senders retry, and the queue pauses. It refuses with
already drainingwhile somebody else's drain is in progress: leave it, or wait, and apply again. - Hands the installer to
hMailServer.Updater.exe, copied fromBinintoData\Updatesbecause the installer replacesBin. The helper runs it silently, and only with the SHA-256 the server read; waitsUpdateServiceWaitSeconds(180) for the service; and if it does not come back, reinstalls the previous version. - Reports the outcome: one line, in the log,
Status.UpdateApplyOutcome, the status page andGET /api/v1/update; since 6.3.4, as soon as the service is back.
If the helper finishes without stopping the service, the server leaves the drain itself after ten minutes at most (
HM7151when the helper wrote nothing); the helper's log isapply-<version>.login theUpdatesfolder. SetShutdownDrainSeconds(30 is a reasonable figure) so the stop waits for what is in flight.What a rollback cannot do. It reinstalls the previous binaries; it cannot take the database back. When the new version had moved the schema and then failed to start, the previous version refuses the newer schema, and the outcome says so. Every release's notes say whether it moves the schema; before one that does, take a backup (Backup and restore). The rollback image is verified like any installer, and 6.3.4's has no bundle. UpdateFeed.md does not say what a 6.3.4 server's first live update does about that, so plan it as one without a rollback image, and take a backup first. In the one case UpdateFeed.md describes, an old server set to the GitLab signer (below), the install runs without a rollback image, the log says
no rollback image ... could be had, and a new version that does not start has to be reinstalled by hand.Under
NT SERVICE\hMailServer, the account a new 6.3.4 installation on Windows runs as, the apply is refused before anything happens, before the rollback image and the drain: the installer needs an administrator. The update is still checked, downloaded and verified. REST, COM and the Deck say so, and tell an administrator to download the installer from the release page, check its Authenticode signature (Get-AuthenticodeSignaturereports itValid) and run it; never the copy inData\Updates, which the service can write. An open unattended window logsHM7463once per process instead of taking a backup for nothing, and the setup checklist carriesupdate_apply_by_administratorwhile the check is on. An upgraded installation that kept LocalSystem applies as before. Installing on Windows covers the account.On Linux, since 6.3.4, the service writes a request to
/run/hmailserverand the root path unithmailserver-update.pathruns/usr/lib/hmailserver/hmailserver-update, which verifies the package and the rollback image again as root, installs, and rolls back when the service does not come back. No token is involved: the package's post-install step runs the schema upgrade. A server not under systemd is told so and left with the verified file to install by hand. The hmailserver command line on Linux has the helper in full. Linux builds from 6.3.0 to 6.3.3 answerThis build cannot apply an update.Unattended updates
Key Default What it does UpdateAutoDownload0 1 downloads and verifies a newer release's installer as soon as a check finds it UpdateWindowempty, never When a verified update may be applied without a click UpdateBackupBeforeApply1 An unattended apply backs up to the configured backup destination first, and does not go ahead without a destination or when the backup fails UpdateWindowtakes03:00(every day from 03:00, for an hour),Sun 03:00orSat,Sun 02:00-05:00: English three-letter days, local 24-hour times, and a range that crosses midnight belongs to the day it starts on. An unparsable value is logged once per process and nothing is applied. The backup covers the unattended path only, so take one yourself before an apply you start. UnderNT SERVICE\hMailServera window applies nothing (HM7463). On Linux:sudo hmailserver --set-setting UpdateCheckEnabled=1 sudo hmailserver --set-setting UpdateAutoDownload=1 sudo hmailserver --set-setting "UpdateWindow=Sun 03:00" sudo systemctl restart hmailserverA server from 6.2.28 to 6.3.3
These versions read GitHub's Releases API, which has answered 404 since GitHub suspended the project's account on 18 September 2026, so their check says
The update feed answered HTTP 404.Nothing else breaks. Pointed at the new feed, such a server trusts the re-hosted releases up to 6.3.3, which carry GitHub's bundles, but its check now offers 6.3.8, the newest stable release, signed by the GitLab pipeline, which it cannot verify either: its live update installs nothing until 6.3.4 or later is installed by hand. It will also refuse 6.3.5 (The certificate names https://gitlab.com/Progressiverobot/hmailserver//.gitlab-ci.yml@refs/tags/v..., not this repository's release workflow.). These versions read[Settings]from the file, and a change needs a service restart.- Turn automatic download off. With
UpdateAutoDownload=1such a server would download a GitLab-signed installer, about 80 MB, at every check and refuse it every time, because the verification comes after the download. Set it to 0. - Point it at the feed, with exactly this line under
[Settings]inhMailServer.ini, then restart the service:
[Settings] UpdateFeedUrl=https://updates.progressiverobot.com/releases.jsonWithout
.jsonthe address is a directory, answered with a redirect, and the check saysThe update feed answered HTTP 302.On Windows set it on the Updates card and let the Control Panel restart the service; or add it toBin\hMailServer.INIas an administrator and runnet stop hMailServerandnet start hMailServerfrom an elevated prompt. On Linux:sudoedit /etc/hmailserver/hMailServer.ini # add the line under [Settings] sudo systemctl restart hmailserverAn AppImage keeps it in
$HMAILSERVER_HOME/hMailServer.ini, or else$XDG_DATA_HOME/hmailserver/hMailServer.ini, normally~/.local/share/hmailserver/hMailServer.ini; start it again after the edit.- Check. The answer should be that the newest release, 6.3.8, is available. Still 404 means the service has not read the line: check the section, the spelling and the restart.
The update feed could not be read: ...names what stopped it: no route out, a proxy (HttpProxy), or a certificate the machine does not trust. - Install 6.3.4 by hand, following Upgrading to 6.3.4, with the backup Upgrading.md describes. The service must have been restarted after your last
[Settings]change, or 6.3.4's first start treats that change as an edit (HM5804) and undoes it. 6.3.4 and 6.3.5 had no AppImage and no AArch64 package; 6.3.6, 6.3.7 and 6.3.8 have both again, and such an installation takes the newest release's, 6.3.8's, by hand, once. - Afterwards, 6.3.4 reads the new feed without being told and trusts both signers. The
UpdateFeedUrlline can go, although leaving it changes nothing: clear it in the Control Panel, withDELETE /api/v1/settings/ini/UpdateFeedUrl, or on Linux withhmailserver --set-setting UpdateFeedUrl=, not in the file. TurnUpdateAutoDownloadback on if you want it.
The other way, Windows only. UpdateFeed.md gives values for
UpdateSigningIdentity,UpdateSigningIssuerandUpdateSourceRepositorythat let such a server install a GitLab-signed release. While set, they make it refuse every GitHub-signed release, its own rollback image included; they are proved only once a GitLab-signed release exists; and they must stay set until the new version runs, then be cleared as step 5 clearsUpdateFeedUrl, or the new version refuses what is signed after the project's move. Never point them at the group's path: an old server checks no repository id. Installing 6.3.4 by hand avoids all of this.The download links, and checking a file by hand
https://updates.progressiverobot.com/download/<name>always leads to a file of the newest stable release, never a pre-release, and/download/to that release's page. GitLab's own/-/releases/permalink/latestfollows the release published last, a pre-release included. A server does not read these links.<name>is a file's name without its version:hMailServer-x64.exe,hMailServer-arm64.exe,hmailserver_amd64.deb,hmailserver_arm64.deb,hmailserver.x86_64.rpm,hmailserver.aarch64.rpm,hMailServer-x86_64.AppImageandhMailServer-aarch64.AppImage, each with its bundle at the same name plus.cosign.bundle. A name the release does not carry answers 404, never another release's file. 6.3.4 carries the x64 installer, the amd64.deband the x86-64.rpm, and no bundle.Checking 6.3.4. With no bundle to check, 6.3.4 is checked by
hmailserver-6.3.4-SHA256SUMS.txt, whose signaturehmailserver-6.3.4-SHA256SUMS.txt.sigis made with the key that signs the release tags, and on Windows by the installer's Authenticode signature, whichGet-AuthenticodeSignatureshould answerValid, signed by Progressive Robot Ltd. The 6.3.4 announcement has the commands and what each must answer.Other releases. Up to 6.3.3,
cosign verify-blobchecks a file against its bundle and the GitHub identity (Verifying a release in the Security Policy). From 6.3.5 a release has no.sig; its files are signed with Sigstore, and on Linuxhmailserver --verify-update <file>checks a download the way the server does.What it does not do
- It does not install 6.3.4, and does not apply under
NT SERVICE\hMailServer. - A rollback does not take the database back; a backup does.
- It follows no redirect and sends no proxy credentials.
- It does not drain a warm-standby pair: the drain is per process, so a pair drains one node at a time (Warm standby and high availability).
Where to read more
- UpdateFeed.md, ServiceAccount.md, Upgrading.md, SettingsApply.md, and the Update check section of the README.
- On the wiki: Upgrading hMailServer, Settings Reference, The REST API, Security Policy and Installing on Linux.
- The documentation page: Staying up to date and Self-update.
- On the forum: Upgrading to 6.3.4; Upgrading from 5.x, 6.2 or 6.3, for what 6.3.4 changes and rolling back by hand; and The Control Deck.
- Without a GitLab account, a question or a bug can go to the project's Service Desk,
contact-project+hmailserver-hmailserver-86730559-issue-@incoming.gitlab.com. A suspected vulnerability goes only by the routes of SECURITY.md: a confidential GitLab issue or that same address, which GitLab files as a confidential issue.
Hello! It looks like you're interested in this conversation, but you don't have an account yet.
Getting fed up of having to scroll through the same posts each visit? When you register for an account, you'll always come back to exactly where you were before, and choose to be notified of new replies (either via email, or push notification). You'll also be able to save bookmarks and upvote posts to show your appreciation to other community members.
With your input, this post could be even better 💗
Register Login