path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2020-03-23manual: explain IuPS, add SCCP/M3UA section from common chaptersNeels Hofmeyr2-0/+22
Add 'cs7' default configuration, link to the osmo-gsm-manuals/common/cs7-config.adoc chapter to fully explain the 'cs7' client configuration. Related: OS#2767 Depends: Ia2508d4c7b0fef9cdc57e7e122799a480e340bf7 (osmo-gsm-manuals) Change-Id: If0f7c8fc4b94eb40b62570cf90999d5074dc00ee
2019-12-03regen_doc.sh: support gbproxy, run without dockerOliver Smith1-11/+71
Do not only update the VTY reference and counters of osmo-sgsn, but also the VTY reference of gbproxy. This was not possible with the old code path of calling "regen_doc.sh" inside docker-playground.git, as it expects the program to be updated to have the same name as the docker image. Using the docker-playground script also has the disadvantage, that one must push the development branch to git.osmocom.org before updating the VTY reference/counters, because that script would build a new docker container with a freshly cloned repository, check out the same commit that we have already locally, build that and then finally regenerate the docs. So instead of adding another parameter for the docker image to the script in docker-playground.git and calling it twice, simplify the process by rewriting the regen_doc.sh script in osmo-sgsn.git. Make it start the locally installed osmo-sgsn and osmo-gbproxy binaries and call osmo_interact_vty.py on them. Related: OS#4292 Change-Id: I8b5bd5347ea34266ad650383372630f2a84d5cce
2019-12-03doc: add OsmoGbProxy VTY referenceOliver Smith4-2/+1675
Depends: (osmo-gsm-manuals) I4dea3e07b88175b2a88e577129360af7ec5f87e1 Related: OS#4292 Change-Id: I24c3ca2fc2446673edceefb797c7d800c3a1a5d2
2019-12-01manual: Fix copy+paste errorHarald Welte1-1/+1
Change-Id: I5753ded676951998a1fd76e4d2c2bf3311213f53
2019-12-01Initial OsmoGbPROXY user manualHarald Welte7-1/+284
This adds a very basic manual consisting of nothing more than the common chapters and a high-level description of what it is all about. Change-Id: I80d4ea016376c59995ccfcd8685c7c0e86745bd2
2019-09-02Move out gtphub to its own subdirPau Espin Pedrol1-1/+1
Change-Id: I707d5e9b775179e732d281ce3d245de83d648eea
2019-08-21vty: Introduce cs7-instance-iuPau Espin Pedrol2-0/+7
Similar to what we already have in osmo-msc. Change-Id: Iaa9e1d06dd0430848ef4f7498a3c15d13f899904
2019-08-21examples: Add osmo-sgsn_custom-sccp.cfgPau Espin Pedrol1-0/+38
Change-Id: Id3a3ccbf168fbbc28153cbf7f0249294eee34d3d
2019-07-30configuration.adoc: Add a section about encryptionDaniel Willmann1-0/+18
Change-Id: I3a2b84d386f55447e9eed35e59fdc0272e5147d1 Related: OS#1720
2019-07-30configuration.adoc: Small fixesDaniel Willmann1-14/+25
Fix some typos, correct data compression command, add example to turn off compression. Change-Id: I6beff8c66eacf12f1081d51dd6b124bdd4478558 Related: OS#1720
2019-07-29osmo-gbproxy.cfg: fix conflict with osmo-sgsn.cfgOliver Smith1-0/+1
Listen on by default, so there is no conflict on This allows starting both services with their default configuration, like we are doing it in the Osmocom-Debian-install-* jenkins jobs. Related: OS#3369 Change-Id: I6e3053de8885a7954296d820c6a069d06276e4df
2019-07-26osmo-sgsn: Fix outdated information in usermanualDaniel Willmann2-18/+9
Quite a few features that are listed as not-implemented in the overview section are actually implemented now. Change-Id: I8d499a25293b69babc2aebb2d697438f8ba8141f Related: OS#1720
2019-07-24osmo-gtphub.cfg: fix conflict with osmo-sgsn.cfgOliver Smith1-1/+1
Change bind-to-sgsns from to, so osmo-gtphub's default config does not conflict with the osmo-sgsn default config. The value of bind-to-ggsns does not clash with osmo-ggsn's config, so it was left unchanged. Related: OS#3369 Change-Id: Id892e1f4ab2daabbe9824b819b5fed985373b97a
2019-07-24manuals: Update vty/counter documentationDaniel Willmann2-65/+26
Change-Id: Id7245eb1011d1f04d5dfa1503a96d100bc98344c Related: OS#1700
2019-06-19manuals: Add script to regenerate vty/counter documentationDaniel Willmann2-0/+18
Change-Id: I8ee63a3da532285def8de7fe5e90873152adb21e Related: OS#1700
2019-06-13sgsn: Have authentication required on by defaultPau Espin Pedrol1-3/+3
Previous commit introduced command "authentication (optional|required)", which is only meaningful if auth-policy is remote. Upon adding the cmd, it changed the default logic for remote policy to not require authentication, which broke TTCN3 tests because sgsn no longer tries to authenticate the users. Since it's actually good to enable authentication by default where possible, let's enable it by default when on auth-policy remote. In order to do so, let's simply not care about the value of variable require_authentication if auth_policy is not REMOTE. As a result, we drop parts of the previous patch and remove unneeded checks (which are only partially useful based on order of commands during VTY read). Fixes: 794f446a284ed1ac6d31eb79a8f4c874d66fc34e Change-Id: Ic707a95af178b44f08809df3d3bc8354bf34273c
2019-06-06osmo-sgsn: add VTY parameter to toggle authenticationVadim Yanitskiy3-0/+9
It may be useful to have 'remote' authorization policy, but do not require authentication in GERAN at the same time, e.g. in combination with 'subscriber-create-on-demand' feature of OsmoHLR. This change introduces a new VTY parameter similar to the one that we already have in OsmoMSC: authentication (optional|required) Please note that 'required' only applies if 'auth-policy' is 'remote'. Change-Id: I9909145e7e0af587c28827e16301a61b13eedaa9
2019-06-05doc/manuals/vty: regenerate sgsn_vty_reference.xmlVadim Yanitskiy1-7/+21
Change-Id: I3dfe3598055457cc9724a371590e676f1920652b
2019-05-29debian: create -doc subpackage with pdf manualsOliver Smith1-0/+1
I have verified, that the resulting debian packages build in my own OBS namespace (see the -doc packages): https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/ https://build.opensuse.org/project/show/home:osmith42 Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci) Related: OS#3899 Change-Id: I9c09a0cb5c65fa2e2cd9817edb4656b2a1a35bb9
2018-11-27build manuals moved here from osmo-gsm-manuals.gitOliver Smith5-27/+34
Moved to doc/manuals/, with full commit history, in preceding merge commit. Now incorporate in the build system. Build with: $ autoreconf -fi $ ./configure --enable-manuals $ make Shared files from osmo-gsm-manuals.git are found automatically if - the repository is checked out in ../osmo-gsm-manuals; or - if it osmo-gsm-manuals was installed with "make install"; or - OSMO_GSM_MANUALS_DIR is set. Related: OS#3385 Change-Id: I0477d7c871413bd90b365d3064bac3cba23a0883
2018-11-27Merge history from osmo-gsm-manuals.gitNeels Hofmeyr12-0/+3291
Change-Id: I284bfe2fc61167986cf784eabdd57151d4981e7a
2018-11-27sgsn: update vty referenceNeels Hofmeyr1-55/+252
Change-Id: I64d775efa6791aca025d116905e951e10ffa5d04
2018-11-27vty-ref: Update URI of docbook 5.0 schemaHarald Welte1-2/+2
... to match the /etc/xml/catalog file on debian (no "www" in hostname) Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d
2018-11-27OsmoSGSN: update VTY referenceNeels Hofmeyr2-2113/+2315
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-11-27OsmoSGSN: overview: Fix typo and reference OpenGGSN->OsmoGGSNPau Espin Pedrol1-2/+2
Change-Id: I94cc362a4f52e6bd9f93299665e73dc4fd75a2c6
2018-11-27share chapters/gsup.adoc from OsmoSGSN to OsmoMSC + OsmoHLRHarald Welte2-860/+1
Since the NITB split, GSUP is used in all three network elements, so make the protocol a shared chapter Change-Id: Id2d7c27ef16eb0ebe5f60d625a1fcf42f1603f4f
2018-11-27OsmoSGSN: add rate counter documentationAlexander Couzens3-0/+127
Change-Id: I4c5d5744f961a92bc7c8888ca739d1e8a8a0be9c
2018-11-27OsmoSGSN: configuration: Document CDR CTRL interfacePau Espin Pedrol1-1/+15
Change-Id: Ib729e2fc4898c20d27e95fc0f13abe9c0656dda5
2018-11-27OsmoSGSN: configuration: Add missing pdp-periodic eventPau Espin Pedrol1-0/+1
Change-Id: I2d8b11496e75abd23a42efab8eabba2b5b0912e9
2018-11-27OsmoSGSN: configuration: Move pdp ctx specific CDR fields to its own tablePau Espin Pedrol1-1/+10
Change-Id: I056f278b64ab426b9455b6a667abf2fe7fc94022
2018-11-27refactor Makefile build rules, don't use the FORCENeels Hofmeyr1-39/+6
The initial goal was to make sure we don't have overall FORCE rules causing unnecessary rebuilds -- annoying while writing documentation. As I looked through possible dependencies, I finally understood what's going on here. Remove code dup and nicely sort which belongs where in build/Makefile.*.inc. In each, describe in a top comment how to use it, and also unify how they are used: - Rename Makefile.inc to Makefile.docbook.inc and refactor - Add Makefile.vty-reference.inc - Add Makefile.common.inc Make sure that we accurately pick up all dependencies. Drop use of the macro called 'command', that silenced the actual command lines invoked and replaced them with short strings: it obscures what is actually going on and makes the Makefiles hard to read and understand. Each manual's makefile is greatly reduced to few definitions and a Makefile include, e.g. one for asciidoc, one for VTY reference. Move common/bsc_vty_additions.xml to OsmoBSC/vty/libbsc_vty_additions.xml, link from OsmoNITB. It applies only to OsmoBSC and OsmoNITB. Add a script that combines a VTY reference file with *all* additions files found in a manual's vty/ dir. Call this from Makefile.vty-reference.inc. Change-Id: I9758e04162a480e28c7dc83475b514cf7fd25ec0
2018-11-27Allow easily disabling GFDL referencesPau Espin Pedrol1-0/+2
All parts referencing GFDL can be easily disabled by removing the 'gfdl-enabled' attribute from the document. Change-Id: I2489726ad2e90301bceadfada926e31ae0f85986
2018-11-27sgsn: Add charging characteristics to GSUPHolger Hans Peter Freyther1-0/+24
Reserve a new IE for the charging characteristics. We need to handle them as a GGSN might otherwise reject the PDP context creation. For the SGSN it is enough to send the two octets as it. Pick the 0x1X range for the IEs as it is used with the PDP contexts. Change-Id: I1d7423582e154728a240cf15c32772a06822f4ad
2018-11-27sgsn: Fix numbering of QoS and add basic description for APNHolger Hans Peter Freyther1-2/+9
QoS was supposed to be 13 as 12 has been used for the APN. Fix that and document the APN. Change-Id: Ib6113aa7c59841aada424e2cafd94ed88c7badc7
2018-11-27osmo-sgsn: fix arrow tips in flow diagramsPhilipp Maier1-37/+37
The arrow style used to desribe the flowcharts in gsup.adoc does not match the arrow style used in the protocol descriptions which are included from the common directory (gb.adoc, control_if.adoc, oap.adoc). This patch changes the arrow style to match the already existing common parts. Change-Id: I7faa0c97ee3705a64289a47bc63f311d05f988b3
2018-11-27osmo-sgsn: Explain TCP/IP header compressionPhilipp Maier1-0/+80
The does not mention TCP/IP header compression yet. This commit adds some info about it Change-Id: I98408e72020a474d378e39263a933eb7567de146
2018-11-27osmo-sgsn: improve auth-policy explainationPhilipp Maier1-14/+38
The explaination of the access policy is a bit unclear. Users that come from osmo-nitb might have trouble to grasp the functionality of the access control list based approack correctly. Change-Id: Iaae3035c4de3cb082f097441eff99289ee6dfc53
2018-11-27osmo-sgsn: Update VTY command referencePhilipp Maier2-17/+665
Change-Id: I6585144addd8501226572eda6f55db19d0e31c54
2018-11-27GSUP, OAP: fix AUTS length to 14, not 16ikostov1-1/+1
https://gerrit.osmocom.org/1731 Change-Id: Id33d300c4985be5f2602703a6d4dc83032f0a926
2018-11-27SGSN: add Auth. policy, NS Statistics and BSSGP state examples, tweaksikostov2-18/+47
Add semicoli in fig-gprs-pcubts digraph. Remove section from GMM Implementation about non-existence of HLR. The SGSN can access osmo-hlr via GSUP (and will have to do so in the libvlr future). Change-Id: I0164f418e453672321eed00bbc454c1e223ea158
2018-11-27fix 'make clean': shell glob, ignore failureNeels Hofmeyr1-2/+3
Unfortunately a glob like osmo-x__*.{svg,png} doesn't work, so have the suffixes in separate globs. Add dashes to indicate that failure should be ignored. Change-Id: I6bc4d9ea72b43a573acbc860c23397f748de2c7b
2018-11-27add 'make check' targetNeels Hofmeyr1-1/+1
Generate *.check files from asciidoc output and grep for WARNINGs. Add *.check files to gitignore and to 'make clean'. Change-Id: Ibccc83a3415930a528f2e8e4e4dda3b81c6d0b64
2018-11-27GSUP: Add ladder diagrams for protocol transactions / proceduresHarald Welte2-7/+153
2018-11-27Update GSUP chapter regarding UMTS AKA and other recent changesHarald Welte1-0/+91
The GSUP protocol has been enhanced with * Support for UMTS AKA in 'Auth Tuple' / SAI operations * Authentication Failure Report * CN Domain indicator Let's update the documentation accordingly.
2018-11-27Add OsmoSGSN control interface descriptionMax2-0/+25
2018-11-27fix various typos across all manualsJonathan Brielmaier2-3/+3
2018-11-27OsmoSGSN: Fix formatting/cross reference in CDR sectionHarald Welte1-1/+2
2018-11-27Add link to Asciidoc source code of manualHarald Welte1-0/+6
2018-11-27initial checkin of manuals to public repoHarald Welte10-0/+2549
The manuals existed in different form for several years in an internal sysmocom repository. However, since they had just recently been converted from docboox-xml to asciidoc and all files have been re-shuffled for enabling the public release, there's not much point in keeping the history with git-filter-branch.
2018-09-25gbproxy-legacy: Ensure well-formed config fileHarald Welte1-14/+14
Change-Id: I3495c8448459ba4f834744a1df6e7aa6a196d755