SoulFire LogoSoulFire

Upgrade with a rollback plan

Keep software, plugins, and persistent data together across version changes.

Prepare the upgrade

  1. Record the current backend, client, SDK, and plugin versions.
  2. Read the target release notes in the SoulFire releases.
  3. Pause scripts and stop bots.
  4. Create and verify a backup.
  5. Keep the previous image digest or dedicated JAR and its matching plugins.

A mutable latest image tag does not identify the software that ran your earlier test. Use an explicit released tag or digest for a deployment you need to reproduce.

Upgrade Docker

From the directory with your Compose file, change the image to the chosen version. Then run:

docker compose pull
docker compose up -d

For the automated setup, its management menu also offers an update action. Preserve the same backup and version record before using that action.

Upgrade Java

Stop the process cleanly. Replace the JAR with the selected release and update plugins that require that release. Keep the data directory and launch settings unchanged unless the release instructions require a migration.

Verify before resuming

Check the backend health, authenticated client access, instance data, and plugin loading. Connect one bot to a test target. Run one representative script or SDK operation. Inspect the backend log for migration, compatibility, and plugin errors.

Resume a small batch first. Check the result before restoring the full workload.

Roll back

Stop the upgraded backend. Preserve its current data separately for diagnosis. Restore the previous software, plugin set, and pre-upgrade data backup together. Then repeat the verification procedure.

Do not assume that an older binary can read a database after a newer release changes it. A backup made only after the upgrade cannot replace the pre-upgrade recovery point.

How is this page?

Last updated on

On this page