free5gc/amf

free5GC Compose

本仓库是https://github.com/free5gc/free5gc stage 3的Docker Compose版本，灵感来源于https://github.com/calee0219/free5gc-docker-compose%EF%BC%8C%E5%B9%B6%E5%8F%82%E8%80%83%E4%BA%86https://github.com/abousselmi/docker-free5gc%E3%80%82%E5%8F%AF%E9%80%9A%E8%BF%87config%E6%96%87%E4%BB%B6%E5%A4%B9%E5%92%8Cdocker-compose.yaml%E8%87%AA%E5%AE%9A%E4%B9%89%E9%85%8D%E7%BD%AE%E3%80%82

镜像概述和主要用途

free5GC Compose提供了基于Docker容器化部署free5GC stage 3的方案，用于快速搭建5G核心网络环境。通过Docker Compose编排各网络功能（NF），支持灵活配置，适用于5G核心网的开发、测试和研究场景。

核心功能和特性

• 容器化部署：将free5GC各网络功能（如AMF、SMF、UPF等）封装为Docker容器，简化部署流程
• 自定义配置：支持通过config文件夹和docker-compose.yaml文件定制网络参数
• 依赖管理：集成MongoDB数据库，管理用户订阅数据
• 外部集成：支持与UERANSIM等eNB/UE模拟器对接
• 多部署模式：提供前台运行（推荐结合tmux）和后台运行两种方式
• Vagrant支持：提供Vagrant Box选项，规避内核版本限制

使用场景和适用范围

• 5G核心网络功能的开发与测试环境搭建
• 5G网络协议栈研究与验证
• 教学或培训中的5G核心网演示环境
• 需要快速部署和重置的5G核心网实验场景

使用方法和配置说明

前提条件

GTP5G内核模块

由于UPF的限制，主机必须使用5.0.0-23-generic内核，并包含gtp5g内核模块。在主机OS上执行以下命令安装：

bash
git clone https://github.com/PrinzOwO/gtp5g.git
cd gtp5g
make
sudo make install

Docker环境

• Engine：参考Docker Engine安装文档在对应操作系统安装
• Compose：参考Docker Compose安装文档安装

启动free5GC

由于需要创建隧道接口，需使用具有root权限的特权容器：

bash
# 克隆仓库
git clone https://github.com/free5gc/free5gc-compose.git
cd free5gc-compose

# 构建基础镜像和服务镜像
make base
docker-compose build

# 启动服务（推荐使用tmux在前台运行）
sudo docker-compose up

# 如需后台运行
sudo docker-compose up -d

故障排除

数据库数据清理

有时需要清除数据库中的订阅数据：

bash
# 进入MongoDB容器
docker exec -it mongodb mongo
# 删除订阅者数据
> use free5gc
> db.subscribers.drop()
> exit  # 或按Ctrl-D退出

查看服务日志

使用docker logs命令查看各服务日志，例如查看SMF日志：

bash
docker logs smf

更多故障排除信息请参考https://github.com/free5gc/free5gc/wiki%E3%80%82

与外部eNB/UE模拟器集成

与https://github.com/aligungr/UERANSIM eNB/UE模拟器的集成方法详见官方文档。

关于在Docker环境中配置UPF以实现UERANSIM与DN（如互联网）之间的流量转发，可参考https://github.com/free5gc/free5gc-compose/issues/26%E3%80%82

Vagrant Box选项

若不想升级主机内核，可使用Vagrant Box快速搭建环境，参考https://github.com/abousselmi/vagrant-free5gc%E7%9A%84%E8%AF%B4%E6%98%8E%E3%80%82

NF依赖和端口

参考

• https://github.com/open5gs/nextepc/tree/master/docker
• https://github.com/abousselmi/docker-free5gc===SHORT_DESC=== 基于Docker Compose的free5GC stage 3部署方案，用于搭建5G核心网络，支持自定义配置，需依赖GTP5G内核模块和Docker环境，提供容器化部署和管理各网络功能（NF）的能力。 ===FULL_DESC===# free5GC Compose

本仓库是https://github.com/free5gc/free5gc stage 3的Docker Compose版本，灵感来源于https://github.com/calee0219/free5gc-docker-compose%EF%BC%8C%E5%B9%B6%E5%8F%82%E8%80%83%E4%BA%86https://github.com/abousselmi/docker-free5gc%E3%80%82%E5%8F%AF%E9%80%9A%E8%BF%87config%E6%96%87%E4%BB%B6%E5%A4%B9%E5%92%8Cdocker-compose.yaml%E8%87%AA%E5%AE%9A%E4%B9%89%E9%85%8D%E7%BD%AE%E3%80%82

镜像概述和主要用途

free5GC Compose提供了基于Docker容器化部署free5GC stage 3的方案，用于快速搭建5G核心网络环境。通过Docker Compose编排各网络功能（NF），支持灵活配置，适用于5G核心网的开发、测试和研究场景。

核心功能和特性

• 容器化部署：将free5GC各网络功能（如AMF、SMF、UPF等）封装为Docker容器，简化部署流程
• 自定义配置：支持通过config文件夹和docker-compose.yaml文件定制网络参数
• 依赖管理：集成MongoDB数据库，管理用户订阅数据
• 外部集成：支持与UERANSIM等eNB/UE模拟器对接
• 多部署模式：提供前台运行（推荐结合tmux）和后台运行两种方式
• Vagrant支持：提供Vagrant Box选项，规避内核版本限制

使用场景和适用范围

• 5G核心网络功能的开发与测试环境搭建
• 5G网络协议栈研究与验证
• 教学或培训中的5G核心网演示环境
• 需要快速部署和重置的5G核心网实验场景

使用方法和配置说明

前提条件

GTP5G内核模块

由于UPF的限制，主机必须使用5.0.0-23-generic内核，并包含gtp5g内核模块。在主机OS上执行以下命令安装：

bash
git clone https://github.com/PrinzOwO/gtp5g.git
cd gtp5g
make
sudo make install

Docker环境

• Engine：参考Docker Engine安装文档在对应操作系统安装
• Compose：参考Docker Compose安装文档安装

启动free5GC

由于需要创建隧道接口，需使用具有root权限的特权容器：

bash
# 克隆仓库
git clone https://github.com/free5gc/free5gc-compose.git
cd free5gc-compose

# 构建基础镜像和服务镜像
make base
docker-compose build

# 启动服务（推荐使用tmux在前台运行）
sudo docker-compose up

# 如需后台运行
sudo docker-compose up -d

故障排除

数据库数据清理

有时需要清除数据库中的订阅数据：

bash
# 进入MongoDB容器
docker exec -it mongodb mongo
# 删除订阅者数据
> use free5gc
> db.subscribers.drop()
> exit  # 或按Ctrl-D退出

查看服务日志

使用docker logs命令查看各服务日志，例如查看SMF日志：

bash
docker logs smf

更多故障排除信息请参考https://github.com/free5gc/free5gc/wiki%E3%80%82

与外部eNB/UE模拟器集成

与https://github.com/aligungr/UERANSIM eNB/UE模拟器的集成方法详见官方文档。

关于在Docker环境中配置UPF以实现UERANSIM与DN（如互联网）之间的流量转发，可参考https://github.com/free5gc/free5gc-compose/issues/26%E3%80%82

Vagrant Box选项

若不想升级主机内核，可使用Vagrant Box快速搭建环境，参考https://github.com/abousselmi/vagrant-free5gc%E7%9A%84%E8%AF%B4%E6%98%8E%E3%80%82

NF依赖和端口

参考

• https://github.com/open5gs/nextepc/tree/master/docker
• https://github.com/abousselmi/docker-free5gc