Upgrading Portway

Upgrading Portway is usually a matter of replacing the binaries and letting it start back up, but proper preparation and a back-up strategy is required. Releases may include application, configuration and database changes, so it is recommended to read the release notes first and to check that no breaking changes apply to your configuration.

Find your current version ​

Your installed version is recorded in .version.txt in the deployment directory. Update this file after upgrading to keep version information current, this is useful when submitting bug reports.

Steps ​

1. Read the release notes

Review the GitHub release notes for migration steps, breaking changes, and new configuration requirements.

2. Back up your installation

Copy these files and directories to a safe location before making any changes:

• appsettings.json
• auth.db
• environments/
• endpoints/
• .core/

3. Stop the application

IISDocker

powershell

Stop-WebAppPool -Name "PortwayAppPool"

sh

docker compose down

4. Replace application files

Extract the new release over your existing directory, replacing application files. Do not overwrite your configuration files (appsettings.json, environments/, endpoints/).

Docker:

docker compose pull && docker compose up -d

5. Restore configuration

If the release notes require configuration changes (new fields, renamed settings), apply them to your appsettings.json and environment files now.

6. Start and verify

Start the application pool or container and confirm:

• GET /health/live returns Alive
• Endpoints respond as expected in your test environment