# Open5G2GO: SurfControl Dashboard

# User Guide

This guide covers how to use the Open5G2GO web interface to manage your private 4G network.

## Accessing the UI

Open your browser and navigate to:

```
http://YOUR_SERVER_IP:8080
```

The interface has four main sections accessible from the sidebar:

* **Dashboard** - System overview and real-time status
* **Devices** - Subscriber/device management
* **Network** - Network configuration display
* **Services** - Core network service monitoring


---

 ![Open SurfControl dashboard - Initial State - No radios connected, no devices provisioned.](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/bcdc8248-9752-47b6-aef9-c30b5d469051/f6488efc-1713-44aa-99e8-36599649109a/192.168.8.5_8080_%20%282%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260927%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260927T134500Z&X-Amz-Expires=86400&X-Amz-Signature=c1272dc46483786a4139f4b5748a6baba03f2c7287e2c1a7e3d519395c9ce1af&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =2244x2250")

## Dashboard

The Dashboard provides a real-time overview of your network status. Data auto-refreshes every 30 seconds.

 ![Open SurfControl Dashboard with active gNodeB and a connected device.](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/bcdc8248-9752-47b6-aef9-c30b5d469051/3cb5b1a6-bfdb-4a12-80ad-5043de144e83/192.168.8.5_8080_%20%285%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260927%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260927T134500Z&X-Amz-Expires=86400&X-Amz-Signature=bcb9f43ad51e84c9626ab5ad827c8cdea400fa5fda7a1ae78d4badbe05bf6305&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =2244x2342")

### Stats Cards

At the top, four cards show key metrics:

| Card | Description |
|------|-------------|
| **Provisioned Devices** | Total devices added to the system |
| **Registered UEs** | Devices currently registered with the network |
| **Connected Devices** | Devices with active data sessions |
| **Connected eNodeBs** | Base stations connected via S1AP |

### System Health

Shows operational status of core components:

* **Core Status** - Whether Open5GS services are running
* **eNodeB Connection** - Whether any base station is connected
* **Active Sessions** - Whether any devices have active data sessions

### eNodeB / gNodeB Status

Displays connected base stations with detailed metrics (if SNMP is configured):

* **Cell** - RF status, band, frequency, TX power
* **Core** - S1AP link status, TAC, Cell ID, PCI
* **Traffic** - Connected UE count, throughput (DL/UL), PRB usage
* **Health** - Alarms, CPU utilization, RRC/E-RAB success rates

### Active Connections

Table showing currently connected devices:

| Column | Description |
|--------|-------------|
| Device Name | Friendly name you assigned |
| IMSI   | International Mobile Subscriber Identity |
| IP Address | Assigned IP from UE pool |
| APN    | Access Point Name |
| Status | Connection state (CONNECTED, IDLE, etc.) |


---

## Devices

The Devices page lets you manage subscribers (SIM cards) provisioned on your network.

### Viewing Devices

The main table displays all provisioned devices with:

* **Device Name** - Friendly identifier
* **IMSI** - Full 15-digit subscriber identity
* **Static IP** - Assigned IP address from the UE pool
* **APN** - Access point name (default: "internet")

Use the **search box** to filter by name, IMSI, or IP address.

 ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/bcdc8248-9752-47b6-aef9-c30b5d469051/e4aceb8e-10d9-4aff-ab90-8c4f7bf1766f/192.168.8.5_8080_%20%284%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260927%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260927T134500Z&X-Amz-Expires=86400&X-Amz-Signature=e2523bf311d1617dce6c76588a7594c9e4c9e73386bf2e38d5568604c2989021&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =2260x1460")


### Adding a Device


1. Click the **Add Device** button (top right)
2. Fill in the form:
   * **IMSI** - Full 15-digit IMSI from your SIM card (e.g., `315010000000001`)
   * **Device Name** - Friendly name (e.g., "Camera 1")
   * **IP Address** - Optional, auto-assigned if left blank
3. Click **Add Device**

The system automatically:

* Validates the 15-digit IMSI format
* Assigns a static IP from the UE pool (based on last 4 digits of IMSI)
* Uses the K/OPc authentication keys configured during setup

 ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/bcdc8248-9752-47b6-aef9-c30b5d469051/05cbeca7-b9c8-4c5d-8b05-35002937ae17/192.168.8.5_8080_%20%283%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260927%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260927T134500Z&X-Amz-Expires=86400&X-Amz-Signature=ffc49bb35db9b8b30ef63b55548aa228d33ec704ac487228b490c9e8b76d3d50&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =2260x1460")


### Viewing Device Details

Click the **eye icon** on any device row to see:

* Full IMSI
* Assigned IP address
* Authentication keys (K, OPc)
* QoS profile settings
* APN configuration

### Editing a Device


1. Click the **pencil icon** on the device row
2. Modify the device name or APN
3. Click **Save Changes**

Note: IMSI and IP address cannot be changed after creation.

### Deleting a Device


1. Click the **trash icon** on the device row
2. Confirm deletion in the popup

**Warning:** Deleting a device removes it from the network immediately. The device will lose connectivity.


---

## Network Configuration

The Network page displays your current network settings (read-only).

 ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/bcdc8248-9752-47b6-aef9-c30b5d469051/e55704ca-a35c-4d9b-9394-7a5f818364f8/192.168.8.5_8080_%20%286%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260927%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260927T134500Z&X-Amz-Expires=86400&X-Amz-Signature=01b096401c47b43a1d7bc327b6af5d64f3966c7767fbfa1d5cf2f1aad898d309&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =2244x3152")


### Network Identity

Core network identifiers (configured during setup wizard):

| Setting | Description | Example |
|---------|-------------|---------|
| PLMNID  | Public Land Mobile Network ID | 315010, 001010, 999990 |
| MCC     | Mobile Country Code | 315, 001, 999 |
| MNC     | Mobile Network Code | 010, 01, 99 |
| TAC     | Tracking Area Code | 1       |

**Note:** PLMN is selected during the setup wizard and must match your SIM cards.

### eNodeB / gNodeB Configuration

Settings to use when configuring your base station:

| Setting | Value |
|---------|-------|
| MME/AMF IP Address | Your Docker host IP |
| MME/AMF Port | 36412 |
| PLMN ID | Your configured PLMN |
| TAC     | 1     |

Copy these values to your eNB/gNB configuration interface.

### Access Point Names (APNs)

Lists configured APNs with bandwidth limits:

* **APN Name** - Identifier (e.g., "internet")
* **Downlink Bandwidth** - Max download speed (Kbps)
* **Uplink Bandwidth** - Max upload speed (Kbps)


---

## Services

The Services page monitors Open5GS core network components.

 ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/bcdc8248-9752-47b6-aef9-c30b5d469051/f70906e3-6747-41ff-86fd-c64390e3493d/192.168.8.5_8080_%20%287%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260927%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260927T134500Z&X-Amz-Expires=86400&X-Amz-Signature=9573ccf769f9b8c7f54eee3406aa907df113287dc9ab97394564b589092642a9&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =2244x2000")


### Summary Cards

Quick status overview:

| Card | Description |
|------|-------------|
| Total | Number of monitored services |
| Running | Services operating normally |
| Stopped | Services not running |
| Error | Services in error state |
| Unknown | Services with unknown status |

### Service Categories

Services are grouped by function:

**4G EPC Core:**

* **HSS** - Home Subscriber Server (authentication)
* **MME** - Mobility Management Entity (signaling)
* **SGWC** - Serving Gateway Control Plane
* **SGWU** - Serving Gateway User Plane
* **SMF** - Session Management Function
* **UPF** - User Plane Function
* **PCRF** - Policy and Charging Rules

**Management:**

* **Backend** - REST API server
* **Frontend** - Web UI
* **MongoDB** - Subscriber database

### Status Indicators

Each service shows:

* **Green dot/checkmark** - Running normally
* **Red dot/X** - Stopped or error
* **Gray dot/?** - Unknown status

Click **Refresh** to update status immediately.


---

## Common Tasks

### Provision a New SIM


1. Go to **Devices**
2. Click **Add Device**
3. Enter the full 15-digit IMSI from your SIM card
4. Give it a friendly name
5. Click **Add Device**
6. Insert SIM into your device and power on

### Check if a Device is Connected


1. Go to **Dashboard**
2. Look at the **Active Connections** table
3. Your device should appear with status "CONNECTED"

### Verify eNodeB / gNodeB Connection


1. Go to **Dashboard**
2. Check **System Health** > **eNodeB/gNode Connection** shows "Connected"
3. Check **eNodeB/gNodeB Status** section shows your base station

### Troubleshoot a Device Not Connecting


1. Go to **Devices** and verify the device is provisioned
2. Go to **Dashboard** and check if eNodeB is connected
3. Go to **Services** and verify all services are running
4. Check the [Troubleshooting Guide](/doc/open5g2go-troubleshooting-pehwganA8Q) for common issues


---

## Tips

* **Auto-refresh**: Dashboard and Services pages refresh every 30 seconds
* **Manual refresh**: Click the Refresh button on any page for immediate update
* **Search**: Use the search box on Devices page to quickly find a specific device
* **IMSI format**: Always enter the full 15-digit IMSI from your SIM card