About The Book
Source for Private 5G: A Systems Approach is available on GitHub under terms of the Creative Commons (CC BY-NC-ND 4.0) license. The community is invited to contribute corrections, improvements, updates, and new material under the same terms. While this license does not automatically grant the right to make derivative works, we are keen to discuss derivative works (such as translations) with interested parties. Please reach out to discuss@systemsapproach.org.
If you make use of this work, the attribution should include the following information:
This book incorporates introductory and background content from:
a version of which was also published by Morgan & Claypool in 2020 as part of their Synthesis Lectures on Network Systems.
Designations used by companies to distinguish their products are often claimed as trademarks or registered trademarks. In all instances in which Systems Approach, LLC, is aware of a claim, the product names appear in initial capital or all capital letters. Readers, however, should contact the appropriate companies for more complete information regarding trademarks and registration.
Read the Book
This book is part of the Systems Approach Series, with an online version published at https://5G.systemsapproach.org.
For those users looking for our earlier 5G book, 5G Mobile Networks: A Systems Approach, published as this URL, you can still find source for it archived on GitHub. This new book incorporates the background material covered in the old one, plus goes into significant detail about how Private 5G is implemented and deployed as a managed cloud service.
To track progress and receive notices about new versions, you can follow the project on Facebook and Mastodon. To read a running commentary on how the Internet is evolving, follow the Systems Approach on Substack.
Build the Book
To build a web-viewable version, you first need to download the source:
$ mkdir ~/systemsapproach
$ cd ~/systemsapproach
$ git clone https://github.com/SystemsApproach/private5g.git
$ cd private5g
The build process is stored in the Makefile and requires Python be
installed. The Makefile will create a virtualenv (venv-docs) which
installs the documentation generation toolset. You may also need to
install the enchant C library using your system’s package manager
for the spelling checker to function properly.
To generate HTML in _build/html, run make html.
To check the formatting of the book, run make lint.
To check spelling, run make spelling. If there are additional
words, names, or acronyms that are correctly spelled but not in the dictionary,
please add them to the dict.txt file.
To see the other available output formats, run make.
Contribute to the Book
We hope that if you use this material, you are also willing to contribute back to it. If you are new to open source, you might check out this How to Contribute to Open Source guide. Among other things, you’ll learn about posting Issues that you’d like to see addressed, and issuing Pull Requests to merge your improvements back into GitHub.
If you’d like to contribute and are looking for something that needs attention, see the wiki for the current TODO list.