Windows Native Installation

Production Recommendation

Native Windows Service is the recommended deployment method for Windows production environments. For the full service installation, management, update, rollback, and troubleshooting guide, see Windows Service Installation.

Quick Start — Console Mode

For development or quick testing, you can run the API directly in a console:

1. Place the binary in a secure directory.
2. Create a secured .env file from .env.example. The installer never auto-creates .env.
3. Run:

powershell .\iqv-integration-api.exe serve

Warning

Console mode is not recommended for production. The process will stop when the console session closes.

Production — Native Windows Service

Install the API as a native Windows Service using the provided installer script:

powershell powershell.exe -ExecutionPolicy Bypass -File .\scripts\windows\service\install.ps1

This registers the IQVIntegrationAPI service that starts automatically on boot. The service binary supports install, uninstall, start, stop, restart, status, and run subcommands via --env-file:

powershell .\iqv-integration-api.exe service install --env-file C:\IQVizyon\IQVIntegrationAPI\config\.env

For full details including directory layout, firewall rules, health checks, exit codes, update, rollback, and troubleshooting, see:

• Windows Service Installation
• Update and Rollback
• Configuration — Runtime Paths

Docker (Separate Deployment Type)

Docker on Windows is a separate deployment type and is not a substitute for the native Windows Service. See Windows Docker Installation and Docker Installation.

Legacy: WinSW

Previous documentation recommended WinSW as a service wrapper. The native Windows Service support built into the binary replaces this approach. WinSW is no longer the primary recommendation.

If you are migrating from a WinSW-based deployment, uninstall the WinSW service and install using the native service installer above.