NixCore Configuration Documentation
Welcome to the NixCore Configuration Documentation.
This documentation covers configuration options for all open source 5G core network components (currently Open5gs, the rest is WIP), managed through Nix modules with full type safety and validation.
Quick Links
- Getting Started - Learn how to use this configuration system
- Examples - Real-world configuration examples
- Search Options - Fast search across all components
- All Options - Browse all configuration options
- 5G Network Functions:
- SMF Options - Session Management Function
- UPF Options - User Plane Function
- UDR Options - Unified Data Repository
- UDM Options - Unified Data Management
- AUSF Options - AUSF (Authentication Server Function)
- BSF Options - BSF (Binding Support Function)
- NRF Options - NRF (Network Repository Function)
- AMF Options - AMF (Access and Mobility Management Function)
- NSSF Options - NSSF (Network Slice Selection Function)
- PCF Options - PCF (Policy Control Function)
- PCRF Options - PCRF (Policy and Charging Rules Function)
- SCP Options - SCP (Service Communication Proxy)
- SEPP1 Options - SEPP1 (Security Edge Protection Proxy)
- SEPP2 Options - SEPP2 (Security Edge Protection Proxy)
- 4G Network Functions:
- HSS Options - HSS (Home Subscriber Server)
- MME Options - MME (Mobility Management Entity)
- SGWC Options - SGWC (Serving Gateway Control Plane)
- SGWU Options - SGWU (Serving Gateway User Plane)
- 5G Network Functions:
Features
- 🎯 Type-safe: All options are strongly typed using NixOS module system
- 📚 Well-documented: Every option includes detailed descriptions and examples
- 🔍 Searchable: Fast search across all components
- 🔧 Flexible: Easy to override defaults
- ✅ Validated: Configuration is validated at build time
- 🔗 Integrated: NF Configurations work together seamlessly