README.md

Repository Structure

Before the last refactor, the repository had a different structure. The current structure is as follows:

├── README.md                         # This file
├── docs/                             # All documentation
│   ├── getting-started/              # Beginner guides
│   ├── deployment-guides/            # Specific deployment scenarios
│   ├── images/                       # Images sepcific to deployment documents
│   └── troubleshooting/              # Error handling and fixes
├── deployments/                      # All deployment configurations
│   └── basic-4G/                     # Simple setup with LTE w/o IMS
├── scripts/                          # Utility scripts organized by purpose
│   ├── setup/                        # Initial setup scripts
│   ├── management/                   # Service management scripts
│   └── utils/                        # General utility scripts
├── tools/                            # External tools and utilities
└── examples/                         # Example SIM configurations

This repository only focuses on using the docker_open5gs for deploying a private 5G network. The configurations and scripts provided here are tailored for this specific use case.

Getting Started

1. Starting Line
2. SIM Configuration

First Deployment

1. Basic Deployment Guide LTE w/o IMS

Advanced Deployments

1. VoLTE Deployment with CoIMS / pixel-volte-patch

TO-DO

• Implement iPhone support
• Make SUCI deployment the default

---

Contributions to this write-up

1. Priyansh
2. Prateek Bhaisora
3. Syed Baqir Ali

---

VS Code AutoComplete was also used to assist in writing this documentation.