This guide is based on CentOS Stream 8 Distribution.

Install CentOS Stream 8 from Vagrant box (optional)

Vagrant provides a simple way to create and deploy Virtual Machines from pre-built images using VirtualBox, libvirt, or VMWare as a hypervisor engine. This allows the user to quickly create a virtual machine without the hassle of installing the operating system by hand.

Install Vagrant

The instructions to install Vagrant are provided at vagrantup.com.

Create a CentOS Stream 8 Virtual Machine using Vagrant

Use the supplied Vagrantfile in the vagrant directory to create the virtual machine.

Note that this Vagrantfile is identical to the base CentOS Stream 8 box, with the exception that the amount of virtual memory has been increased to 1GB:

cd vagrant/centos
vagrant up --provider virtualbox

Log into the newly created CentOS VM

Use SSH to log into the CentOS Stream 8 VM:

vagrant ssh

Note that the Open5GS source is not copied into the VM. The instructions below provide the step by step instructions for setting up Open5GS for either a bare metal or virtual CentOS Stream 8 system.

The rest of the commands below are performed inside the CentOS VM as the user ‘vagrant’, or on your bare metal CentOS Stream 8 system as any normal user.

Install prerequisite packages to build and run Open5GS

Enable CentOS Stream 8 PowerTools repository

$ sudo dnf install 'dnf-command(config-manager)'
$ sudo dnf config-manager --set-enabled powertools

Enable the Extra Packages for Enterprise Linux

Enable the Extra Packages for Enterprise Linux repo by installing the epel-release package:

$ sudo dnf install epel-release

Enable ELRepo

Enable the ELRepo repo (with testing enabled):

$ sudo dnf install https://www.elrepo.org/elrepo-release-8.el8.elrepo.noarch.rpm
$ sudo dnf config-manager --set-enabled elrepo-testing

Install MongoDB using the package manager:

Create a repository file to install the MongoDB packages:

$ sudo sh -c 'cat << EOF > /etc/yum.repos.d/mongodb-org-6.0.repo
name=MongoDB Repository

Install MongoDB using the package manager:

$ sudo dnf -y install mongodb-org

Install the dependencies for building the source code.

Open5GS requires several packages which are not installed by default in a base CentOS Stream 8 installation.

$ sudo dnf install python3 meson cmake ninja-build gcc gcc-c++ flex bison git cmake lksctp-tools-devel libidn-devel gnutls-devel libgcrypt-devel openssl-devel cyrus-sasl-devel libyaml-devel mongo-c-driver-devel libmicrohttpd-devel libcurl-devel libnghttp2-devel libtalloc-devel

Install iproute IP interface tools.

$ sudo dnf install iproute

Install the SCTP kernel module in kernel-modules-extra.

$ sudo dnf install kernel-modules-extra
$ sudo rm /etc/modprobe.d/sctp-blacklist.conf
$ sudo rm /etc/modprobe.d/sctp_diag-blacklist.conf

Update all installed packages to the latest versions.

This will update all of the installed packages to the latest versions from all of the repos that we enabled above.

$ sudo dnf update

Note that this may update the kernel version so you may need to reboot after this step to ensure that you are running this new kernel version. This is important when you try to load the SCTP kernel module later.

[host] $ vagrant halt
[host] $ vagrant up --provider virtualbox
[host] $ # ssh back into the VM after it reboots...
[host] $ vagrant ssh

Check the SCTP kernel module

Open5GS requires the Linux SCTP kernel module to be loaded in the kernel. In the CentOS Stream 8 Vagrant box SCTP is not loaded into the kernel automatically so must be installed as follows:

$ checksctp
SCTP supported
$ sudo modprobe sctp
$ # Check that SCTP was loaded successfully:
$ sudo dmesg | grep sctp
[  639.971360] sctp: Hash tables configured (bind 256/256)

Build Open5GS from Source

Git clone the Open5GS source code.

Clone a copy of the open5GS source code from github:

$ cd ~
$ git clone https://github.com/open5gs/open5gs

Compile the Open5GS source.

Compile the source using meson. Note that this sets the installation prefix to ~/open5gs/install:

$ cd ~/open5gs
$ meson build --prefix=`pwd`/install
$ ninja -C build

Run and Test Open5GS

Start MongoDB

After installing the MongoDB server, it will be started automatically when the machine is rebooted. You can check the status using systemctl:

$ sudo systemctl status mongod.service
● mongod.service - MongoDB Database Server
   Loaded: loaded (/usr/lib/systemd/system/mongod.service; enabled; vendor preset: disabled)
   Active: active (running) since Fri 2020-11-20 09:46:40 UTC; 10h ago
     Docs: https://docs.mongodb.org/manual
  Process: 779 ExecStart=/usr/bin/mongod $OPTIONS (code=exited, status=0/SUCCESS)
  Process: 775 ExecStartPre=/usr/bin/chmod 0755 /var/run/mongodb (code=exited, status=0/SUCCESS)
  Process: 770 ExecStartPre=/usr/bin/chown mongod:mongod /var/run/mongodb (code=exited, status=0/SUCCESS)
  Process: 732 ExecStartPre=/usr/bin/mkdir -p /var/run/mongodb (code=exited, status=0/SUCCESS)
 Main PID: 781 (mongod)
   Memory: 99.7M
   CGroup: /system.slice/mongod.service
           └─781 /usr/bin/mongod -f /etc/mongod.conf

If it has not started, then it can be started using systemctl:

$ sudo systemctl enable mongod.service
$ sudo systemctl start mongod.service

The default database location is /var/log/mongodb/mongod.log. This can be adjusted in /etc/mongod.conf.

Set up a TUN interface

Create a TUN/TAP interface. The interface name will be ogstun.

$ sudo ip tuntap add name ogstun mode tun
$ ip link show

To support IPv6-enabled UEs, you must configure the ogstun interface to support IPv6. This is done by setting the diable_ipv6 option for ogstun to 0 (false):

$ sysctl -n net.ipv6.conf.lo.disable_ipv6
$ sysctl -n net.ipv6.conf.ogstun.disable_ipv6

$ sudo sysctl -w net.ipv6.conf.lo.disable_ipv6=0
$ sudo sysctl -w net.ipv6.conf.ogstun.disable_ipv6=0

$ sysctl -n net.ipv6.conf.lo.disable_ipv6
$ sysctl -n net.ipv6.conf.ogstun.disable_ipv6

Note: If your TUN interface already supports IPv6, you can skip this steps above.

Set the IP address on the ogstun TUN interface.

$ sudo ip addr add dev ogstun
$ sudo ip addr add 2001:db8:cafe::1/48 dev ogstun

Make sure it is set up properly.

$ sudo ip link set ogstun up
$ ip link show

Notice: This configuration is not persistent after rebooting. The script provided in $GIT_REPO/misc/netconf.sh makes it easy to configure the TUN device as follows: $ sudo ./misc/netconf.sh

Testing Open5GS

Run Individual Open5GS tests.

Open5GS test applications are created in the ~/open5gs/build/tests directory.

$ cd ~/open5gs

$ ./build/tests/attach/attach ## EPC Only
s1setup-test        : SUCCESS
guti-test           : SUCCESS
auth-test           : SUCCESS
idle-test           : SUCCESS
emm-status-test     : SUCCESS
ue-context-test     : SUCCESS
reset-test          : SUCCESS
All tests passed.

$ ./build/tests/registration/registration ## 5G Core Only
guti-test           : SUCCESS
auth-test           : SUCCESS
idle-test           : SUCCESS
dereg-test          : SUCCESS
identity-test       : SUCCESS
gmm-status-test     : SUCCESS
ue-context-test     : SUCCESS
All tests passed.

Run all Open5GS tests.

Run all Open5GS test programs:

$ cd ~/open5gs
$ cd build
$ meson test -v

Tip: You can also check the result of meson test -v with a tool that captures packets. If you are running wireshark, select the loopback interface and set FILTER to s1ap || gtpv2 || pfcp || diameter || gtp || ngap || http. You can see the virtually created packets. testattach.pcapng/testregistration.pcapng

Installing Open5GS.

Open5GS can be installed using meson as well. This will install the product to $(HOME)/open5gs/install if the prefix was set as shown above.

$ cd ~/open5gs
$ cd build
$ ninja install
$ cd ../
$ ls install/bin
open5gs-amfd   open5gs-mmed   open5gs-pcrfd  open5gs-sgwud  open5gs-upfd
open5gs-ausfd  open5gs-nrfd   open5gs-scpd   open5gs-smfd
open5gs-bsfd   open5gs-nssfd  open5gs-seppd  open5gs-udmd
open5gs-hssd   open5gs-pcfd   open5gs-sgwcd  open5gs-udrd

Building WebUI of Open5GS

Node.js is required to build WebUI of Open5GS

Install Node.js:

$ curl -sL https://rpm.nodesource.com/setup_18.x | sudo -E bash -
$ sudo dnf install nodejs

Install the dependencies to run WebUI

$ cd ~/open5gs
$ cd webui
$ npm ci

The WebUI runs as an npm script.

$ DB_URI=mongodb:// HOSTNAME= npm run dev