From e4b6db024cd2c1ea0fc7cd7d470b3f81236548da Mon Sep 17 00:00:00 2001 From: Oliver Smith Date: Wed, 28 Nov 2018 10:53:03 +0100 Subject: remove OsmoSIPConnector files (now avail in osmo-sip-connector.git) Files were added in osmo-sip-connector.git Change-Id I1317131ed6765fec996344fc6ed08350187b615b Depends: osmo-sip-connector.git Change-Id I1317131ed6765fec996344fc6ed08350187b615b Related: OS#3385 Change-Id: Id77812586eb21932b563b57e75cd85b721b7d6ab --- Makefile.am | 1 - OsmoSIPConnector/Makefile.am | 15 - OsmoSIPConnector/chapters/configuration.adoc | 53 - OsmoSIPConnector/chapters/overview.adoc | 48 - OsmoSIPConnector/chapters/running.adoc | 84 -- .../osmosipconnector-usermanual-docinfo.xml | 46 - OsmoSIPConnector/osmosipconnector-usermanual.adoc | 28 - .../osmosipconnector-vty-reference.xml | 38 - OsmoSIPConnector/vty/sipconn_vty_additions.xml | 2 - OsmoSIPConnector/vty/sipconn_vty_reference.xml | 1132 -------------------- configure.ac | 1 - 11 files changed, 1448 deletions(-) delete mode 100644 OsmoSIPConnector/Makefile.am delete mode 100644 OsmoSIPConnector/chapters/configuration.adoc delete mode 100644 OsmoSIPConnector/chapters/overview.adoc delete mode 100644 OsmoSIPConnector/chapters/running.adoc delete mode 100644 OsmoSIPConnector/osmosipconnector-usermanual-docinfo.xml delete mode 100644 OsmoSIPConnector/osmosipconnector-usermanual.adoc delete mode 100644 OsmoSIPConnector/osmosipconnector-vty-reference.xml delete mode 100644 OsmoSIPConnector/vty/sipconn_vty_additions.xml delete mode 100644 OsmoSIPConnector/vty/sipconn_vty_reference.xml diff --git a/Makefile.am b/Makefile.am index da712fe..6c2879f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -10,7 +10,6 @@ SUBDIRS = tests \ OsmoMGCP \ OsmoNAT \ OsmoNITB \ - OsmoSIPConnector \ OsmoSTP \ OsmoTRX \ OsmocomBB diff --git a/OsmoSIPConnector/Makefile.am b/OsmoSIPConnector/Makefile.am deleted file mode 100644 index f2bb064..0000000 --- a/OsmoSIPConnector/Makefile.am +++ /dev/null @@ -1,15 +0,0 @@ -OSMO_GSM_MANUALS_DIR = $(top_srcdir) -EXTRA_DIST = osmosipconnector-usermanual.adoc \ - osmosipconnector-usermanual-docinfo.xml \ - osmosipconnector-vty-reference.xml \ - chapters \ - vty - -ASCIIDOC = osmosipconnector-usermanual.adoc -ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc -include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc - -VTY_REFERENCE = osmosipconnector-vty-reference.xml -include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc - -include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc diff --git a/OsmoSIPConnector/chapters/configuration.adoc b/OsmoSIPConnector/chapters/configuration.adoc deleted file mode 100644 index 5cd57fa..0000000 --- a/OsmoSIPConnector/chapters/configuration.adoc +++ /dev/null @@ -1,53 +0,0 @@ -== Configuring OsmoSIPConnector - -The configuration of OsmoSIPConnector consists mainly of two parts: -configuring the MNCC interface towards the MSC and configuring the SIP -interface towards the PBX. - -=== Configuring MNCC - -Configuring the MNCC interface is very simple. It has to be pointed to -the same path that OsmoMSC is also using. This means that OsmoMSC and -OsmoSIPConnector need to be running on the same machine or have a shared -directory that supports UNIX domain sockets. - -Note that you need to start `osmo-msc` with the `--mncc-sock` option and point -to the same file that osmo-sip-connector is configured to use. See the OsmoMSC -manual for more information. - -The example config below assumes that OsmoMSC was started with the command -line `osmo-msc -M /tmp/msc_mncc`. - -.Example: MNCC configuration ----- -OsmoSIPcon(config)# mncc -OsmoSIPcon(config-mncc)# socket-path /tmp/msc_mncc ----- - -=== Configuring SIP - -This section covers the SIP configuration. Source and destination IP and port -can be set for the connection to the PBX. - -.Example: SIP configuration ----- -OsmoSIPcon(config)# sip -OsmoSIPcon(config-sip)# local 10.0.0.1 5060 <1> -OsmoSIPcon(config-sip)# remote 10.0.0.2 5060 <2> ----- -<1> The local IP/port to use -<2> The remote SIP IP/port that the PBX uses - -There is also an option to use the IMSI as calling (source) address for -MO- and as called (destination) address for MT-calls. - -.Example: Use IMSI instead of MSISDN ----- -OsmoSIPcon(config)# app -OsmoSIPcon(config-app)# use-imsi <1> ----- -<1> Use the IMSI for MO calling and MT called address - -Since OsmoSIPConnector is just a shim between OsmoMSC and a proper SIP server -this is the extent of the configuration. Setting up a dialplan and other -SIP-related configuration should be done in the actual SIP server. diff --git a/OsmoSIPConnector/chapters/overview.adoc b/OsmoSIPConnector/chapters/overview.adoc deleted file mode 100644 index 24fe8b9..0000000 --- a/OsmoSIPConnector/chapters/overview.adoc +++ /dev/null @@ -1,48 +0,0 @@ -[[overview]] -== Overview - -This manual should help you getting started with OsmoSIPConnector. It will -cover aspects of configuring and running OsmoSIPConnector. - -[[intro_overview]] -=== About OsmoSIPConnector - -OsmoSIPConnector translates between Mobile Network Call Control (MNCC) -used in the GSM newtwork and Voice over IP SIP call control messages so that -speech calls can traverse through the mobile network to SIP and vice versa. It -has the following interfaces: - -- MNCC UNIX domain socket towards `osmo-msc` -- SIP towards the PBX -- The Osmocom typical telnet VTY interface. - -Find the OsmoSIPConnector issue tracker and wiki online at - -- https://osmocom.org/projects/osmo-sip-connector -- https://osmocom.org/projects/osmo-sip-connector/wiki - - -[[fig-gsm]] -.Typical GSM network architecture used with OsmoSIPConnector -[graphviz] ----- -digraph G{ - rankdir = LR; - "osmo-sip-connector" [color="red"]; - OsmoMGWB [label="OsmoMGW\n(BSC)"]; - OsmoMGWM [label="OsmoMGW\n(MSC)"]; - MS -> BTS [label = "Um"]; - BTS -> OsmoBSC [label = "Abis"]; - OsmoBSC -> OsmoMSC [label = "AoIP" ]; - OsmoMSC -> "osmo-sip-connector" [label = "MNCC"]; - "osmo-sip-connector" -> "PBX" [label = "SIP"]; - BTS -> OsmoMGWB [label = "RTP"]; - OsmoMGWB -> OsmoMGWM [label = "RTP"]; - OsmoMGWM -> "PBX" [label = "RTP"]; - OsmoBSC -> OsmoMGWB [label = "MGCP" ]; - OsmoMSC -> OsmoMGWM [label = "MGCP" ]; - { rank = same; OsmoBSC; OsmoMGWB; } - { rank = same; OsmoMSC; OsmoMGWM; } -} ----- - diff --git a/OsmoSIPConnector/chapters/running.adoc b/OsmoSIPConnector/chapters/running.adoc deleted file mode 100644 index 85ccddc..0000000 --- a/OsmoSIPConnector/chapters/running.adoc +++ /dev/null @@ -1,84 +0,0 @@ -== Running OsmoSIPConnectoer - -The OsmoSIPConnector executable (`osmo-sip-connector`) offers the following -command-line arguments: - -=== SYNOPSIS - -*osmo-sip-connector* [-h] [-c 'CONFIGFILE'] - -=== OPTIONS - -*-h, --help*:: - Print a short help message about the supported options -*-c, --config-file 'CONFIGFILE'*:: - Specify the file and path name of the configuration file to be - used. If none is specified, use `osmo-sip-connector.cfg` in the - current working directory. - -=== Colocation with OsmoMSC - -Since the MNCC interface used to communicate between OsmoMSC and -OsmoSIPConnector is a UNIX domain socket both processes must run on the same -machine or have a shared directory that supports sharing UNIX domain sockets. - -=== Multiple instances - -Running multiple instances of `osmo-sip-connector` on the same computer is -possible if all interfaces (VTY, CTRL) are separated using the appropriate -configuration options. The IP based interfaces are binding to local host by -default. In order to separate the processes, the user has to bind those -services to specific but different IP addresses and/or ports. - -The VTY and the Control interface can be bound to IP addresses from the -loopback address range, for example: - ----- -line vty - bind 127.0.0.2 -ctrl - bind 127.0.0.2 ----- - -For the SIP client a different IP/port combination also needs to be used, for -example: - ----- -sip - local 0.0.0.0 5061 ----- - -The socket path for the MNCC interface also needs to change, which can be done -with the following configuration snippet: - ----- -mncc - socket-path /tmp/msc2_mncc ----- - -=== DTMF signaling - -In VoIP based telephony networks DTMF (Dual-tone multi-frequency signaling) can -be signaled through multiple methods. Common methods are in-band, RFC2833 and -sip-info messages. - -Osmo-sip-connector is using sip-info messages to signal DTMF tones. When a DTMF -tone is signaled at the MNCC socket interface, osmo-sip-connector will generate -a matching sip-info message to forward the DTMF signal to the PBX. Depending on -the PBX software reconfiguring the DTMF signaling method to sip-info may be -necessary. - -While sending DTMF tones through the MNCC interface to a SIP leg, the current -implementation of osmo-sip-connector does not support sending DTMF tones in the -opposite direction. Any attempts to send DTMF tones to an MNCC leg will be -confirmed with a status 405 "Method not allowed". - -The reason for this limitation is that in mobile networks, depending on the -signaling direction, the signaling of DTMF tones is implemented differently. -A mobile originated DTMF tone is signaled through out of band messages, -which arrive at osmo-sip-connector on as MNCC DTMF START/STOP messages. Those -messages can be directly translated to sip-info messages. However, in the -other direction (mobile terminated), an in-band signaling method is used. This -means that osmo-sip-connector would have to translate an incoming DTMF sip-info -message into an audio sample that then would have to be injected into the -voice stream. Currently this scheme is not implemented in osmo-sip-connector. \ No newline at end of file diff --git a/OsmoSIPConnector/osmosipconnector-usermanual-docinfo.xml b/OsmoSIPConnector/osmosipconnector-usermanual-docinfo.xml deleted file mode 100644 index 937e054..0000000 --- a/OsmoSIPConnector/osmosipconnector-usermanual-docinfo.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - 1 - August 04th, 2018 - DW - - Initial version - - - - - - - Daniel - Willmann - dwillmann@sysmocom.de - DW - - sysmocom - sysmocom - s.f.m.c. GmbH - - - - - - 2018 - sysmocom - s.f.m.c. GmbH - - - - - Permission is granted to copy, distribute and/or modify this - document under the terms of the GNU Free Documentation License, - Version 1.3 or any later version published by the Free Software - Foundation; with the Invariant Sections being just 'Foreword', - 'Acknowledgements' and 'Preface', with no Front-Cover Texts, - and no Back-Cover Texts. A copy of the license is included in - the section entitled "GNU Free Documentation License". - - - The Asciidoc source code of this manual can be found at - - http://git.osmocom.org/osmo-gsm-manuals/ - - - diff --git a/OsmoSIPConnector/osmosipconnector-usermanual.adoc b/OsmoSIPConnector/osmosipconnector-usermanual.adoc deleted file mode 100644 index 72d7127..0000000 --- a/OsmoSIPConnector/osmosipconnector-usermanual.adoc +++ /dev/null @@ -1,28 +0,0 @@ -:gfdl-enabled: -:program-name: OsmoSIPConnector - -OsmoSIPConnector User Manual -============================ -Daniel Willmann - - -include::./common/chapters/preface.adoc[] - -include::{srcdir}/chapters/overview.adoc[] - -include::{srcdir}/chapters/running.adoc[] - -include::./common/chapters/vty.adoc[] - -include::./common/chapters/logging.adoc[] - -include::{srcdir}/chapters/configuration.adoc[] - -include::./common/chapters/port_numbers.adoc[] - -include::./common/chapters/bibliography.adoc[] - -include::./common/chapters/glossary.adoc[] - -include::./common/chapters/gfdl.adoc[] - diff --git a/OsmoSIPConnector/osmosipconnector-vty-reference.xml b/OsmoSIPConnector/osmosipconnector-vty-reference.xml deleted file mode 100644 index 0eeb952..0000000 --- a/OsmoSIPConnector/osmosipconnector-vty-reference.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - -]> - - - - - - v1 - 21st August 2018 - dw - Initial - - - - OsmoSIPConnector VTY Reference - - - 2018 - - - - This work is copyright by sysmocom - s.f.m.c. GmbH. All rights reserved. - - - - - - &chapter-vty; - - diff --git a/OsmoSIPConnector/vty/sipconn_vty_additions.xml b/OsmoSIPConnector/vty/sipconn_vty_additions.xml deleted file mode 100644 index a4c675e..0000000 --- a/OsmoSIPConnector/vty/sipconn_vty_additions.xml +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/OsmoSIPConnector/vty/sipconn_vty_reference.xml b/OsmoSIPConnector/vty/sipconn_vty_reference.xml deleted file mode 100644 index dee42e6..0000000 --- a/OsmoSIPConnector/vty/sipconn_vty_reference.xml +++ /dev/null @@ -1,1132 +0,0 @@ - - - Common Commands - These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - view - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - enable - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - config - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - config-log - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - config-stats - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - config-line - - - - - - - - - - - - - - - - - - - - config-sip - - - - - - - - - - - - - - - - - - - - - - - - config-mncc - - - - - - - - - config-app - - - - - - - - - - - - - diff --git a/configure.ac b/configure.ac index 7eabd3a..e036384 100644 --- a/configure.ac +++ b/configure.ac @@ -32,7 +32,6 @@ AC_OUTPUT( OsmoMGCP/Makefile OsmoNAT/Makefile OsmoNITB/Makefile - OsmoSIPConnector/Makefile OsmoSTP/Makefile OsmoTRX/Makefile OsmocomBB/Makefile) -- cgit v1.2.3