Adding a Connector
Connectors are registered through the platform and then deployed on physical or virtual hardware at the target site.
Steps
- Navigate to Equipment > Connectors.
- Click the Add Connector button in the top-right corner.
- Fill in the connector details:
| Field | Required | Description |
|---|---|---|
| Name | Yes | A display name for the connector (e.g., "Melbourne Branch Office") |
| Serial Number | Yes | The unique serial number of the device |
| Region | Yes | Geographic region or site label for organizational purposes |
| Hub Edge | Yes | The dedicated edge this connector will tunnel to (dropdown of available edges in your tenant) |
- Click Create to register the connector.
Hub Edge Selection
The hub edge is the dedicated edge device that serves as the central connectivity point for this connector. The connector will establish a WireGuard backbone tunnel (wg0) to the selected hub edge.
The dropdown shows all available dedicated edges within your tenant. Choose the edge that is geographically or logically closest to the connector's deployment site for optimal performance.
The hub edge must be online and have WireGuard configured before the connector can establish its tunnel. Ensure your hub edge is fully operational before deploying the connector.
Deployment Credentials
After creation, a dialog displays one-time deployment credentials:
- Deployment Token -- used to authenticate the connector during bootstrap
- Password -- paired with the token
Copy these credentials immediately. They are shown only once and cannot be recovered after closing the modal. If lost, the connector must be deleted and re-created.
After Creation
The connector appears in the connectors list with a pending status. It will remain pending until:
- The physical device is deployed and bootstrapped using the credentials.
- The device connects to the orchestrator via MQTT.
- The connector transitions through the activation lifecycle.
See Hub Edge Assignment to understand how the connector connects to your network, or Connector Configuration to manage its settings.