Commit 14900612 authored by dukl's avatar dukl

Update README.md

parent 28af841f
------------------------------------------------------------------------------
OPENAIR-CN-5G
An implementation of the 5G Core network by the OpenAirInterface community.
------------------------------------------------------------------------------
OPENAIR-CN-5G is an implementation of the 3GPP specifications for the 5G Core Network.
At the moment, it contains the following network elements:
* Access and Mobility Management Function (**AMF**)
* Session Management Function (**SMF**)
* User Plane Function (**UPF**)
Each has its own repository: this repository (`oai-cn5g-amf`) is meant for AMF.
# Licence info
It is distributed under `OAI Public License V1.1`.
See [OAI Website for more details](https://www.openairinterface.org/?page_id=698).
The text for `OAI Public License V1.1` is also available under [LICENSE](LICENSE)
file at the root of this repository.
# Where to start
The Openair-CN-5G AMF code is written, executed, and tested on UBUNTU server bionic version.
Other Linux distributions support will be added later on.
More details on the supported feature set is available on this [page](docs/FEATURE_SET.md).
# Collaborative work
This source code is managed through a GITLAB server, a collaborative development platform:
* URL: [https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf).
Process is explained in [CONTRIBUTING](CONTRIBUTING.md) file.
# Contribution requests
In a general way, anybody who is willing can contribute on any part of the
code in any network component.
Contributions can be simple bugfixes, advices and remarks on the design,
architecture, coding/implementation.
# Release Notes
They are available on the [CHANGELOG](CHANGELOG.md) file.
# OpenXG-AMF
OpenXG-AMF Arch
├── build: Build directory, contains targets and object files generated by compilation of network functions.
├── log: Directory containing build log files.
├── scripts: Directory containing scripts for building network functions
└── smf: Directory containing CMakefile.txt and object files generated by compilation of AMF network function.
├── etc: Directory containing the configuration file to be deployed for AMF.
└── src: Source files of AMF.
├── amf-app: AMF Procedures handling logic.
├── common: Common definitions for 3GPP specifications.
├── contexts: communication contexts used in the AMF.
├── itti: Inter task interface
├── nas: NAS protocol implememtation
├── ngap: NGAP protocol implememtation
├── oai_amf: AMF main directory, contains the "main" CMakeLists.txt file.
├── sbi: AMF service endpoints and curl http client.
├── sctp: Build SCTP server.
├── secu_algorithms: algorithms for 5G-AKA authentication procedures.
├── test: Minimal implementation for AMF, UDM network functions for testing purpose.
└── utils: Common utilities.  .
## Download source code from Gitlab
git clone http://git.opensource5g.org/openxg/amf.git
cd amf/
git checkout master
## install dependencies
cd /amf/build/scripts
./build_amf -I -f
## build AMF
./build_amf -c -V -b Debug -j
## launch AMF
sudo amf -c etc/amf.conf -o
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment