Attention is currently required from: laforge.
pespin has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-smlc/+/28375 )
Change subject: Fill README with content; convert to markdown
......................................................................
Patch Set 2: Code-Review+2
--
To view, visit https://gerrit.osmocom.org/c/osmo-smlc/+/28375
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-smlc
Gerrit-Branch: master
Gerrit-Change-Id: I54297aba4dbb4f521caaeb555de9e5404f9e6dcd
Gerrit-Change-Number: 28375
Gerrit-PatchSet: 2
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-Attention: laforge <laforge(a)osmocom.org>
Gerrit-Comment-Date: Mon, 20 Jun 2022 10:22:56 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes
Gerrit-MessageType: comment
pespin has submitted this change. ( https://gerrit.osmocom.org/c/osmo-sip-connector/+/28373 )
Change subject: Convert + Expand README file
......................................................................
Convert + Expand README file
README.md in-line with that of other osmocom CNI projects:
* markdown syntax
* link to manuals, issue tracker, gerrit contributions, etc.
Change-Id: Ieadbbe4d2963e713d569460d053460f4f99d40eb
---
D README.asciidoc
A README.md
M contrib/osmo-sip-connector.spec.in
3 files changed, 83 insertions(+), 35 deletions(-)
Approvals:
pespin: Looks good to me, approved; Verified
diff --git a/README.asciidoc b/README.asciidoc
deleted file mode 100644
index acd491b..0000000
--- a/README.asciidoc
+++ /dev/null
@@ -1,34 +0,0 @@
-Osmo SIP Connector
-==================
-
-Simple utility to map MNCC to SIP and SIP to MNCC. The VTY interface
-can be used to make configurations. The code doesn't have any RTP or
-transcoding support.
-
-Call identities can be either the MSISDN or the IMSI of the subscriber.
-
-
-Requirements of Equipment
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* DTMF need to be sent using SIP INFO messages. DTMF in RTP is not
-supported.
-
-* BTS+PBX and SIP connector+PBX must be in the same network (UDP must be
-able to flow directly between these elements)
-
-* No handover support.
-
-* IP based BTS (e.g. Sysmocom sysmoBTS but no Siemens BS11)
-
-* No emergency calls
-
-Limitations
-^^^^^^^^^^^
-
-* PT of RTP needs to match the one used by the BTS. E.g. AMR needs to use
-the same PT as the BTS. This is because rtp_payload2 is not yet supported
-by the osmo-bts software.
-
-* AMR SDP file doesn't include the mode-set params and allowed codec modes.
-This needs to be configured in some way.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4064db6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,82 @@
+osmo-sip-connector - Osmocom SIP connector
+==========================================
+
+This implements an interface between the MNCC (Mobile Network Call Control)
+interface of OsmoMSC (and also previously OsmoNITB) and SIP.
+
+Call identities can be either the MSISDN or the IMSI of the subscriber.
+
+Requirements of Equipment
+-------------------------
+
+* DTMF need to be sent using SIP INFO messages. DTMF in RTP is not
+supported.
+* BTS+PBX and SIP connector+PBX must be in the same network (UDP must be
+able to flow directly between these elements)
+* No handover support.
+* IP based BTS (e.g. Sysmocom sysmoBTS but no Siemens BS11)
+* No emergency calls
+
+Limitations
+-----------
+
+* PT of RTP needs to match the one used by the BTS. E.g. AMR needs to use
+the same PT as the BTS. This is because rtp_payload2 is not yet supported
+by the osmo-bts software.
+
+* AMR SDP file doesn't include the mode-set params and allowed codec modes.
+This needs to be configured in some way.
+
+Homepage
+--------
+
+You can find the osmo-sip-connector issue tracker and wiki online at
+<https://osmocom.org/projects/osmo-sip-conector> and <https://osmocom.org/projects/osmo-sip-conector/wiki>
+
+
+GIT Repository
+--------------
+
+You can clone from the official osmo-msc.git repository using
+
+ git clone https://gitea.osmocom.org/cellular-infrastructure/osmo-sip-connector
+
+There is a web interface at <https://gitea.osmocom.org/cellular-infrastructure/osmo-sip-connector>
+
+
+Documentation
+-------------
+
+User Manuals and VTY reference manuals are [optionally] built in PDF form
+as part of the build process.
+
+Pre-rendered PDF version of the current "master" can be found at
+[User Manual](https://downloads.osmocom.org/docs/latest/osmosipconnector-usermanu…
+as well as the [VTY Reference Manual](https://downloads.osmocom.org/docs/latest/osmosipconnector-vty-refe…
+
+
+Mailing List
+------------
+
+Discussions related to osmo-sip-connector are happening on the
+openbsc(a)lists.osmocom.org mailing list, please see
+<https://lists.osmocom.org/mailman/listinfo/openbsc> for subscription
+options and the list archive.
+
+Please observe the [Osmocom Mailing List
+Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules)
+when posting.
+
+Contributing
+------------
+
+Our coding standards are described at
+<https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards>
+
+We us a gerrit based patch submission/review process for managing
+contributions. Please see
+<https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit> for
+more details
+
+The current patch queue for osmo-sip-connector can be seen at
+<https://gerrit.osmocom.org/#/q/project:osmo-sip-connector+status:open>
diff --git a/contrib/osmo-sip-connector.spec.in b/contrib/osmo-sip-connector.spec.in
index 29baf9b..58bba32 100644
--- a/contrib/osmo-sip-connector.spec.in
+++ b/contrib/osmo-sip-connector.spec.in
@@ -69,7 +69,7 @@
%files
%license COPYING
-%doc README.asciidoc
+%doc README.md
%doc %{_docdir}/%{name}/examples
%{_bindir}/osmo-sip-connector
%dir %{_sysconfdir}/osmocom
--
To view, visit https://gerrit.osmocom.org/c/osmo-sip-connector/+/28373
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-sip-connector
Gerrit-Branch: master
Gerrit-Change-Id: Ieadbbe4d2963e713d569460d053460f4f99d40eb
Gerrit-Change-Number: 28373
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: merged
pespin has submitted this change. ( https://gerrit.osmocom.org/c/osmo-sim-auth/+/28371 )
Change subject: update git URLs (git -> https; gitea)
......................................................................
update git URLs (git -> https; gitea)
Change-Id: Ie17ca69e9bc2ba0ab4afe8bc94673409093b61cb
---
M README.md
1 file changed, 2 insertions(+), 2 deletions(-)
Approvals:
pespin: Looks good to me, approved; Verified
diff --git a/README.md b/README.md
index 643c655..0a8b7d9 100644
--- a/README.md
+++ b/README.md
@@ -16,9 +16,9 @@
You can clone from the official osmo-sim-auth.git repository using
- git clone git://git.osmocom.org/osmo-sim-auth.git
+ git clone https://gitea.osmocom.org/sim-card/osmo-sim-auth
-There is a cgit interface at <http://git.osmocom.org/osmo-sim-auth/>
+There is a web interface at <https://gitea.osmocom.org/sim-card/osmo-sim-auth>
## Mailing List
--
To view, visit https://gerrit.osmocom.org/c/osmo-sim-auth/+/28371
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-sim-auth
Gerrit-Branch: master
Gerrit-Change-Id: Ie17ca69e9bc2ba0ab4afe8bc94673409093b61cb
Gerrit-Change-Number: 28371
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: merged