Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s5uishida/docker_open5gs_volte_sms_config
VoLTE and SMS Configuration for docker_open5gs
https://github.com/s5uishida/docker_open5gs_volte_sms_config
docker fhoss ims kamailio open5gs osmohlr osmomsc raspberry-pi raspberry-pi-4 sgs sms volte
Last synced: about 1 month ago
JSON representation
VoLTE and SMS Configuration for docker_open5gs
- Host: GitHub
- URL: https://github.com/s5uishida/docker_open5gs_volte_sms_config
- Owner: s5uishida
- Created: 2022-02-27T14:22:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-03T02:46:24.000Z (12 months ago)
- Last Synced: 2024-09-28T10:20:12.616Z (about 2 months ago)
- Topics: docker, fhoss, ims, kamailio, open5gs, osmohlr, osmomsc, raspberry-pi, raspberry-pi-4, sgs, sms, volte
- Language: Dockerfile
- Homepage:
- Size: 183 KB
- Stars: 26
- Watchers: 3
- Forks: 17
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VoLTE and SMS Configuration for docker_open5gs
This briefly describes the settings for using **VoLTE** and **SMS** of [docker_open5gs](https://github.com/herlesupreeth/docker_open5gs).
---
### [Sample Configurations and Miscellaneous for Mobile Network](https://github.com/s5uishida/sample_config_misc_for_mobile_network)
## Table of Contents
- [Overview of Network Configuration](#overview)
- [Use open5gs_hss_cx branch of docker_open5gs](#branch_open5gs)
- [Changes in configuration files of docker_open5gs](#change_config)
- [Build docker image for Open5GS and Kamailio](#build)
- [Run docker-compose](#run)
- [Register subscribers information with Open5GS](#register_open5gs)
- [Register the IMSI and MSISDN with OsmoHLR](#register_osmocom)
- [Try VoLTE and SMS](#try)
- [Send SMS from OsmoMSC VTY terminal (SMS over SGs)](#osmomsc_send_command)
- [Use only SMS over IMS without using SMS over SGs](#use_only_ims)
- [Additional changes in configuration files of docker_open5gs](#add_change_config)
- [VoLTE and SMS with Raspberry Pi 4B](#rp4b)
- [Change how to create the docker image and container of MongoDB](#rp4b_mongodb)
- [Confirmed Version List](#ver_list)
- [Changelog (summary)](#changelog)
---
## Overview of Network Configuration
This describes the following setting example.
```
eNodeB Docker host - 172.22.0.0/24
+---------+ +-------------+
| | | |
| | | |
+---------+ +-------------+
| |
-------------------------------------------------------
.10 .20 192.168.0.0/24
```
For reference, the Docker host VM on VirtualBox I have tried is as follows:
| CPU Cores | Memory | SSD | OS |
| --- | --- | --- | --- |
| 2 | 4GB | 40GB | Ubuntu 22.04 |
For eNodeB, set static routing to eNodeB for packets going from eNodeB to the Docker host network (`172.22.0.0/24`).
```
# ip route add 172.22.0.0/24 via 192.168.0.20
```
If eNodeB does not have a static routing setting function, build a network so that the Docker host becomes the default GW.
The PDNs are as follows.
| PDN | TUNnel interface of PDN | APN | U-Plane # |
| --- | --- | --- | --- |
| 192.168.100.0/24 | ogstun | internet | U-Plane1 |
| 192.168.101.0/24 | ogstun2 | ims | U-Plane1 |
## Use open5gs_hss_cx branch of docker_open5gs
For **VoLTE** and **SMS over IMS** / **SMS over SGs**, it is convenient to use `open5gs_hss_cx` branch.
Kamailio's S-CSCF and I-CSCF communicate with Open5GS HSS(Cx).
**Note.** For **SMS over SGs** of docker_open5gs, 2G/3G radio access is not used at all rather it uses only the core network (MSC + SMSC + HLR).
```
# git clone https://github.com/herlesupreeth/docker_open5gs
# cd docker_open5gs
# git checkout open5gs_hss_cx
```
### Changes in configuration files of docker_open5gs
**.env)**
| Item | Value |
| --- | --- |
| MCC | 001 |
| MNC | 01 |
| DOCKER_HOST_IP | 192.168.0.20 |
| SGWU_ADVERTISE_IP | 192.168.0.20 |
**4g-volte-deploy.yaml)**
Publish the following ports of SGW-U and MME.
```diff
--- 4g-volte-deploy.yaml.orig 2023-08-07 10:58:37.018266553 +0000
+++ 4g-volte-deploy.yaml 2023-08-07 11:00:21.227760253 +0000
@@ -100,8 +100,8 @@
expose:
- "8805/udp"
- "2152/udp"
- # ports:
- # - "2152:2152/udp"
+ ports:
+ - "2152:2152/udp"
networks:
default:
ipv4_address: ${SGWU_IP}
@@ -127,7 +127,6 @@
- "5868/sctp"
- "8805/udp"
- "2123/udp"
- - "7777/tcp"
- "9091/tcp"
networks:
default:
@@ -187,8 +186,8 @@
- "36412/sctp"
- "2123/udp"
- "9091/tcp"
- # ports:
- # - "36412:36412/sctp"
+ ports:
+ - "36412:36412/sctp"
networks:
default:
ipv4_address: ${MME_IP}
```
**mme/mme.yaml)**
Change the following `tac` according to the TAC of eNodeB.
```
mme:
...
sgsap:
addr: OSMOMSC_IP
map:
tai:
plmn_id:
mcc: MCC
mnc: MNC
--> tac: 1
...
tai:
plmn_id:
mcc: MCC
mnc: MNC
--> tac: 1
...
```
### Build docker image for Open5GS and Kamailio
Please install the following first.
- [docker-ce](https://docs.docker.com/install/linux/docker-ce/ubuntu)
See [docker_open5gs](https://github.com/herlesupreeth/docker_open5gs) for build instructions.
```
# cd docker_open5gs/base
# docker build --no-cache --force-rm -t docker_open5gs .
...
# cd ../ims_base
# docker build --no-cache --force-rm -t docker_kamailio .
...
```
### Run docker-compose
For example, I prepare terminals for each of the following NF groups and execute them in order while checking the startup.
*terminal#1*
```
# set -a
# source .env
# docker compose -f 4g-volte-deploy.yaml up mongo mysql dns webui
```
*terminal#2*
```
# set -a
# source .env
# docker compose -f 4g-volte-deploy.yaml up osmohlr osmomsc
```
*terminal#3*
```
# set -a
# source .env
# docker compose -f 4g-volte-deploy.yaml up hss mme pcrf sgwc sgwu smf upf
```
*terminal#4*
```
# set -a
# source .env
# docker compose -f 4g-volte-deploy.yaml up rtpengine
```
*terminal#5*
```
# set -a
# source .env
# docker compose -f 4g-volte-deploy.yaml up icscf scscf pcscf smsc
```
### Register subscribers information with Open5GS
**Please also register MSISDN.** At that time, set the APN setting information as follows.
| APN | Type | QCI | ARP | Capability | Vulnerablility | MBR DL/UL(Kbps) | GBR DL/UL(Kbps) |
| --- | --- | --- | --- | --- | --- | --- | --- |
| internet | IPv4 | 9 | 8 | Disabled | Disabled | unlimited/unlimited | |
| ims | IPv4 | 5 | 1 | Disabled | Disabled | 3850/1530 | |
| | | 1 | 2 | Enabled | Enabled | 128/128 | 128/128 |
See below for details.
`18. Install Open5GS in the same machine as Kamailio IMS - Install Open5GS from source`
https://open5gs.org/open5gs/docs/tutorial/02-VoLTE-setup/
```
http://192.168.0.20:3000/
user: admin
password: 1423
```
### Register the IMSI and MSISDN with OsmoHLR
Please login to the `osmohlr` container and register by referring to the following.
`6.1 Example: Add/Update/Delete Subscriber via VTY`
https://downloads.osmocom.org/docs/latest/osmohlr-usermanual.pdf
The following is an example of registering subscriber information for IMSI=001010000001001 and MSISDN=1001.
First, login to the `osmohlr` container.
```
# docker exec -it osmohlr /bin/bash
```
Then telnet to localhost.
```
# telnet localhost 4258
...
OsmoHLR> enable
OsmoHLR#
```
Next, register the subscriber information for IMSI=001010000001001 and MSISDN=1001.
```
OsmoHLR# subscriber imsi 001010000001001 create
% Created subscriber 001010000001001
ID: 1
IMSI: 001010000001001
MSISDN: none
OsmoHLR# subscriber imsi 001010000001001 update msisdn 1001
% Updated subscriber IMSI='001010000001001' to MSISDN='1001'
OsmoHLR#
```
Make sure this subscriber information is registered.
```
OsmoHLR# show subscribers all
ID MSISDN IMSI IMEI NAM
----- ------------ ---------------- ---------------- -----
1 1001 001010000001001 ------------- CSPS
Subscribers Shown: 1
OsmoHLR#
```
This setting is required to function as **SMS over SGs**.
### Try VoLTE and SMS
Make sure that you can make a VoLTE call and SMS to the MSISDN. If your device does not support **SMS over IMS**, you can send SMS with **SMS over SGs** depending on your device.
**Note. To try SMS over SGs, there is a way to cause CS Fallback by not running the smsc container.**
### Send SMS from OsmoMSC VTY terminal (SMS over SGs)
You can send SMS to the destination terminal by command operation on the OsmoMSC VTY terminal (SMS over SGs).
Please login to the `osmomsc` container and send SMS from the command line as following.
`14 Configuring the Core Network`
`11.3.3 The list command`
https://downloads.osmocom.org/docs/latest/osmomsc-usermanual.pdf
**For example, if the following IMSI and MSISDN are registered in OsmoHLR)**
| IMSI | MSISDN | SIM |
| --- | --- | --- |
| 001010000001000 | 1000 | x |
| 001010000001001 | 1001 | o |
| 001010000001002 | 1002 | o |
First, login to the `osmomsc` container.
```
# docker exec -it osmomsc /bin/bash
```
Then telnet to localhost.
```
# telnet localhost 4254
...
OsmoMSC> enable
OsmoMSC#
```
- Command line to send SMS from MSISDN=1001 to MSISDN=1002 where the corresponding SIM exists
```
OsmoMSC# subscriber msisdn 1002 sms sender msisdn 1001 send TEST MESSAGE
```
- Command line to send SMS from MSISDN=1000 to MSISDN=1002 for which there is no corresponding SIM
```
OsmoMSC# subscriber msisdn 1002 sms sender msisdn 1000 send TEST MESSAGE
```
## Use only SMS over IMS without using SMS over SGs
It is also possible to configure only **SMS over IMS** without using **SMS over SGs**.
In this case, OsmoHLR and OsmoMSC are not required and the configuration is slightly simple.
### Additional changes in configuration files of docker_open5gs
Additional changes from the previously written configuration are as follows.
**4g-volte-deploy.yaml)**
Publish the following ports of SGW-U and MME, and delete MME's dependency on OsmoMSC.
```diff
--- 4g-volte-deploy.yaml.orig 2023-09-01 23:07:44.380709992 +0900
+++ 4g-volte-deploy.yaml 2023-09-01 23:09:48.911421833 +0900
@@ -100,8 +100,8 @@
expose:
- "8805/udp"
- "2152/udp"
- # ports:
- # - "2152:2152/udp"
+ ports:
+ - "2152:2152/udp"
networks:
default:
ipv4_address: ${SGWU_IP}
@@ -127,7 +127,6 @@
- "5868/sctp"
- "8805/udp"
- "2123/udp"
- - "7777/tcp"
- "9091/tcp"
networks:
default:
@@ -166,7 +165,6 @@
- sgwu
- smf
- upf
- - osmomsc
container_name: mme
env_file:
- .env
@@ -187,8 +185,8 @@
- "36412/sctp"
- "2123/udp"
- "9091/tcp"
- # ports:
- # - "36412:36412/sctp"
+ ports:
+ - "36412:36412/sctp"
networks:
default:
ipv4_address: ${MME_IP}
```
**mme/mme.yaml)**
Delete the SGsAP section.
```diff
--- mme.yaml.orig 2023-09-01 23:07:34.417698185 +0900
+++ mme.yaml 2023-09-01 23:10:34.248245114 +0900
@@ -9,19 +9,6 @@
dev: MME_IF
gtpc:
dev: MME_IF
- sgsap:
- addr: OSMOMSC_IP
- map:
- tai:
- plmn_id:
- mcc: MCC
- mnc: MNC
- tac: 1
- lai:
- plmn_id:
- mcc: MCC
- mnc: MNC
- lac: 1
gummei:
plmn_id:
mcc: MCC
```
And change the following tac according to the TAC of eNodeB.
```
mme:
...
tai:
plmn_id:
mcc: MCC
mnc: MNC
--> tac: 1
...
```
From here on, follow the same steps as before. Also, the `osmohlr` and `osmomsc` containers do not need to be started. And there is no need to register the IMSI and MSISDN with OsmoHLR.
## VoLTE and SMS with Raspberry Pi 4B
When you try VoLTE and SMS with Raspberry Pi 4B,
as shown [here](https://github.com/s5uishida/install_mongodb_on_ubuntu_for_rp4b), there is a limit to the version of MongoDB that can be installed on the Raspberry Pi 4B.
So make the necessary changes on docker_open5gs for this.
### Change how to create the docker image and container of MongoDB
First, clone this repository.
```
# git clone https://github.com/s5uishida/docker_open5gs_volte_sms_config
```
Copy the `mongo_for_rp4` directory from this repository as the `mongo` directory in the `open5gs_hss_cx` branch of docker_open5gs.
```
# cp -pr docker_open5gs_volte_sms_config/mongo_for_rp4 docker_open5gs/mongo
```
Then, for `4g-volte-deploy.yaml`, in addition to [this change](https://github.com/s5uishida/docker_open5gs_volte_sms_config#changes-in-configuration-files-of-docker_open5gs), change as follows.
```diff
--- 4g-volte-deploy.yaml.orig 2023-08-07 10:58:37.018266553 +0000
+++ 4g-volte-deploy.yaml 2023-08-07 11:18:47.865735359 +0000
@@ -1,14 +1,14 @@
version: '3'
services:
mongo:
- image: mongo:6.0
+ build: ./mongo
+ image: docker_mongo
container_name: mongo
- command: --bind_ip 0.0.0.0
+ command: /bin/sh -c 'mongod --dbpath /data/db --logpath /data/log/mongodb.log --bind_ip 0.0.0.0'
env_file:
- .env
volumes:
- - mongodbdata:/data/db
- - mongodbdata:/data/configdb
+ - ./mongo/data:/data
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
expose:
@@ -434,5 +433,4 @@
config:
- subnet: ${TEST_NETWORK}
volumes:
- mongodbdata: {}
dbdata: {}
```
After this, the configuration and build are the same as above.
I haven't confirmed the operation, but it is probably able to use VoLTE and SMS with Raspberry Pi 4B.
---
[docker_open5gs](https://github.com/herlesupreeth/docker_open5gs) is a excellent software to try **VoLTE** and **SMS** easily. I would like to thank all the software developers and contributors related.
## Confirmed Version List
The system versions when I confirmed the operation of VoLTE and SMS in the `open5gs_hss_cx` branch of my environment are as follows.
| docker_open5gs | Open5GS |
| -- | -- |
| `commit:76206df07ea1571640b71fa25f28cb3ce4265aff`
on 2023.08.22 | v2.6.4+
`commit:7f088730ed4bedc12f562e53de44697d5e1f5c6e`
on 2023.08.20 |
## Changelog (summary)
- [2023.09.01] Added the configuration to use only **SMS over IMS** without using **SMS over SGs**.
- [2023.08.31] Deleted the issue section and added a list of confirmed versions. Kamailio's SMSC can now send and receive multi-byte characters without garbled characters.
- [2023.08.09] Added an issue in my environment.
- [2023.08.07] Changed the settings for only using `open5gs_hss_cx` branch.
- [2023.08.05] Added the settings to use VoLTE and SMS with Raspberry Pi 4B. However, there is no confirmation of operation.
- [2022.04.11] Open5GS HSS Cx interface now supports the settings related to SMSC application server.
- [2022.02.27] Initial release.