Surge Dashboard
Surge Dashboard is a graphical interface for reviewing requests, inspecting the DNS cache, and managing devices. It is included with Surge Mac and can connect either to the local Surge instance or to a remote Surge instance.
Local and Remote Connections
On macOS, the Dashboard connects to the local Surge instance directly, with no configuration required.
The Dashboard can also manage a remote Surge instance — another Surge Mac, or a Surge iOS device — when external-controller-access is configured on the remote instance:
[General]
external-controller-access = apassword@127.0.0.1:8888
For Surge iOS, the Dashboard can connect over Wi-Fi or over USB. Since inbound connections from cellular networks are always rejected, connect the device over USB to inspect traffic while it is using a cellular connection.
Surge Dashboard can also read Logbook content from remote Surge Mac and Surge iOS instances.
Traffic Statistics
The Traffic Statistics tab ranks traffic by policy, process, interface, device, or host.
Use the Breakdown button at the right end of the bottom bar to break each row down by host or policy Mac 6.11.0+. For example, choose Policy in the sidebar and Host from the Breakdown menu, then expand a policy to see which hosts used it, ranked by traffic. Broken down rows show today, this month, and last month. The Breakdown button appears when the connected instance is Surge Mac 6.11.0 or later, or Surge iOS 6.0.0 or later.
Parameters
external-controller-access
This [General] option enables management from an external controller, such as Surge Dashboard or Surge CLI with --remote.
The value is made up of three parts: password, listen address, and port number, in the form password@address:port. No part can be omitted.
On Surge iOS, the listen address controls which connections are accepted:
127.0.0.1: only USB connections are allowed.0.0.0.0: connections from the local Wi-Fi network are also allowed.
Connections from cellular networks are always restricted for security reasons.
Web Dashboard
Besides the native Dashboard, Surge also provides a web-based dashboard served by the HTTP API. Enable it with the http-api-web-dashboard option; see HTTP API and the [General] section reference.