User Guide
Information
free5GC Installation Guide
Note
If you have to develop a new feature on free5GC, please check the links below to install the free5GC.
Otherwise, for normal use/test purposes, we recommend you use the free5GC Compose to launch the free5GC without complicated configuration settings.
[Recommended] free5GC compose
free5GC Helm
[Advanced] Build free5GC from scratch
For people who are not familiar with virtual machines and Linux installation, here are some example demonstrations:
- Creating a Ubuntu VM using VirtualBox
- Creating and Configuring a free5GC VM
- Build and Install free5GC from source code and Test free5GC
- Installing a UE/RAN Simulator
- Installing a N3IWUE
- Installing a TNGFUE
- Enable OAuth2 on SBI
- free5GC Simple Apps
Configuration
- Environment
- Basic
- SMF
- Webconsole
- Charging
- Set Static IP for UE
- Select UPF based on S-NSSAI
- Select nearby UPF according to the connected gNodeB
- ULCL
- Netns5g - A free5gc and UERANSIM deployment using Linux network namespaces
- Traffic Influence
Deployment
For Container deployment:
- free5GC Compose (Docker Compose)
- free5GC Helm (Kubernetes)
- Towards5gs-helm (Kubernetes)
Roadmap
Here are the features on the roadmap. These items are planned to be supported in the near future:
- Kubernetes deployment (quick installation)
- Release NEF
- SBI R17 support
- Packet Rusher CI integration
- Time Sensitive Network (TSN)
- 5G LAN
If you're interested in more details, please visit the GitHub Dashboard