doc: More cross-references; Expand overview slightly

Change-Id: Ic290627ec2512a2b59cb9d81704b9cec4d14ccf4
changes/46/17346/2
Harald Welte 3 years ago
parent ddbe43a366
commit 5103ea0a43
  1. 28
      doc/manuals/chapters/overview.adoc
  2. 1
      doc/manuals/chapters/remsim-bankd.adoc
  3. 1
      doc/manuals/chapters/remsim-client.adoc
  4. 2
      doc/manuals/chapters/remsim-server.adoc
  5. 1
      doc/manuals/chapters/rspro.adoc

@ -50,6 +50,8 @@ The tasks of `osmo-remsim-server` include:
`osmo-remsim-bankd` instances
* providing a RESTful JSON interface for external application logic to
For more information, please see <<remsim-server>>.
=== osmo-remsim-client
The `osmo-remsim-client` software is co-located next to the _user of the card_
@ -77,6 +79,8 @@ The tasks of `osmo-remsim-client` include:
multiple phones/modems at one location, you can simply run multiple
instances of `osmo-remsim-client` on the same system, one for each phone/modem.
For more information, please see <<remsim-client>>.
=== osmo-remsim-bankd
The `osmo-remsim-bankd` software is co-located next to a bank of SIM cards.
@ -90,4 +94,28 @@ The tasks of `osmo-remsim-bankd` include:
* running a TCP server where TCP connections from `osmo-remsim-client`
instances are accepted and handled.
For more information, please see <<remsim-bankd>>.
=== RSPRO
RSPRO is the *R*emote *S*IM *PRO*tocol. It is a binary protocol
specified in ASN.1 which is spoken on any of the internal connections
between `osmo-remsim-client`, `osmo-remsim-bankd` and
`osmo-remsim-server`.
You can find more information about RSPRO in <<rspro>>.
=== RSRES
RSRES is the *R*emote *S*IM *RES*T protocol. It is an interface offered
by `osmo-remsim-server` towards external back-end application logic of
the operator of an osmo-remsim network.
You can find more information about RSRES in <<rsres>>.
=== Security
WARNING: RSPRO, RSRES and their underlying transport layer both operate in plain-text,
There is no authentication or encryption built into the protocol. It is
assumed that the protocols are only spoken over trusted, controlled IP
networks, such as inside a VPN or a closed / private corporate network.

@ -1,3 +1,4 @@
[[remsim-bankd]]
== osmo-remsim-bankd
The `osmo-remsim-bankd` (SIM Bank Daemon) manages one given SIM bank.

@ -1,3 +1,4 @@
[[remism-client]]
== osmo-remsim-client-st2
The client interfaces with GSM phones / modems via dedicated "Card

@ -1,3 +1,4 @@
[[remsim-server]]
== osmo-remsim-server
=== Running
@ -18,6 +19,7 @@ in future versions.
verbosity is not yet configurable. However, as the libosmocore logging
framework is used, extending this is an easy modification.
[[rsres]]
=== RESTful/JSON Web API
`osmo-remsim-server` provides a RESTful/JSON WEB API for application logic

@ -1,3 +1,4 @@
[[rspro]]
== RSPRO
*RSPRO*, the *Remote SIM Protocol*, is an osmo-remsim specific,

Loading…
Cancel
Save