README.md: Document how to run escript with config file

Change-Id: Icc78f4bd22608ad0c8a2c5f6095cd77543ab2048
1 file changed
tree: 6bb3390120b836a54a2c7ff85f1ddeed028dc10b
  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

In the erlang shell:

1> osmo_dia2gsup:start().

== Configuration ==

$ rebar3 shell --config ./examples/sys.config

1> osmo_dia2gsup:start().

== Run as an escript ==

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