1.2Deploying to a gateway
Pair the Configurator with a gateway using the deploy token, send the project, and understand what the deploy steps and errors mean.
Deploying sends your saved project to the gateway. The gateway applies it, and the apps pick up the new version.
#Before you deploy
- The gateway address. The Configurator deploys to the project's Local IP Address. Set it in Server > Gateway (the project wizard also asks for it). It is the gateway's IP address on the site network. If the field is empty, the Configurator tries
192.168.1.15. - A deploy token. The gateway only accepts projects from a Configurator that has its token.
- Open the gateway console in a browser (see Gateway console and logs).
- Go to the Cloud tab and find Deploy Pairing.
- Click Copy deploy token.
- In the Configurator, open the Server tab, select Gateway, and paste the token into Deploy Token.
This pairing is done once per gateway. Deploy uses the token automatically from then on. The token is saved in the project file, in plain text, so treat the project file like a password.
#Deploy
Click Deploy in the toolbar. The Deploy to Gateway dialog shows the steps as they run:
| Step | What happens |
|---|---|
| Check project | The project is validated. |
| Optimize project | Unused and built-in images are removed from the upload to keep it small. |
| Find server | The gateway's health endpoint is checked (8 second timeout). |
| Upload project | The compressed project is sent to the gateway. |
| Confirm deploy | The gateway confirms it accepted the project. |
| Cloud sync | If the gateway is linked to a cloud account, the project is synced there too. |
When it succeeds, the dialog shows Deployed <project> to <host> and closes by itself.
The Configurator always talks to port 3127 on the gateway. If you need a different port, type it into the address as ip:port.
#Cloud sync
The cloud copy of the project is updated by the gateway after a deploy. This requires the gateway to be registered with a cloud account (gateway console, Cloud tab, Enable). The gateway console shows the sync state and the last published revision under Cloud Service. If the apps work locally but not remotely, check there first.
#Common deploy errors
| Message | Likely cause and fix |
|---|---|
| Could not reach … Check the gateway IP, Wi-Fi/network, and runtime service. | Wrong address, PC on a different network, or the gateway service is not running. Open the console address in a browser to confirm. |
| Gateway health check returned … | The gateway answered but reported a problem. Check the Overview tab of the console and the logs. |
| A valid deploy token is required to publish a project to this gateway. | The token is missing or was regenerated. Re-copy it from the console. |
| Could not reach the gateway during upload… | The connection dropped mid-upload. Check Wi-Fi or cable, and retry. |
| Gateway did not return a deploy response. | The gateway runtime is stuck. Restart the software from the console's Monitor tab and deploy again. |
#After a deploy
- Open an app (see Connecting the apps) and check the pages.
- If you changed intercom settings, check that the door station and the apps still show as registered (see Intercom and door stations).
- Users and their intercom extensions come from the project, so if an app user cannot log in, make sure the user exists in Server > Gateway > Users and the project was deployed after adding them.