README: Major update
* convert to markdown syntax * bring in-line with other osmo-* README.md files, in terms of links to git, mailing list, manuals, etc. Change-Id: Ia4a4329c6ef6b8c833aa26832776dad662cdc7e9
This commit is contained in:
parent
e2b9b7ee57
commit
c230f0c283
17
README
17
README
|
@ -1,17 +0,0 @@
|
||||||
About OsmoSGSN
|
|
||||||
==============
|
|
||||||
|
|
||||||
OsmoSGSN originated from the OpenBSC project, as a separate program within
|
|
||||||
openbsc.git. In 2017, OpenBSC was split in separate repositories, and hence
|
|
||||||
OsmoSGSN was given its own separate git repository.
|
|
||||||
|
|
||||||
OsmoSGSN exposes
|
|
||||||
- GSUP towards OsmoHLR (or a MAP proxy);
|
|
||||||
- GTP towards a GGSN (e.g. OsmoGGSN);
|
|
||||||
- Gb towards a BSS (e.g. OsmoPCU);
|
|
||||||
- IuPS towards an RNC or HNB-GW (e.g. OsmoHNBGW) for 3G data;
|
|
||||||
- The Osmocom typical telnet VTY and CTRL interfaces.
|
|
||||||
|
|
||||||
Find OsmoSGSN issue tracker and wiki online at
|
|
||||||
https://osmocom.org/projects/osmosgsn
|
|
||||||
https://osmocom.org/projects/osmosgsn/wiki
|
|
|
@ -0,0 +1,81 @@
|
||||||
|
osmo-sgssn - Osmocom SGSN Implementation
|
||||||
|
========================================
|
||||||
|
|
||||||
|
This repository contains a C-language implementation of a GSM Serving GPRS
|
||||||
|
Support Node (SGSN) for 2G (GSM) and 3G (UMTS). It is part of the
|
||||||
|
[Osmocom](https://osmocom.org/) Open Source Mobile Communications
|
||||||
|
project.
|
||||||
|
|
||||||
|
OsmoSGSN exposes
|
||||||
|
* Gb towards PCUs (e.g. OsmoPCU): Various GbIP flavors + Gb/FR/E1
|
||||||
|
* GTP towards a GGSN (e.g. OsmoGGSN);
|
||||||
|
* IuPS over IP towards RNCs / HNBGW (e.g. osmo-hnbgw)
|
||||||
|
* The Osmocom typical telnet VTY and CTRL interfaces.
|
||||||
|
* The Osmocom typical statsd exporter.
|
||||||
|
* GSUP (custom MAP-like protocol) towards osmo-hlr
|
||||||
|
|
||||||
|
OsmoSGSN implements
|
||||||
|
* GPRS mobility management
|
||||||
|
* GPRS session management
|
||||||
|
|
||||||
|
Homepage
|
||||||
|
--------
|
||||||
|
|
||||||
|
You can find the OsmoSGSN issue tracker and wiki online at
|
||||||
|
<https://osmocom.org/projects/osmosgsn> and <https://osmocom.org/projects/osmosgsn/wiki>.
|
||||||
|
|
||||||
|
|
||||||
|
GIT Repository
|
||||||
|
--------------
|
||||||
|
|
||||||
|
You can clone from the official osmo-sgsn.git repository using
|
||||||
|
|
||||||
|
git clone https://gitea.osmocom.org/cellular-infrastructure/osmo-sgsn
|
||||||
|
|
||||||
|
There is a web interface at <https://gitea.osmocom.org/cellular-infrastructure/osmo-sgsn>
|
||||||
|
|
||||||
|
|
||||||
|
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://ftp.osmocom.org/docs/latest/osmosgsn-usermanual.pdf)
|
||||||
|
as well as the [VTY Reference Manual](https://ftp.osmocom.org/docs/latest/osmosgsn-vty-reference.pdf)
|
||||||
|
|
||||||
|
|
||||||
|
Mailing List
|
||||||
|
------------
|
||||||
|
|
||||||
|
Discussions related to osmo-sgsn are happening on the
|
||||||
|
osmocom-net-gprs@lists.osmocom.org mailing list, please see
|
||||||
|
<https://lists.osmocom.org/postorius/lists/osmocom-net-gprs.lists.osmocom.org/> 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-sgsn can be seen at
|
||||||
|
<https://gerrit.osmocom.org/#/q/project:osmo-sgsn+status:open>
|
||||||
|
|
||||||
|
|
||||||
|
History
|
||||||
|
-------
|
||||||
|
|
||||||
|
OsmoSGSN originated from the OpenBSC project, as a separate program within
|
||||||
|
openbsc.git. In 2017, OpenBSC was split in separate repositories, and hence
|
||||||
|
OsmoSGSN was given its own separate git repository.
|
|
@ -93,7 +93,7 @@ make %{?_smp_mflags}
|
||||||
make %{?_smp_mflags} check || (find . -name testsuite.log -exec cat {} +)
|
make %{?_smp_mflags} check || (find . -name testsuite.log -exec cat {} +)
|
||||||
|
|
||||||
%files
|
%files
|
||||||
%doc AUTHORS README
|
%doc AUTHORS README.md
|
||||||
%dir %{_docdir}/%{name}/examples
|
%dir %{_docdir}/%{name}/examples
|
||||||
%dir %{_docdir}/%{name}/examples/osmo-sgsn
|
%dir %{_docdir}/%{name}/examples/osmo-sgsn
|
||||||
%exclude %{_docdir}/%{name}/examples/osmo-gtphub
|
%exclude %{_docdir}/%{name}/examples/osmo-gtphub
|
||||||
|
|
Loading…
Reference in New Issue