[M] Change in osmo-s1gw[master]: README.md: initial version

osmith has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-s1gw/+/37053?usp=email ) Change subject: README.md: initial version ...................................................................... README.md: initial version Change-Id: Ifed0146b1bf609756e967e7c6b9ed159d29dfbf0 --- A README.md 1 file changed, 144 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-s1gw refs/changes/53/37053/1 diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5d30b2 --- /dev/null +++ b/README.md @@ -0,0 +1,135 @@ +osmo-s1gw +========= + +This is an S1AP (S1 Application Protocol) Gateway implementation in Erlang for +the 3GPP EPC (Evolved Packet Core) based (4G/LTE) networks. It is part of the +[Osmocom](https://osmocom.org/) Open Source Mobile Communications project. + +S1AP is a protocol "spoken" between the eNB and the MME. The S1GW is useful in +scenarios when eNB(s) and the MME co-exist in separate networks and thus unable +to access each other directly. This is basically a proxy, accepting incoming +connections from eNB(s), establishing the associated outgoing connections +to the MME, and forwarding S1AP PDUs back and forth. + +``` + (network A) | + | + +-------------+ +-------------+ + | osmo-s1gw | | MME | ++--------+ +-------------+ +-------------+ +| eNB(1) | --> | | --> | | ++--------+ | | | | + | | | | ++--------+ | | | | +| eNB(2) | --> | | --> | | ++--------+ | | | | + | | | | ++--------+ | | | | +| eNB(N) | --> | | --> | | ++--------+ +-------------+ +-------------+ + | + | (network B) +``` + + +Homepage +-------- + +This project does not have its own homepage yet, unlike many other +[Osmocom projects](https://osmocom.org/projects/). + + +GIT Repository +-------------- + +You can clone from the official osmo-s1gw.git repository using + +``` +$ git clone https://gitea.osmocom.org/erlang/osmo-s1gw +``` + +There is a web interface at <https://gitea.osmocom.org/erlang/osmo-s1gw> + + +Documentation +------------- + +Once the project reaches a usable milestone, we will be working on a +user manual. Stay tuned. + + +Contributing +------------ + +Our coding standards are described at +<https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards>. + +We use a Gerrit based patch submission/review process for managing +contributions. Please see +<https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit> for +more details. + +The current patch queue for osmo-s1gw can be seen at +<https://gerrit.osmocom.org/#/q/project:erlang/osmo-s1gw+status:open>. + + +Building +-------- + +Install erlang and rebar3 packages (not "rebar", that's version 2! You may need +to compile it from source in some distros). + +``` +$ rebar3 asn compile +$ rebar3 compile +$ rebar3 escriptize +``` + + +Testing +------- + +Unit tests can be run this way: + +``` +$ rebar3 eunit +``` + + +Running +------- + +Once `osmo_s1gw` is built, you can start it this way: + +``` +$ rebar3 shell --config config/sys.config +``` + + +Configuration +------------- + +The default configuration can be found in +[config/sys.config](config/sys.config). + +The existing parameters can be represented as follows: + +``` + eNB S1GW ++-----+ +----------------+ +| ... | --> | s1gw_bind_addr | MME ++-----+ +----------------+ +-----------------+ + | mme_loc_addr | --> | mme_rem_addr | + +----------------+ +-----------------+ +``` + +* `s1gw_bind_addr` - S1GW bind address for incoming eNB connections +* `mme_loc_addr` - local address for outgoing connections to the MME +* `mme_rem_addr` - remote address for outgoing connections to the MME + +Logging can be configured in the `kernel` section: + +* `{logger_level, info}` - logging level (one of `emergency | alert | + critical | error | warning | notice | + info | debug`) +* `#{formatter => { ... }` - logging formatting configuration -- To view, visit https://gerrit.osmocom.org/c/osmo-s1gw/+/37053?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: Ifed0146b1bf609756e967e7c6b9ed159d29dfbf0 Gerrit-Change-Number: 37053 Gerrit-PatchSet: 1 Gerrit-Owner: osmith &lt;osmith(a)sysmocom.de&gt; Gerrit-CC: fixeria &lt;vyanitskiy(a)sysmocom.de&gt; Gerrit-MessageType: newchange