Install on Windows (Self-hosted Installer)

Who this is for

Use this guide if your organization is deploying Total Shift Left (self-hosted) in your own environment and you’ve been given a Windows installer (.exe).

If you’re using a cloud workflow instead, start with Getting started.

What gets installed

The Installer can install and manage these components:

• Backend: API server + system service (Windows service name: API-Automation-Backend)
• Frontend: desktop application (Electron)

Default installation folder:

• C:\Program Files\API Automation Platform\

Requirements

Permissions and system

• Windows 10/11
• Administrator access (you’ll see a UAC prompt)
• Disk space: at least 2 GB free
• Network access: recommended for downloading components and updates

Database (MongoDB)

The Backend requires access to a MongoDB instance:

• MongoDB 4.4+
• You need:
  • MongoDB Connection URI (example: mongodb://localhost:27017 or mongodb+srv://user:pass@cluster.mongodb.net)
  • Database name (default: api-automation)

Ports

Default ports the Installer may check/use:

• Backend: 5001 (configurable)
• Additional checks: 8080

Step 1 — Download and verify the installer

1. Download the installer .exe from the link provided by your admin / support contact.
2. Recommended: verify the SHA‑256 checksum.

certutil -hashfile "C:\Path\To\Installer.exe" SHA256

Compare the hash with the .sha256 file or the checksum value you were given.

Step 2 — Install the Installer app

1. Run the downloaded installer .exe.
2. Approve any Windows prompts (SmartScreen/UAC) if you trust the source.
3. Complete the setup wizard.

After installation, you should have a shortcut named:

• API Automation Platform Installer

Typical installed location:

• C:\Program Files\API Automation Platform\Unified-Installer\

Step 3 — Install or update components

Open API Automation Platform Installer.

3.1 (Optional) Update the Installer

If you see Installer Update Available, choose:

• Update Now to apply the latest Installer version, or
• Later to continue without updating.

3.2 Choose what to install

In Select Components to Install or Update:

• Select Install Backend and/or Install Frontend
• Click Continue

If you already have components installed, you may see Update Backend / Update Frontend instead.

3.3 Configure MongoDB (Backend)

In Installation Configuration → Database:

1. Enter:
   • MongoDB Connection URI
   • Database Name
2. Click Validate Connection (recommended)

If MongoDB isn’t reachable at install time, the Installer may allow you to continue and configure the database later.

3.4 Configure the backend port (optional)

In Service, set Backend Port (default: 5001).

3.5 Start installation

Click Start Installation and wait for both progress bars to complete.

Verify installation

Confirm the service is running

Open Services (services.msc) and confirm:

• API-Automation-Backend is Running

Or run:

sc.exe query "API-Automation-Backend"

Confirm the install folders exist

• C:\Program Files\API Automation Platform\Backend\
• C:\Program Files\API Automation Platform\Frontend\

Update later

To update:

1. Open the Installer
2. Choose Update Backend and/or Update Frontend
3. Continue through the prompts

Change MongoDB settings later

If the Backend is already installed and up to date, you can use:

• Configure database → update URI + database name → Save configuration

The Installer will attempt to restart the backend service to apply the new settings.

Uninstall

In the Installer, use Uninstall Components:

• Uninstall Backend: removes the backend service and backend files
• Uninstall Frontend: removes the desktop app and frontend files

Some files may require a reboot to fully remove if Windows has them locked.

Silent install (for IT deployment)

Many Windows deployments use silent installation.

NSIS installers typically support /S for silent install and /D=<path> for install directory (must be the last argument).

Example:

Start-Process -FilePath "C:\Path\To\Installer Setup.exe" `
  -ArgumentList '/S', '/D=C:\Program Files\API Automation Platform\Unified-Installer' `
  -Wait

Logs and troubleshooting

Installer self-update logs

If the Installer updates but does not relaunch, check the newest log:

• %TEMP%\installer-update-*.log

Get-ChildItem $env:TEMP -Filter "installer-update-*.log" |
  Sort-Object LastWriteTime -Descending |
  Select-Object -First 1

Installer crash log

If the Installer fails to start, a crash log may be written to:

• %TEMP%\installer-crash.log

Common fixes

• Admin errors: run the installer as Administrator
• MongoDB validation fails: confirm URI/credentials, firewall rules, and MongoDB version (4.4+)
• Port conflicts: change the backend port or stop the conflicting service
• Service won’t start: check backend logs under ...\Backend\current\logs\

Next steps after install

Once the services are running, complete the initial setup inside the product:

• Initial configuration (users, licensing, first project)
• Configuration fundamentals (base URL, auth, runtime controls)
• Debug logging (if you need deeper troubleshooting)