Portal Integration
Portal Integration connects the local Banalytics server to the Banalytics cloud portal through a WebSocket signaling channel used for remote access and messaging.
Connect a local server to the Banalytics portal
The Portal Integration component enables secure peer-to-peer communication between a Banalytics server installed on a local PC and a Banalytics web account. This connection allows remote access to the system directly through the browser, without port forwarding or VPN configuration.
The component connects to the portal signal server and keeps the environment available for remote sessions. Portal WebRTC Integration then uses this signaling layer to establish the actual peer-to-peer channels for data, media, file transfer, and shared access.
Use the assigned portal address
Portal address points to the signal server used to establish remote communication. In most installations it is assigned automatically and should not be changed.
Identify the environment
Environment UUID uniquely identifies the local server environment. It is generated by the system and is read-only.
Keep the connection alive
Ping timeout (sec) controls the keep-alive interval. Adjust it only when the network is unstable or remote connectivity needs different failure detection behavior.
Configuration parameters
| Parameter | Required | Description | Default |
|---|---|---|---|
ID | Yes | A unique, automatically generated identifier for this component instance. This value is not editable. | Auto |
Restart on failure | Yes | Restart mode after an error:
| 10 sec |
Portal address | Yes | Address of the portal signal server used for establishing remote communication. It is normally assigned automatically and should remain unchanged unless you are connecting to a specific portal deployment. | wss://router.banalytics.live |
Environment UUID | Read-only | Unique identifier of the Banalytics server environment, usually the local PC or edge device running the agent. Generated automatically and not editable. | Auto |
Ping timeout (sec) | Yes | Keep-alive ping interval in seconds. Use a shorter timeout for faster detection of broken connections, or a longer one for unstable networks where temporary pauses are expected. Range: 10-60. | 30 |
The portal connection provides signaling and availability
Portal Integration keeps the local Banalytics server registered and reachable through the portal account. It exchanges WebSocket messages with the portal signal server so remote browser sessions can discover the environment and initiate peer-to-peer communication.
The component displays live metrics collected since the last server start or restart. These metrics help you understand whether remote connectivity is healthy and whether the server is exchanging messages with the portal.
Remote access
Enables browser-based remote access without requiring inbound port forwarding or VPN setup on the local network.
WebSocket signaling
Maintains the signaling channel used to coordinate remote sessions and exchange portal messages.
Environment identity
Uses the environment identifier to associate the local server with the correct portal account and remote access context.
Use Portal Integration when remote access depends on the portal
Home or small office remote access
Use the default portal address and ping timeout so authorized users can reach the local Banalytics server from a browser without exposing the device through router port forwarding.
Organization access sharing
Use Portal Integration together with Portal WebRTC Integration when different users or groups need controlled access to selected cameras, tasks, actions, or configuration areas.
Connectivity troubleshooting
Watch connection and WebSocket message metrics after restart or network changes. If messages stop or errors grow, check portal reachability, DNS, firewall rules, and local network stability.
Operational metrics
Connections
Connections (established / closed / errors) shows peer-to-peer connection attempts initiated through the signal server, including successful connections, disconnections, and errors.
WebSocket messages
WebSocket Messages (in / out) shows incoming and outgoing messages exchanged between the Banalytics server and the portal.
Restart boundary
Metrics are collected since the last server start or restart, so use them as a live operational indicator rather than a long-term audit history.