These steps update an existing installation. For how the software is installed and paired with Envoy in the first place, see our help article On-Premise Access Control System.
You need access to the server where the software runs and an Envoy dashboard administrator account. The update takes a few minutes. Your access control integration is offline while the software is stopped, so we recommend updating outside busy hours.
Check your version. On the server, open a terminal or command prompt in the software's folder and run:
Windows: diplomat-client.exe --version
Linux or macOS: ./diplomat-client --version
If the version is 2.1.4 or later, you're done. If it is earlier, for example 2.1.3-..., continue.Download the new version. In the Envoy dashboard, open Integrations > Settings. In the Secure on-premise section, click Enable next to Secure on-premise client download. Choose the server's operating system and platform architecture, then click Download.
Optional: verify the download. The same panel shows the file's SHA-256 hash. Click the i icon to download the public key and hash signature files. If you have OpenSSL installed, run this in the download folder (use diplomat-client.exe on Windows):
openssl dgst -sha256 -verify public_key.pub -signature hash.signature diplomat-client
The result should be Verified OK. If it isn't, don't install the file, and contact us.Stop the running software the way you normally do, for example by stopping its Windows service, scheduled task, or Linux service.
Replace the program file. Copy the new diplomat-client (Linux and macOS) or diplomat-client.exe (Windows) over the old one in the same folder. Keep your existing config.yaml. It holds your connection settings, and you don't need to change it. On Linux and macOS, make the new file executable: chmod +x diplomat-client.
Start the software again and check the version as in step 1. It should show 2.1.4 or later.
Confirm the connection. In the Envoy dashboard, go back to Integrations > Settings and open Secure on-premise client configuration. The Connection status column should show connected for your client.