From 27b3bec1699bb4cd6cc03dbe41c2c4bcdfc2465e Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Mon, 30 Mar 2020 22:21:02 +0200 Subject: [PATCH] various documentation improvements (#396) * FAQ: improve Language of the FAQ * FAQ: elaborate bit more on commercial support; change contact address * docs: Esnure mongodb is started at system boot * docs: Language improvements + spelling fixes * docs: If we use --prefix=`pwd`/install, the configs are not in /etc * docs: Further clarifications Co-authored-by: Harald Welte --- .../guide/02-building-open5gs-from-sources.md | 32 +++++++++++-------- docs/_pages/faq.md | 14 +++++--- 2 files changed, 28 insertions(+), 18 deletions(-) diff --git a/docs/_docs/guide/02-building-open5gs-from-sources.md b/docs/_docs/guide/02-building-open5gs-from-sources.md index e72063d6d..153f355e6 100644 --- a/docs/_docs/guide/02-building-open5gs-from-sources.md +++ b/docs/_docs/guide/02-building-open5gs-from-sources.md @@ -9,15 +9,16 @@ This post explains how to compile and install the source code on **Debian/Ubuntu ### Getting MongoDB --- -Install MongoDB with package manager. +Install MongoDB with package manager. It is used as database for the HSS and PCRF. ```bash $ sudo apt update $ sudo apt install mongodb $ sudo systemctl start mongodb (if '/usr/bin/mongod' is not running) +$ sudo systemctl enable mongodb (ensure to automatically start it on system boot) ``` -### Setting up TUN device (No persistent after rebooting) +### Setting up TUN device (not persistent after rebooting) --- Create the TUN device with the interface name `ogstun`. @@ -36,7 +37,7 @@ $ sudo ip link set ogstun up ### Building Open5GS --- -Install the depedencies for building the source code. +Install the dependencies for building the source code. ```bash $ sudo apt install python3-pip python3-setuptools python3-wheel ninja-build build-essential flex bison git libsctp-dev libgnutls28-dev libgcrypt-dev libssl-dev libidn11-dev libmongoc-dev libbson-dev libyaml-dev @@ -79,7 +80,12 @@ $ ninja install ### Configure Open5GS --- -Modify [/etc/open5gs/mme.yaml](https://github.com/{{ site.github_username }}/open5gs/blob/master/configs/open5gs/mme.yaml.in) to set the S1AP/GTP-C IP address, PLMN ID, and TAC +Modify [install/etc/open5gs/mme.yaml](https://github.com/{{ site.github_username }}/open5gs/blob/master/configs/open5gs/mme.yaml.in) to set the S1AP/GTP-C IP address, PLMN ID, and TAC. + +In the below example we + +- use MCC-MNC of 901-70, as this is the home network of the default IMSIs of the sysmoUSIM-SJS1 cards. +- use 192.168.0.100 for the S1AP +GTP-U connection of MME/SGW to the eNB ```diff diff -u /etc/open5gs/mme.yaml.old /etc/open5gs/mme.yaml @@ -113,7 +119,7 @@ diff -u /etc/open5gs/mme.yaml.old /etc/open5gs/mme.yaml ciphering_order : [ EEA0, EEA1, EEA2 ] ``` -Modify [/etc/open5gs/sgw.yaml](https://github.com/{{ site.github_username }}/open5gs/blob/master/configs/open5gs/sgw.yaml.in) to set the GTP-U IP address. +Modify [install/etc/open5gs/sgw.yaml](https://github.com/{{ site.github_username }}/open5gs/blob/master/configs/open5gs/sgw.yaml.in) to set the GTP-U IP address. ```diff diff -u /etc/open5gs/sgw.yaml.old /etc/open5gs/sgw.yaml --- sgw.yaml.old 2018-04-15 18:30:25.000000000 +0900 @@ -125,7 +131,7 @@ diff -u /etc/open5gs/sgw.yaml.old /etc/open5gs/sgw.yaml + addr: 192.168.0.100 ``` -After changing conf files, please restart Open5GS daemons. +If you modify the config files while Open5GS daemons are running, please restart them ### Running Open5GS @@ -198,7 +204,7 @@ Options: ``` -### Building WebUI of Open5GS +### Building the WebUI of Open5GS --- [Node.js](https://nodejs.org/) is required to build WebUI of Open5GS @@ -241,16 +247,16 @@ To add subscriber information, you can do WebUI operations in the following orde 3. Fill the IMSI, security context(K, OPc, AMF), and APN of the subscriber. 4. Click `SAVE` Button -**Tip:** This addition immediately affects Open5GS without restaring any daemon. +**Tip:** This addition immediately affects Open5GS without restarting any daemon. {: .notice--warning} -### Adding a route for UE to have internet connectivity +### IP routing + NAT for UE internet connectivity --- -If your phone can connect to internet, you must run the following command in Open5GS-PGW installed host. +To allow your phones to connect to the internet, you must run the following command on the host running Open5GS-PGW: ```bash -### Check IP Tables +### Check IP Table 'forward' $ sudo iptables -L Chain INPUT (policy ACCEPT) target prot opt source destination @@ -261,7 +267,7 @@ target prot opt source destination Chain OUTPUT (policy ACCEPT) target prot opt source destination -### Check NAT Tables +### Check IP Table 'nat' $ sudo iptables -L -t nat Chain PREROUTING (policy ACCEPT) target prot opt source destination @@ -282,7 +288,7 @@ $ sudo sh -c "echo 1 > /proc/sys/net/ipv4/ip_forward" $ sudo iptables -t nat -A POSTROUTING -s 10.45.0.0/16 ! -o ogstun -j MASQUERADE ``` -**Note:** It is a good condition if you do not have any rules in the IP/NAT tables. If a program such as docker has already set up a rule, you will need to add a rule differently. +**Note:** The above assumes you do not have any existing rules in the filter and nat tables. If a program such as docker has already set up rules, you may need to add the Open5GS related rules differently. {: .notice--danger} ### Turn on your eNodeB and Phone diff --git a/docs/_pages/faq.md b/docs/_pages/faq.md index 199a70d02..0a4a44512 100644 --- a/docs/_pages/faq.md +++ b/docs/_pages/faq.md @@ -4,14 +4,18 @@ title: FAQ permalink: /faq/ --- -#### What is Open5GS License? +#### What are the Open5GS license terms? -AGPL-3.0 (No Dual-License) +Open5GS is licensed under the GNU Affero General Public License (AGPL), Version 3.0. +There is no dual-licensing; open5gs is not available under any other license terms. -#### Is there any companies for provide commercial support for Open5GS? +#### Aer there any companies providing commercial support for Open5GS? -Sysmocom provides commercial support. Contact to [Harald Welte \](mailto:hwelte@sysmocom.de) +[sysmocom](https://sysmocom.de/) is providing commercial services around Open5GS, +including support, development, consulting, training and system integration. -#### Is there any success story with installation Open5GS? +Please contact [Harald Welte \](mailto:sales@sysmocom.de) for any related inquiries. + +#### Are there any success stories about Open5GS deployments? See [https://github.com/open5gs/open5gs/issues/360](https://github.com/open5gs/open5gs/issues/360)