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

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