This repository is a docker compose version of free5GC for stage 3. It's inspired by free5gc-docker-compose and also reference to docker-free5gc.
You can setup your own config in config folder and docker-compose.yaml
- GTP5G kernel module: needed to run the UPF
- Docker Engine: needed to run the Free5GC containers
- Docker Compose v2: needed to bootstrap the free5GC stack
Because we need to create tunnel interface, we need to use privileged container with root permission.
docker compose pull
# Clone the project
git clone https://github.com/free5gc/free5gc-compose.git
cd free5gc-compose
# clone free5gc sources
cd base
git clone --recursive -j `nproc` https://github.com/free5gc/free5gc.git
cd ..
# Build the images
make all
docker compose -f docker-compose-build.yaml build
# Alternatively you can build specific NF image e.g.:
make amf
docker compose -f docker-compose-build.yaml build free5gc-amf
Note:
Dangling images may be created during the build process. It is advised to remove them from time to time to free up disk space.
docker rmi $(docker images -f "dangling=true" -q)
You can create free5GC containers based on local images or docker hub images:
# use local images
docker compose -f docker-compose-build.yaml up
# use images from docker hub
docker compose up # add -d to run in background mode
Destroy the established container resource after testing:
# Remove established containers (local images)
docker compose -f docker-compose-build.yaml rm
# Remove established containers (remote images)
docker compose rm
Sometimes, you need to drop data from DB:
docker exec -it mongodb mongo
> use free5gc
> db.dropDatabase()
> exit # (Or Ctrl-D)
You can see logs for each service using docker logs
command. For example, to access the logs of the SMF you can use:
docker logs smf
Please refer to the wiki for more troubleshooting information.
The integration with the UERANSIM eNB/UE simulator is documented here.
You can also refer to this issue to find out how you can configure the UPF to forward traffic between the UERANSIM to the DN (eg. internet) in a docker environment.
This issue provides detailed steps that might be useful.
Here you can find helpful guidelines on the integration of Nginx reverse proxy to set it in front of the WebUI: free5gc/free5gc-compose#55 (comment)
For Linux kernel version below 5.4 you can setup a working environment using a vagrant box: https://github.com/abousselmi/vagrant-free5gc Please refer to GTP5G kernel module for more information.
You can check the following informations below: