Skip to content
← Documentation

Updating Heliont

Installation

Use the Heliont Installer in update mode to move an existing installation to a newer entitled release. Update replaces product images and stock compose.yml while preserving configuration, certificates, data, and Docker volumes.

What update preserves

  • Host config under <install-dir>/config/ (including heliont.conf, TLS material, and staged license)
  • Docker volumes (database, runtime, filesystem, cache, logs)
  • Site overlay <install-dir>/.compose/compose_extend.yml when present
  • Manual overlays under <install-dir>/.devconfig/ (never auto-applied)

What update replaces

  • Stock compose.yml
  • Heliont container images from the entitled pack (online download or offline archive)

Before you update

  1. Confirm maintenance entitlement for the target version (your license gates which packs you may install).
  2. Back up customer data for production systems.
  3. Download a current Heliont Installer for the server architecture (same curl flow as Linux CLI installation).
  4. Have your license JSON available (prep folder, -license, or the already-staged file under <install-dir>/config/license/heliont-license.json).

Linux CLI update

Interactive

cd ~/heliont-prep   # folder that contains your license JSON (optional if already staged)
sudo ./heliont-install-linux-amd64 \
  -branch update \
  -install-dir /opt/heliont

Use your real install directory if you installed with -install-dir (for example /opt/heliont-app). Accept the license terms when prompted.

Non-interactive

sudo ./heliont-install-linux-amd64 \
  -branch update \
  -install-dir /opt/heliont \
  -license ./heliont-license.json \
  -agree-license \
  -yes

Offline update

sudo ./heliont-install-linux-amd64 \
  -branch update \
  -install-dir /opt/heliont \
  -mode offline \
  -pack ./heliont-VERSION-linux-amd64.tar.gz \
  -license ./heliont-license.json \
  -agree-license \
  -yes

Online update (default)

Omit -mode / -pack so the installer downloads the newest entitled pack from the portal.

Windows and macOS

  1. Run the Heliont Installer.
  2. Choose Update.
  3. Provide or confirm the license, then choose online or offline pack mode.
  4. Wait for images to load and the stack to recreate.

After update

  1. Confirm containers are healthy (docker compose ps from the install directory).
  2. If you use a site extend, start Compose with both files (or COMPOSE_FILE in .env) as described in Linux CLI installation.
  3. Open the application URL and verify the installation.

Browser web setup is not repeated for a normal update of an already operational system.

Troubleshooting

Symptom What to check
no Heliont installation found Wrong -install-dir; point at the directory that contains compose.yml and config/
License / entitlement errors Use a current license from Licenses; offline packs must match entitlement and architecture
Ports already in use after update Ensure .compose/compose_extend.yml is still present; stock compose alone republishes 80/443
Services unhealthy Check docker compose logs for the install directory; runtime rebuilds its disposable target on start

Related documentation