Open Markdown text in a new tab

Release notes and upgrade notices

Release notes explain what changed in a SoAI release and identify anything that needs attention during an update. Open the Releases section of the official SoAI repository to read the notes published with a release and download its files.

In the SoAI WebUI, Settings > Updates shows notes for the published releases between your installed version and the latest available release. If it reports that some notes could not be loaded, use the repository's Releases section to read them before updating.

The public documentation is updated for the latest SoAI release and does not retain separate version-specific documentation sets.

What to look for

Read the notes for the release you plan to install, along with any notes for releases between it and your current installation. Pay particular attention to changes involving:

  • supported platforms, hardware, and editions;
  • configuration, plugins, models, APIs, or client integrations;
  • data migrations or actions required before or after updating;
  • known limitations and resolved issues.

Before updating

  1. Create a backup in Settings > Backup, download it, and keep the copy away from the SoAI host.
  2. Confirm that the release supports your installed edition, platform, and update path.
  3. Follow any preparation described in the release notes before starting the update.
  4. Verify manually downloaded release files before installing them.

After updating

Confirm the displayed release, then check plugin health, model availability, authentication, files, automations, and the workflows you rely on. If an update is interrupted or a required check fails, use the recovery guidance in Updating SoAI instead of manually changing application data.

Platform update paths

  • Linux installations can use the WebUI update flow when a compatible Core release is available.
  • Windows installations use the WebUI update flow, which verifies and hands off the installer for the new release.
  • macOS (experimental) installations use the WebUI update flow with the manifest-authenticated complete archive.
  • SoAI OS uses its own edition-specific update package; a Core package cannot update a SoAI OS appliance.

Related documentation