Skip to main content
Version: 2.7

Upgrading Cortex

info

If you're upgrading from 1.x to 2.0, ensure you read through the specific upgrade notes.

Upgrading Cortex depends on how it was originally deployed. The upgrade process differs slightly for:

  • IIS or VM-based installations
  • Docker or container-based deployments

For IIS-based environments, the recommended approach is to use the Cortex Installer, which automates the upgrade process.

All releases are available at: https://releases.synapsesoftware.com/

Recommended: Upgrade Using the Installer (IIS / VM)​

If Cortex is installed in IIS or directly on a Windows Server or VM, the simplest and safest upgrade method is to use the installer.

Steps​

  1. Download the latest installer from
    https://releases.synapsesoftware.com/
  2. Launch the installer.
  3. Click Upgrade.

Upgrade button

  1. Confirm the upgrade when prompted.

Upgrade confirmation popup

During the upgrade process, the installer automatically:

  • Stops the IIS Application Pool
  • Copies the new Cortex files over the existing installation
  • Preserves your existing configuration (connection strings, authentication settings, application pool identity, etc.)
  • Prompts you to confirm the installation directory or Application Pool if either was customized
  • Restarts the IIS Application Pool after completion

After the installer finishes:

  1. Click OK.
  2. Open your browser.
  3. Validate that Cortex loads successfully.

No manual file copying or configuration restoration is required when using the installer.

Manual Upgrade (IIS or VM)​

If you prefer to upgrade manually:

  1. Stop IIS (or stop the Cortex process if running directly).
  2. Make a backup of:
    • appsettings.json
    • web.config
  3. Delete all files from the existing Cortex installation directory.
  4. Download the new version from
    https://releases.synapsesoftware.com/
  5. Extract the new version into the same directory.
  6. Restore your appsettings.json and web.config files.
  7. Start IIS (or restart the Cortex process).

At present, no modifications to appsettings.json or web.config are required between minor versions unless otherwise stated in release notes.

Docker or Other Container Runtime (Kubernetes, etc.)​

For container-based deployments, upgrading Cortex means updating the image tag and redeploying the container.

General Process​

  1. Change the image tag to the desired version.
  2. Restart or redeploy the container.

Examples​

  • For docker run, launch a new container using the updated tag.
  • For docker compose, update the image tag in your compose file and run: