On-premises Gateway reference
Downloads, requirements, commands, proxies, relocating and removing a gateway.
The On-premises Gateway lets a Zato environment in the cloud connect to the systems in your private network. The installation itself is described in Installing the On-premises Gateway.
Downloads
| Platform | File |
|---|---|
| Windows, 64-bit | zato-on-prem-gateway-windows-amd64.exe |
| Linux, x86-64 | zato-on-prem-gateway-linux-amd64 |
| Linux, ARM64 | zato-on-prem-gateway-linux-arm64 |
The executable has no dependencies and no configuration file.
Requirements
- A 64-bit Windows host, or a Linux host running systemd.
- Outbound HTTPS access from the host to the Zato environment.
- Administrative rights on the host, which the service installation requires.
Commands
| Command | Description |
|---|---|
zato-on-prem-gateway install --token TOKEN | Connects with the enrollment token, then installs and starts the service |
zato-on-prem-gateway | Connects in the foreground. On Windows, the token dialog opens when the host is not enrolled yet |
zato-on-prem-gateway --token TOKEN | Connects in the foreground with the given enrollment token |
zato-on-prem-gateway connect | Connects in the foreground without opening a dialog |
zato-on-prem-gateway status | Reports the Zato environment and the name of this gateway |
zato-on-prem-gateway install | Installs the service, which then starts on boot |
zato-on-prem-gateway uninstall | Removes the service |
zato-on-prem-gateway start | Starts the service |
zato-on-prem-gateway stop | Stops the service |
zato-on-prem-gateway restart | Restarts the service |
zato-on-prem-gateway version | Reports the version |
Supplying a token again on a host that is already enrolled as the same gateway keeps the existing enrollment.
On Windows, running the file again opens the token dialog, which is how a new token is entered.
Proxies
The gateway uses the HTTPS_PROXY and NO_PROXY variables:
When the gateway runs as a service, the variable belongs in the environment of the service - a systemd drop-in on Linux, the environment of the service entry on Windows.
Relocating a gateway
- In the Dashboard, click Reset key next to the gateway. The gateway is disconnected.
- Click Enrollment token and copy the new token.
- Install the gateway on the new host with that token.
When Require key resets is disabled for the gateway, the first step is omitted, as described in Re-enrollment.
No outgoing connection in Zato has to be modified.
Removing a gateway
- On the host, remove the service:
- In the Dashboard, delete the gateway.