Commit Graph

403 Commits

Author SHA1 Message Date
Neels Hofmeyr 7ef86bb587 OsmoMGW: document the 'X-Osmo-IGN' MGCP extension
See also Ia6fe5ead4b601931c1bf41b29fc1b237aac37d2c in osmo-mgw.git, which
changes the initial single-character implementation to match this specification
of string tokens separated by spaces.

Change-Id: If15a88c3b5b40fd1d24ad0f94f3231f678669ab1
2018-08-26 23:49:42 +02:00
Daniel Willmann bf2a61aafa Add manual for OsmoSIPConnector
Ticket: OS#1684
Change-Id: I70d3014deb459e0b91a9a92c60710b994153538e
2018-08-23 17:41:22 +02:00
Daniel Willmann 078c7a4666 Add VTY reference for osmo-sip-connector
Ticket: OS#1684
Change-Id: I1045c20dd7234d425836ba93fa292a35ccddc7fd
2018-08-23 17:41:06 +02:00
Harald Welte 128c2db0f6 hlr: Add chapter on USSD configuration
Change-Id: Ie5196ece9f340303bcb4868e3333a9698e28c3d0
2018-08-07 18:04:12 +00:00
Daniel Willmann 0c1dad4a5b Add initial OsmoMGW manual
Change-Id: I1b4ff96309d280c6a63105a6e06a82ec2e7b6908
2018-08-07 18:57:53 +02:00
Daniel Willmann fa787b2e30 mgw: Add new VTY reference
Change-Id: Ic8ca983f3358aae9362fb21ff3a111f9c4f3935b
2018-07-31 18:54:34 +02:00
Pau Espin 557e928d91 trx: Add Hardware device support section
Change-Id: I87fc54cf1751f31a3e92d6503625e984f9a6130f
2018-07-06 12:01:01 +02:00
Pau Espin 6e16895356 trx: Add Hardware architecture support section
Change-Id: I38388bcb2ea7c0481052d3bca589cb34965ea7fa
2018-07-06 11:56:20 +02:00
Pau Espin 7f931e9253 trx: Add reference to project wiki page in overfiew section
Change-Id: I83cbd67909c42f4ed4857834e23c07ad4e2e22aa
2018-07-05 18:21:33 +02:00
Pau Espin 21c0bf08eb bts: Fix typo
Change-Id: I47758acec07a587730552a9c46dc02976c807d9a
2018-07-05 18:20:57 +02:00
Neels Hofmeyr 9d6fc1f462 hlr: clarify that aud_3g also applies to 2G
(and tweak wording)

Related: OS#3091
Change-Id: I2ae03625ccc1364f953db0611e9a29d935dab803
2018-07-02 15:15:09 +02:00
Neels Hofmeyr dd8c04812e INSTALL.txt: mention xmllint vs. SSL quirk and workaround
Related: OS#3072
Change-Id: I5e4389878ea3f23b826526de047f9e647c644888
2018-07-02 15:14:53 +02:00
Daniel Willmann d2b4e163dc Upload to rita.osmocom.org to point to the old host
osmocom.org has been migrated to a new host, but the docs upload hasn't
moved yet. So explicitly upload to rita.osmocom.org.

Related: OS#3338
Change-Id: Ia1518313af007a5a665b3e06619d929e15ff277d
2018-06-28 14:01:35 +00:00
Vadim Yanitskiy 54343caa9e common/gsup.adoc: document Supplementary Services extension
A while ago, we have introduced some new message types and IEs,
related to TCAP-like transaction management and Supplementary
Services. Let's document this extension.

Change-Id: Ib1331246097db736d98baf1a162574cadca9ee36
2018-06-17 06:06:30 +07:00
Daniel Willmann 39500bb143 port_numbers: Add osmo-gbproxy ctrl interface port
Change-Id: I2307a86c7c377ea3e6e8bf1333e283d5d3f67beb
2018-05-29 21:01:42 +02:00
Alexander Couzens 25df46dda0 jenkins.sh: add hostkey for osmocom.org:48
Otherwise it will depend on a setting this up in a seperate step.
This way it's more decoupled from the build host.

Change-Id: Iea1f5810bc7d4370724fdd7eb875c9a27b3d82af
2018-04-10 17:26:15 +02:00
Harald Welte d5b6a78b9f message sequence charts for GSM <-> SIP codec selection
Those diagrams represent the current design of the way how
GSM <-> SIP codec selection should work in the future.

Related: OS#1683
Change-Id: If92379b41d859bdf7be4b7689dc0bbca7cb6e682
2018-03-26 23:03:02 +02:00
Pau Espin 51a87cec2c common: logging: State we do support SIGHUP file rotation
This feature has been available since March 2013. It was introduced in
libosmocore 8e878738d16ad4f8776dc0130ebff78dea422ee7.

Change-Id: I650eb77d4b701a199a9e193cfb0e32565940a788
2018-03-19 12:01:37 +00:00
Harald Welte 904e792fa4 vty-ref: Update URI of docbook 5.0 schema
... to match the /etc/xml/catalog file on debian (no "www" in hostname)

Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d
2018-03-17 14:30:49 +01:00
Neels Hofmeyr 1d2321dcde OsmoSTP: update VTY reference
This is the first update since the libosmocore changes to the 'show
online-help' generated output. Hence the produced document now benefits from
the structural improvements:
- not repeating common commands for every node;
- using section names that match the VTY prompt.

Change-Id: I98cdfcb6c1c7db49ab106e775be92e4c6adeab17
2018-03-06 19:43:35 +00:00
Neels Hofmeyr 36a0a1bbb3 OsmoSGSN: update VTY reference
This is the first update since the libosmocore changes to the 'show
online-help' generated output. Hence the produced document now benefits from
the structural improvements:
- not repeating common commands for every node;
- using section names that match the VTY prompt.

Drop most of the sgsn_vty_additions.xml -- they merely repeat what the online
VTY doc already explains. Many of these more verbose explanations have been
absorbed into the VTY online doc in osmo-sgsn.git change-id
I35984014424412e91437b7ed71576aef3819cb1e.

Adjust remaining sgsn_vty_additions.xml to match the new node ID scheme.

Change-Id: I71863e5056ad369d2055e9882a52a00fa999ab04
2018-03-06 19:43:35 +00:00
Neels Hofmeyr a76a993503 OsmoMGW: update VTY reference
This is the first update since the libosmocore changes to the 'show
online-help' generated output. Hence the produced document now benefits from
the structural improvements:
- not repeating common commands for every node;
- using section names that match the VTY prompt.

Change-Id: I79804ec0e61cc19a679f079a083a5ea2ea3ee2de
2018-03-06 19:43:35 +00:00
Neels Hofmeyr 823780ecd8 OsmoHLR: update vty reference
Add new (generic) logging commands, talloc context print commands.
Add the jitter buffer logging category.

Remove the common commands from the individual sections.

Change-Id: I8e92c821b26908d4baa37745c57b9e15bda2a373
2018-03-06 19:43:35 +00:00
Neels Hofmeyr 50605cf9aa OsmoGGSN: update vty reference
Add new (generic) logging commands, talloc context print commands.
Add the jitter buffer logging category.

Change-Id: Ifdc735df6221bf6e9b6247912f2958974dcfc4f2
2018-03-06 19:43:35 +00:00
Neels Hofmeyr cd72b249cf OsmoMSC: update VTY reference
This is the first update since the libosmocore changes to the 'show
online-help' generated output. Hence the produced document now benefits from
the structural improvements:
- not repeating common commands for every node;
- using section names that match the VTY prompt.

Update msc_vty_additions.xml to match the new node ID scheme.

Change-Id: I6f1698dbc205334cf69234f88b124abfce54cc9a
2018-03-06 19:43:35 +00:00
Neels Hofmeyr 4cd97ceea5 OsmoBSC: update VTY reference
This is the first update since the libosmocore changes to the 'show
online-help' generated output. Hence the produced document now benefits from
the structural improvements:
- not repeating common commands for every node;
- using section names that match the VTY prompt.

Update bsc_vty_additions.xml to match the new node ID scheme.

Change-Id: I0d856563eee88527fda4c6940aa6cea779175aaa
2018-03-06 19:43:34 +00:00
Neels Hofmeyr 386703a3e4 INSTALL.txt: update VTY reference how-to to new osmo_interact_vty.py
Change-Id: I5bf1fea83354049f4157ee9ac8b40f673597f908
2018-03-06 19:43:34 +00:00
Pau Espin 9af4229dbe Introduce chapter trx_if.adoc and add it to OsmoTRX and OsmoBTS
This chapter defines the protocol used between osmo-trx and
osmo-bts-trx.

Most of the text comes originally from osmo-trx.git/README, as it's the
only known documentation of the protocol other than the code itself.

Change-Id: I56c418eef0f826ae1aadbed5b151fbed241c7885
2018-03-06 17:50:28 +01:00
Pau Espin fe5b55e1c8 Introduce OsmoTRX manual
Change-Id: I19ee9d6cda02fb7200c96c0ac129e69825b096cd
2018-03-06 17:50:28 +01:00
Pau Espin 4435f763d5 common: port_numbers: Add OsmoTRX and OsmoBTS missing ports
Change-Id: Idc34aa2d4241945e80c07e4e5660451a016f0117
2018-03-06 16:07:55 +01:00
Pau Espin 83c467a16d OsmoSGSN: overview: Fix typo and reference OpenGGSN->OsmoGGSN
Change-Id: I94cc362a4f52e6bd9f93299665e73dc4fd75a2c6
2018-03-06 14:46:19 +01:00
Pau Espin 30b6052e02 OsmoBTS: bts-models: Add Lime Microsystems devices as supported osmo-trx
Also take the chance to remove uneeded extra whitespace in surrounding
text.

Change-Id: I739e4dfba7c649a74cf67d6bbe6f74b22e7e24f0
2018-03-06 14:45:12 +01:00
Stefan Sperling 8c4d14fb4b Improve error message when libosmocom directory cannot be found.
The rules in build/Makefile.vty-reference.inc require a libosmocore
source tree. Make the top-level Makefile check that LIBOSMO_DIR is
set to a valid directory before running the build.

This transforms an obscure build error into:

Directory '~/source/gsm/libosmocore' not found, please set LIBOSMO_DIR to
the path of your libosmocom source tree: make LIBOSMO_DIR=/path/to/libosmocore
Makefile:80: recipe for target 'check-deps' failed

Change-Id: Ic201373df115bb6f8c9a2bc30d18ff4c2a660deb
Related: OS#2787
2018-02-16 17:52:44 +01:00
Harald Welte 908b838366 GSUP: Change wording to cover both SGSN and MSC/VLR
Change-Id: I4b473e324e9314f4e9356a8bae6fbb48dbaaf58c
2018-01-26 11:30:44 +01:00
Harald Welte 66c6dcce3c share chapters/gsup.adoc from OsmoSGSN to OsmoMSC + OsmoHLR
Since the NITB split, GSUP is used in all three network elements, so
make the protocol a shared chapter

Change-Id: Id2d7c27ef16eb0ebe5f60d625a1fcf42f1603f4f
2018-01-26 11:17:25 +01:00
Max 88ef855d23 Document workaround for gsmtap logging
Document a way to minimize logging to stderr when gsmtap is used as a
log target.

Change-Id: I8e64a0075b5a4bad3f83660e0668e6de45b21008
2018-01-19 22:09:53 +00:00
Max f2f37e5b19 Clarify app-specific log filters
Change-Id: I53e8aed658774781a70fea0b46cafc55496925eb
2018-01-19 15:43:41 +00:00
Max 8452ddb66a Add note on vty logging
Change-Id: I2bb52feb37622d0ef35f6be172759adc3813f008
2018-01-18 15:30:23 +01:00
Harald Welte 8405088e81 add message sequence chart MS/BTS/BSC/MSC for 3GPP aoIP MO call
Change-Id: I7e41234cfe1483bb73589dc959851a54f9aafa36
2018-01-11 15:51:57 +01:00
Max ff995e7d9c sigtran: fix typo
Change-Id: I02004ea55a00c55ee134d2c13e93614c3e1f06b3
2018-01-05 12:46:53 +00:00
Max 98bb147bbd Describe gsmtap log destination
Change-Id: If34e1640d1033daacc955f4285013b8c1be644d2
Fixes: OS#2608
2018-01-05 12:46:38 +00:00
Max a8d2935f83 Update path to ctrl scripts
Change-Id: Ib95e1ad33bbf115c8190f97210925549e6dc081a
Related: OS#2550
2018-01-04 14:58:12 +01:00
Neels Hofmeyr a13675c549 ports: add osmo-hnbgw as on port-numbers wiki page
Related: https://osmocom.org/projects/cellular-infrastructure/wiki/Port_Numbers
Related: Ife52a968a41cb286f640006587877971ff66c1a4 (libosmocore)
Change-Id: I28bd7a97d24455f88fadc6724d45c3264ba2fce4
2017-12-20 02:30:26 +01:00
Neels Hofmeyr 74b55d7457 common: ports: tweak OpenGGSN to osmo-ggsn as on port-numbers wiki page
Related: https://osmocom.org/projects/cellular-infrastructure/wiki/Port_Numbers
Change-Id: Ieaac06c9d914fc7481107ca8ebe6192b36b91bcd
2017-12-20 02:30:21 +01:00
Neels Hofmeyr ccb51225c5 jenkins.sh: incorporate publish step, for master build
Change-Id: I3c14f4e0266a4eb2702ca9fa9cf05dd54fc5d853
2017-12-15 05:36:49 +01:00
Philipp Maier 0d149fbcb8 osmo-mgw: Add vty reference manual
add missing vty reference manual for osmo-mgw

Change-Id: If9d8cdcbbbf14b23e48af5b9ae1c56c2a38219a2
2017-12-12 17:43:43 +01:00
Neels Hofmeyr 27e0735104 common: vty_additions: use proper node IDs, tweak node descriptions
Depends on the ENABLE and VIEW nodes to be named, as in a recent libosmocore
patch.

Depends: Iefb8b78094208a1a4c5d70bd6c69a3deca8da54f (libosmocore)
Change-Id: Ic2f3b18cced72db6fa5bad02ae58c602bb2c0213
2017-12-09 06:08:57 +01:00
Neels Hofmeyr 9c8a8ebb36 OsmoGGSN: fix VTY additions' node IDs
Change-Id: I8cd5eb64300151d0de8023ed019568cfdc4fe453
2017-12-09 06:07:56 +01:00
Neels Hofmeyr 92c1a2763d OsmoGGSN vty: update VTY reference
Apply VTY reference changes from libosmocore: change node IDs from index
numbers to meaningful names from VTY node prompts.

Introduce section with common commands, do not repeat the common commands on
each child node.

Populate section names (so far empty).

Add apn / gpdu VTY reference.

This is generated using the recent libosmocore vty doc patches that conclude in
libosmocore change-id Iedd67750539b676271de0e0e9316d4e6f794406a.

Change-Id: Ia269c4bda0aa0b905abcccc75338f5f808e01727
2017-12-09 06:07:08 +01:00
Neels Hofmeyr 2b9b6e3ef0 OsmoGGSN VTY ref: prep: convert newlines to unix
To omit whitespace changes in an upcoming patch that updates the VTY reference
and will use '\n' line breaks, convert line breaks from '\r\n' to '\n' without
any other changes.

Change-Id: Id0d1a3a82c3d670cbb041884554b5d79fdfb0f28
2017-12-09 06:05:30 +01:00