Installation

A. Prerequisites

  1. Linux Kernel Version

    • In order to use the UPF element, you must use the 5.0.0-23-generic version of the Linux kernel. free5gc uses the gtp5g kernel module, which has been tested and compiled against that kernel version only. To determine the version of the Linux kernel you are using:
        $ uname -r
        5.0.0-23-generic
    

You will not be able to run most of the tests in Test section unless you deploy a UPF.

  1. Golang Version

    • As noted above, free5gc is built and tested with Go 1.14.4
    • To check the version of Go on your system, from a command prompt:
        go version
    
    • If another version of Go is installed, remove the existing version and install Go 1.14.4:
        # this assumes your current version of Go is in the default location
        sudo rm -rf /usr/local/go
        wget https://dl.google.com/go/go1.14.4.linux-amd64.tar.gz
        sudo tar -C /usr/local -zxvf go1.14.4.linux-amd64.tar.gz
    
    • If Go is not installed on your system:
        wget https://dl.google.com/go/go1.14.4.linux-amd64.tar.gz
        sudo tar -C /usr/local -zxvf go1.14.4.linux-amd64.tar.gz
        mkdir -p ~/go/{bin,pkg,src}
        # The following assume that your shell is bash
        echo 'export GOPATH=$HOME/go' >> ~/.bashrc
        echo 'export GOROOT=/usr/local/go' >> ~/.bashrc
        echo 'export PATH=$PATH:$GOPATH/bin:$GOROOT/bin' >> ~/.bashrc
        source ~/.bashrc
    
    • Further information and installation instructions for golang are available at the official golang site.
  2. Control-plane Supporting Pacakges

sudo apt -y update
sudo apt -y install mongodb wget git
sudo systemctl start mongodb
  1. User-plane Supporting Packages
sudo apt -y update
sudo apt -y install git gcc cmake autoconf libtool pkg-config libmnl-dev libyaml-dev
go get -u github.com/sirupsen/logrus
  1. Linux Host Network Settings
sudo sysctl -w net.ipv4.ip_forward=1
sudo iptables -t nat -A POSTROUTING -o <dn_interface> -j MASQUERADE
sudo systemctl stop ufw

B. Install Control Plane Elements

  1. Clone the free5GC repository

    • To install the latest stable build (v3.0.4):
        cd ~
        git clone --recursive -b v3.0.4 -j `nproc` https://github.com/free5gc/free5gc.git
        cd free5gc
    
    • Alternatively, if you wish to install the latest nightly build:
        cd ~/free5gc
        git checkout master
        git submodule sync
        git submodule update --init --jobs `nproc`
        git submodule foreach git checkout master
        git submodule foreach git pull --jobs `nproc`
    
  2. Install all Go module dependencies

cd ~/free5gc
go mod download

NOTE: the root folder name for this repository must be free5gc. If it is changed, compilation will fail.

  1. Compile network function services in free5gc

    • To do so individually (e.g., AMF only):
        cd ~/free5gc
        make amf
    
    • To build all network functions:
        cd ~/free5gc
        make all
    

C. Install User Plane Function (UPF)

  1. As noted above, the GTP kernel module used by the UPF requires that you use Linux kernel version 5.0.0-23-generic. To verify your version:
uname -r
  1. Retrieve the 5G GTP-U kernel module using git and build it
git clone https://github.com/PrinzOwO/gtp5g.git
cd gtp5g
make
sudo make install
  1. Build the UPF (you may skip this step if you built all network functions above):

    a. to build using make:

    cd ~/free5gc
    make upf
    

    b. alternatively, to build manually:

    cd ~/free5gc/src/upf
    mkdir build
    cd build
    cmake ..
    make -j`nproc`
    
  2. Customize the UPF as desired. The UPF configuration file is free5gc/src/upf/build/config/upfcfg.yaml.