Installation

A. Prerequisites

1. Linux Kernel Version

In order to use the UPF element, you must use the 5.0.0-23-generic or 5.4.x version of the Linux kernel. free5gc uses the gtp5g kernel module, which has been tested and compiled against that kernel versions only. If you installed Ubuntu 20.04, the version should be like 5.4.x. To determine the version of the Linux kernel you are using:

$ uname -r
5.4.0-65-generic

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

2. Golang Version

As noted above, free5gc is built and tested with Go 1.21.8
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.21.8:

# 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.21.8.linux-amd64.tar.gz
sudo tar -C /usr/local -zxvf go1.21.8.linux-amd64.tar.gz

If Go is not installed on your system:

wget https://dl.google.com/go/go1.21.8.linux-amd64.tar.gz
sudo tar -C /usr/local -zxvf go1.21.8.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
echo 'export GO111MODULE=auto' >> ~/.bashrc
source ~/.bashrc

Further information and installation instructions for golang are available at the official golang site.

3. Control-plane Supporting Packages

sudo apt -y update
sudo apt -y install wget git

To check whether AVX is supported by the CPU, you can use the command:
```
lscpu | grep avx
```

Install MongoDB Community Edition (check this appendix section for more information)

Import the public key used by the package management system

sudo apt install -y gnupg curl
curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \
sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg --dearmor

Create a list file for MongoDB

# Ubuntu 22.04 (Jammy)
echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list
# Ubuntu 20.04 (Focal)
echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list

you can determine the release by running cat /etc/lsb-release

Reload local package database & Install the MongoDB packages
```
sudo apt update
sudo apt install -y mongodb-org
```

Run MongoDB Community Edition

# using systemd
sudo systemctl start mongod
sudo systemctl status mongod
sudo systemctl enable mongod    # optional
# using init
sudo service mongod start
sudo service mongod status

WARNING: MongoDB 5.0+ requires a CPU with AVX support. Or downgrade your MongoDB to 4.4
- see this post on MongoDB's official forum
- see also docker-library/mongo#485 (comment)
- When you are using Ubuntu 20.04 and a CPU without AVX support, you can use the mongodb package provided by Ubuntu.
```
sudo apt install mongodb # MongoDB Server v3.6.8
```

4. User-plane Supporting Packages

sudo apt -y update
sudo apt -y install git gcc g++ cmake autoconf libtool pkg-config libmnl-dev libyaml-dev

5. Linux Host Network Settings

sudo sysctl -w net.ipv4.ip_forward=1
sudo iptables -t nat -A POSTROUTING -o <dn_interface> -j MASQUERADE
sudo iptables -A FORWARD -p tcp -m tcp --tcp-flags SYN,RST SYN -j TCPMSS --set-mss 1400
sudo systemctl stop ufw
sudo systemctl disable ufw # prevents the firewall to wake up after a OS reboot

Or use reload_host_config.sh from free5GC

sudo ./<PATH-TO-free5GC>/reload_host_config.sh <dn_interface>
# Example
sudo ./free5gc/reload_host_config.sh enp0s3

Note: For more information regarding the reload script, please, check this appendix section

B. Install Control Plane Elements

Clone the free5GC repository

To install the latest stable build (v4.0.0):

cd ~
git clone --recursive -b v4.0.0 -j `nproc` https://github.com/free5gc/free5gc.git
cd free5gc

(Alternatively) to install the latest nightly build:

cd ~/free5gc
git checkout main
git submodule sync
git submodule update --init --jobs `nproc`
git submodule foreach git checkout main
git submodule foreach git pull --jobs `nproc`

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
```

C. Install User Plane Function (UPF)

As noted above, the GTP kernel module used by the UPF requires that you use Linux kernel version 5.0.0-23-generic or 5.4.x. To verify your version:
```
uname -r
```

Retrieve the 5G GTP-U kernel module using git and build it

git clone -b v0.9.5 https://github.com/free5gc/gtp5g.git
cd gtp5g
make
sudo make install

Build the UPF (you may skip this step if you built all network functions above):
- to build using make:
```
cd ~/free5gc
make upf
```
Customize the UPF as desired. The UPF configuration file in run.sh is free5gc/config/upfcfg.yaml.

D. Install WebConsole

Before building WebConsole, install nodejs first:

curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - 
sudo apt update
sudo apt install -y nodejs
corepack enable # setup yarn automatically

Build WebConsole

to build using make:
```
cd ~/free5gc
make webconsole
```

(Alternatively) to build manually:

cd ~/free5gc/webconsole/frontend
yarn install
yarn build
rm -rf ../public
cp -R build ../public
cd ..
go build -o bin/webconsole server.go

Note: An OS with 2GB or more of RAM is recommended. WebConsole may fail to build if available RAM is below 1GB.