Upgrade Procedure

Upgrading Spillbox

upgrade.sh exists on both the client and the server. The client and server must be running compatible versions. If they drift apart, splrun will detect the mismatch the next time a project is created and stop with an error telling you to upgrade — so it’s always safe to check your version before assuming something else is wrong.

How upgrade.sh Picks a Version

Every Spillbox release has a version number in the form X.Y.Z (for example, 3.1.0). The leading number (3) is the major version.

Running ./upgrade.sh with no arguments:

• Checks the major version you currently have installed (the 3 in 3.1.0).
• Looks up the published versions and picks the newest one that matches that same major version.
• Downloads and installs it.

For example, if you have 3.1.0 installed and 3.1.1 is the newest release under major version 3, plain ./upgrade.sh installs 3.1.1. It will not move you to a different major version on its own.

Where to Run It

• Client: run upgrade.sh from your local Spillbox client install directory.
• Server: run upgrade.sh from the Spillbox server install directory on the on-prem host. This also rebuilds the Docker image and restarts the server, so it should be run by an admin during a maintenance window.

Usage

./upgrade.sh Installs the newest release with the same major version as what you have now (e.g. 3.1.0 -> newest 3.x.x).

./upgrade.sh -latest Installs the newest release available overall, even if it’s a different major version.

./upgrade.sh -version <X.Y.Z> Installs an exact version.

./upgrade.sh -list-versions Lists available versions without installing anything.

Server-only options:

-restart Pushes the current Docker image to the registry and restarts the server.

Note: No new version will be downloaded.

-skip-image Downloads the latest version for your current major version (or the one given with -version/-latest) and restarts the server, but skips pushing the Docker image to the registry.

-tag <servername> Downloads the latest version for your current major version (or the one given with -version/-latest) and restarts the server associated with the specified tag.

What It Updates

• Client: replaces the client binaries/tools in place.
• Server: downloads the new release, rebuilds the Docker image, and restarts the server.

Checking Your Version

• Client: splrun version

• Server: terraform/version.sh (run from the server install directory)

  $ terraform/version.sh Server version 3.2.1

Good practice after any upgrade — confirm the version installed is actually the one you expected.

Troubleshooting

“Client version differs from server version” — splrun prints this and stops before creating a project if the client and server versions don’t match:

Client version (X.Y.Z) differs from server version (X.Y.Z)

Run upgrade.sh on whichever side is behind, then try again.