aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Willmann <dwillmann@sysmocom.de>2021-01-27 18:24:42 +0100
committerDaniel Willmann <dwillmann@sysmocom.de>2021-01-28 20:57:16 +0100
commit592eb140f05556b9a43dc3a877d8c7ad62d60158 (patch)
tree9e560bc779efb1808dd7930807887e72224a7a7a
parentc7b6aabac1dbab227442dd712dfb2f665f4293b2 (diff)
manuals/gbproxy: Update configuration chapter
-rw-r--r--doc/manuals/chapters/gbproxy-configuration.adoc41
1 files changed, 37 insertions, 4 deletions
diff --git a/doc/manuals/chapters/gbproxy-configuration.adoc b/doc/manuals/chapters/gbproxy-configuration.adoc
index 057d1cadd..726ec41ad 100644
--- a/doc/manuals/chapters/gbproxy-configuration.adoc
+++ b/doc/manuals/chapters/gbproxy-configuration.adoc
@@ -1,10 +1,43 @@
== Configuring OsmoGbProxy
-TBD. Unfortunately this chapter of the manual still needs to be written.
-Osmocom has very limited funding and support resources; Feel free to help
-us completing this documentation by contributing with code, documentation
-or by supporting the developers financially.
+OsmoGbProxy requires very little configuration, most of it being the
+configuration of the NS links.
+Most config options specific to OsmoGbProxy are related to SGSN pooling and
+telling the proxy which NSE(s) it should use to talk to the SGSN(s).
+=== Configure the Network Service (NS)
+
+A detailed description of the NS configuration can be found in <<libosmogb>>.
+The following config snippets assume the SGSN(s) (NSEI 101 and 102) are using
+IP-SNS and listen on 10.0.1.1:23000 and 10.0.1.2:23000 respectively.
+
+This would be the NS config for the SGSN(s):
+
+.Example: NS configuration example (SGSN)
+----
+ns
+ bind udp local
+ listen 10.0.0.1 23000 <1>
+ nse 101 <2>
+ ip-sns 10.0.1.1 23000 <3>
+ nse 102
+ ip-sns 10.0.1.2 23000
+----
+<1> Define the local IP/port from which to connect
+<2> Define an NSE with NSEI
+<3> Use IP-SNS to connect to the SGSN
+
+=== Configure an SGSN
+
+Configuration of a single (non-pooling) SGSN is rather simple.
+
+.Example: SGSN configuration example
+----
+sgsn 101 <1>
+ name Main SGSN <2>
+----
+<1> Each SGSN is identified by its NSEI (same as in the NS configuration)
+<2> An SGSN can optionally have a name. If none is set a default name will be used.
=== SGSN pool support