README.md: update

Fix the broken formatting (wrong headlines, missing line breaks in
blocks of commands) and move the configuration and escript sections
below the running section.

Add the command that fixeria suggested for running it with one shell
command.

Old: https://gitea.osmocom.org/erlang/osmo_dia2gsup/src/branch/master/README.md
New: https://gitea.osmocom.org/osmith/osmo_dia2gsup/src/branch/master/README.md

Change-Id: Ib96f42ca0066ba2f6d0d783f6bf1764cbfee544f
1 file changed
tree: 6b1c94ac0d81c47e9c8a77137faa9846e0aca5fe
  1. contrib/
  2. debian/
  3. dia/
  4. examples/
  5. src/
  6. .gitignore
  7. .gitreview
  8. README.md
  9. rebar.config
  10. rebar.lock
README.md

Osmocom DIAMETER -> GSUP translator

This project implements a proxy translating Diameter into GSUP, hence allowing Diameter clients connecting to GSUP server. This allows, for instance, using OsmoHLR as an HSS used by 4G/5G nodes.

Building

Install erlang and rebar3 packages (not "rebar", that's version 2! You may need to compile it from source in some distros).

$ rebar3 compile
$ rebar3 escriptize

Testing

Unit tests can be run this way:

$ rebar3 eunit

Running

Once osmo_dia2gsup is built, you can start it this way:

$ rebar3 shell
1> osmo_dia2gsup:start().

Passing a config file:

$ rebar3 shell --config ./examples/sys.config
1> osmo_dia2gsup:start().

Running it with one shell command:

$ rebar3 shell --config ./examples/sys.config --eval "osmo_dia2gsup:start()."

Running it as an escript:

$ rebar3 escriptize
$ ERL_FLAGS='-config ./examples/sys.config' _build/default/bin/osmo-dia2gsup