Updates

Update Paths

Open System → Updates in the Phaeton web UI. It offers two ways to update, and both install only releases signed by Phaeton.

• Release repository update: select Check for updates, choose a Version and select Install selected release and restart. Phaeton uses its built-in public release channel; public releases need no access token.
• Local package update: download the .phaeton-update package for your device platform from the Phaeton downloads site, select Choose update package, pick the file and select Upload package and restart. Use this when the device has no internet access.
• Use a private repository override only when instructed by your installer or support contact.

Phaeton downloads

Before Updating

• Back up the data directory; see Backup and Restore.
• Stop charging. Charging control is unavailable while Phaeton restarts.
• Read the release notes shown on the Updates page. What's new has the notes of recent versions.
• Keep the package of the version you run now until the new version has passed its checks after the restart.

Backup and Restore

Update Settings

The update settings are under Settings → System → Maintenance, in Advanced.

• Enable remote updater turns the automatic checks and automatic updates on or off. It is on by default. Check for updates on the Updates page works either way.
• With Auto check remote repository on, Phaeton looks for a new release every Check interval (h), once a day by default. It installs one by itself only when Auto update is on, which is off by default.
• Include prereleases also offers test versions. Leave it off on an installation you rely on.
• Repository URL stays empty for the built-in public release channel. Set it only for a private GitHub or GitLab release source, and fill in Access token (for private repos) only when that repository needs one.
• Phaeton sends the token only over HTTPS to that repository's server, and to the GitHub API for a GitHub repository, never to a server a download redirects to. Changing the repository clears a saved token unless you enter it again.

Manual Updates With A Signed Bundle

• The Updates page accepts only the official .phaeton-update package for your device platform. It contains the release and its signed checksums. A plain .tar.gz archive is refused.
• Before installing, Phaeton checks the release signature, the package checksum and the platform. A package that fails any check is not installed.
• A package older than the installed version installs only after a second confirmation that names both versions. Until you confirm, nothing is installed. The same confirmation appears for a package without a version number, such as a preview build. Reinstalling the installed version needs no extra confirmation.

What An Update Keeps

An update replaces the program and the web UI and keeps everything in the data directory:

• config.yaml with your settings, and config-web.json with the copy of the administrator account.
• state.json with the saved operating state.
• The phaeton.<date>.log log files.
• The license files.

Updating Through VRM Control Panel

Through the GX or VRM Control Panel, the connection can time out or show a 502 Bad Gateway error while installation continues. A connection timeout or proxy error alone does not mean the update failed.

Phaeton treats a lost response as unconfirmed. It waits up to two minutes for the new version to become ready and then reloads the page. The install buttons stay disabled while it waits, so a second request cannot start. You may need to sign in again after the restart.

If the restart cannot be confirmed, reload the page and check the installed version on the Updates page before you try another update.

If An Update Fails

• If installing fails, Phaeton keeps the version it runs. If it cannot put the previous web UI back, the error names the backup folder it kept and the folder to restore. Keep that backup until the problem is solved; a later update does not overwrite it.
• If the new version cannot be started, the running version stays active and writes the reason to the log. An accepted upload alone does not mean the restart succeeded.
• On a GX, if the new version does not start properly within about three minutes, Phaeton goes back to the previous version by itself. The log then names the update that was rolled back. Automatic updates skip that release; you can still install it by hand.
• If Phaeton reports that an earlier update is still being checked, wait a few minutes and try again.

Updates fail