Open5G2GO: Quick Start Guide

Quick Start Guide

Get up and running with Open5G2GO in minutes.

Before You Begin

The setup wizard will prompt you for the following information. Have these ready:

Item

Description

Where to Get It

SIM Ki Key

32-character hex authentication key

From your SIM vendor

SIM OPc Key

32-character hex operator key

From your SIM vendor

PLMN

Network identity (MCC-MNC) matching your SIMs

Usually 315-010 for US CBRS

eNodeB IP Address

Management IP of your Baicells eNodeB

From eNodeB web interface or DHCP

Host IP Address

IP of the machine running Open5G2GO

Auto-detected, but verify it's reachable from eNodeB

Need SIMs? Order pre-programmed SIMs with matching Ki/OPc at: https://waveriders.live/sims

Prerequisites

Before you begin, ensure your system meets these requirements:

  • Operating System: Ubuntu 22.04 LTS or similar Linux distribution

  • Docker: Version 24.0 or later

  • Docker Compose: v2 or later

  • Disk Space: At least 5GB free space

  • Network Ports: The following ports must be available:

    • 36412/sctp - SCTP traffic

    • 2152/udp - GTP-U traffic

    • 8080/tcp - Web UI and API

Installation

One-liner Install (Recommended)

For the quickest setup, use the automated installation script:

curl -fsSL https://raw.githubusercontent.com/Waveriders-Collective/open5G2GO/main/install.sh | bash

This script will:

  1. Check system prerequisites

  2. Clone the repository

  3. Run interactive setup wizard

  4. Pull pre-built Docker images

  5. Start the stack

Setup Wizard

After running the one line installation you will go through the step by step setup wizard;

Step 1. Network Mode: Select whether you want to deploy a 4G or 5G SA version of Open5G2GO


Step 2. Network Configuration: Open5G2GO is built to operate on a docker host with a single physical Ethernet interface. The wizard confirms which interface will be used. Enter to confirm default selection.


Confirm UE IP Pool: The default IP range for UEs connecting to Open5G2GO, only update this if the default 10.48.99.0/24 conflicts with your existing IP schema.

Confirm UE IP Gateway: Default is 10.48.99.1. Enter to accept default.

Step 3. Network Identity (PLMNID): A number of 3GPP standard PLMNID can be selected for your network including CBRS (USA Only) 315010, and 999 prefix PLMNIDs assigned to private networks for global use.


Step 4. SIM Configuration: This is where you will enter the Ki/OPc keys that will be used to secure access to your network. Your SIMs will all use this same Ki/OPc combination. For enhanced security, unique Ki/OPc can be used. For simplicity, SurfControl UI only accepts input of IMSI, name and fixed IP address, assuming that SIMs will be configured with the globally set Ki/OPc.


Step 5. eNodeB/gNodeB Configuration: The SurfControl UI can monitor status of connected 4G and 5G radios. Enter the IP address of the eNodeB/gNodeB here. We recommend configuring your radio with a fixed IP address.


If your lab has more than one radio, you can add them now, or later via the radio config files.

Initial Setup Complete! The setup wizard will now download the latest docker images ready to start your Open5G2GO instance.


Check health of your containers with the command below

docker ps --format 'table {{.Names}}\t{{.Status}}'


Start your Open5G2GO instance by enter the command below;

cd open5G2GO
./scripts/pull-and-run.sh

The latest docker images will now be pulled to your machine and started.

Once completed use the OpenSurfControl UI to monitor and manage your system. It will be accessible via your web browser at the docker host IP you entered earlier in the wizard at port 8080

http://<docker-host-ip>:8080

Manual Install

If you prefer manual installation or need more control over the setup process:

  1. Clone the repository:

    git clone https://github.com/Waveriders-Collective/open5G2GO.git
cd open5G2GO

  2. Run the preflight check to verify your system:

    ./scripts/preflight-check.sh

  3. Run the setup wizard:

    ./scripts/setup-wizard.sh

  4. Pull images and start the services:

    ./scripts/pull-and-run.sh

First Device Provisioning

Once the system is running, you can add your first device:

  1. Access the Web UI: Open your browser and navigate to http://YOUR_IP:8080 (replace YOUR_IP with your server's IP address)

  2. Navigate to Devices: Click on the "Devices" page in the navigation menu

  3. Add Device: Click the "Add Device" button

  4. Enter Device Information:

    • IMSI: Enter the full 15-digit IMSI from your SIM card (e.g., 315010000000001)

    • Device Name: Give it a friendly name (e.g., "Camera-01")

  5. Confirm: The device will appear in the devices list once successfully provisioned

Verification

Check Container Health

Verify that all Docker containers are running and healthy:

docker compose -f docker-compose.prod.yml ps

All containers should show a status of "Up" or "healthy".

Check API Health

Verify the API is responding correctly:

curl http://localhost:8080/api/v1/health

A successful response indicates the system is operational.

Updates

To update to the latest version:

cd ~/open5G2GO
./scripts/update.sh

Next Steps