[S] Change in ...osmo-s1gw[master]: README.md: document installation

fixeria has submitted this change. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41108?usp=email ) Change subject: README.md: document installation ...................................................................... README.md: document installation Change-Id: I383d1d0aa89e6c3c68985464f727aaadbb7d35ce --- M README.md 1 file changed, 23 insertions(+), 0 deletions(-) Approvals: Jenkins Builder: Verified pespin: Looks good to me, approved diff --git a/README.md b/README.md index cfb6f52..e1723e9 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,29 @@ ``` +Installation +------------ + +OsmoS1GW is built for common versions of Debian, Ubuntu and other distributions as a part of +the [Osmocom binary packages](https://osmocom.org/projects/cellular-infrastructure/wiki/Binary_…. +If you're not doing development, it is suggested to simply use those binary packages, rather +than building from source. Otherwise, you can invoke the `install` target: + +``` +$ sudo make install +``` + +This will install the following: + +* `/usr/lib/osmo-s1gw` - complete OTP release package +* `/usr/bin/osmo-s1gw` - convenience script for running `osmo-s1gw` +* `/lib/systemd/system/osmo-s1gw.service` - systemd unit file +* `/etc/osmocom/osmo-s1gw.config` - the configuration file + +The installation paths can be adjusted using `DESTDIR`, `LIBDIR`, `BINDIR`, +`CONFDIR`, and `SYSTEMDUNITDIR` variables. + + Configuration ------------- -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41108?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: erlang/osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: I383d1d0aa89e6c3c68985464f727aaadbb7d35ce Gerrit-Change-Number: 41108 Gerrit-PatchSet: 3 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>