{"id":18878003,"url":"https://github.com/voicenterteam/openimss","last_synced_at":"2025-04-14T18:32:01.900Z","repository":{"id":167595858,"uuid":"643221728","full_name":"VoicenterTeam/openimss","owner":"VoicenterTeam","description":"OpenIMSs open source environment for real life development of IMS based 4G/5G/NR voice/video/data/RCS/IM services","archived":false,"fork":false,"pushed_at":"2023-10-31T13:39:29.000Z","size":5327,"stargazers_count":22,"open_issues_count":6,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T07:11:36.845Z","etag":null,"topics":["4g","5g","enb","epc","gnb","homer","ims","lte","nr","open5gs","opensips","qryn","rcs","sip","srsran","vilte","voip","volte","vonr"],"latest_commit_sha":null,"homepage":"https://www.openimss.org","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VoicenterTeam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-20T13:31:56.000Z","updated_at":"2025-01-11T15:46:23.000Z","dependencies_parsed_at":"2024-11-08T06:37:04.914Z","dependency_job_id":null,"html_url":"https://github.com/VoicenterTeam/openimss","commit_stats":null,"previous_names":["voicenterteam/openimss"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VoicenterTeam%2Fopenimss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VoicenterTeam%2Fopenimss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VoicenterTeam%2Fopenimss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VoicenterTeam%2Fopenimss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VoicenterTeam","download_url":"https://codeload.github.com/VoicenterTeam/openimss/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248936810,"owners_count":21186110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["4g","5g","enb","epc","gnb","homer","ims","lte","nr","open5gs","opensips","qryn","rcs","sip","srsran","vilte","voip","volte","vonr"],"created_at":"2024-11-08T06:23:29.636Z","updated_at":"2025-04-14T18:31:59.386Z","avatar_url":"https://github.com/VoicenterTeam.png","language":"Shell","readme":"# OpenIMSs \nA community effort to bring up a comprehensive open source environment for real life development of IMS based 4G/5G/NR voice/video/data/RCS/IM services.\n\nWe started from https://github.com/herlesupreeth/docker_open5gs , and begin to generalize and expand from it\n\nStatus:\n- Open5GS EPC \n- SRSRan 4G/LTE Radio Access \n- implementation of IMS CSCFs in OpenSIPS \n- qryn monitoring metrics telemethry \n- portainer \n- graphana\n- coroot\n\n## Tested Setup\n\nDocker host machine\n\n- Ubuntu 22.04\n\nSDRs tested with srsLTE eNB\n\n- Ettus USRP B210 or Chinese compatible 😉\n\n## Build and Execution Instructions\n\n* Mandatory requirements:\n\t* [docker-ce](https://docs.docker.com/install/linux/docker-ce/ubuntu)\n\t* [docker-compose](https://docs.docker.com/compose)\n\n\n\n\n```\ngit clone https://github.com/VoicenterTeam/openimss.git\ncd openimss/base\ndocker build --no-cache --force-rm -t docker_openimss_open5gs .\n\ncd ../ims_base\ndocker build --no-cache --force-rm -t docker_openimss_opensips .\n\ncd ../srslte\ndocker build --no-cache --force-rm -t docker_openimss_srslte .\n\ncd ../ueransim\ndocker build --no-cache --force-rm -t docker_openimss_ueransim .\n```\n\n### Build and Run using docker-compose\n\n```\ncd ..\nset -a\nsource .env\ndocker-compose build --no-cache\ndocker-compose up\n\n# srsRAN eNB\ndocker-compose -f srsenb.yaml up -d \u0026\u0026 docker attach srsenb\n# srsRAN gNB\ndocker-compose -f srsgnb.yaml up -d \u0026\u0026 docker attach srsgnb\n# srsRAN ZMQ based setup\n    # eNB\n    docker-compose -f srsenb_zmq.yaml up -d \u0026\u0026 docker attach srsenb_zmq\n    # gNB\n    docker-compose -f srsgnb_zmq.yaml up -d \u0026\u0026 docker attach srsgnb_zmq\n    # 4G UE\n    docker-compose -f srsue_zmq.yaml up -d \u0026\u0026 docker attach srsue_zmq\n    # 5G UE\n    docker-compose -f srsue_5g_zmq.yaml up -d \u0026\u0026 docker attach srsue_5g_zmq\n\n# UERANSIM gNB\ndocker-compose -f nr-gnb.yaml up -d \u0026\u0026 docker attach nr_gnb\n\n# UERANSIM NR-UE\ndocker-compose -f nr-ue.yaml up -d \u0026\u0026 docker attach nr_ue\n```\n\n## Configuration\n\nFor the quick run (eNB/gNB, CN in same docker network), edit only the following parameters in .env as per your setup\n\n```\nMCC\nMNC\nTEST_NETWORK --\u003e Change this only if it clashes with the internal network at your home/office\nDOCKER_HOST_IP --\u003e This is the IP address of the host running your docker setup\nSGWU_ADVERTISE_IP --\u003e Change this to value of DOCKER_HOST_IP set above only if eNB/gNB is not running the same docker network/host\nUPF_ADVERTISE_IP --\u003e Change this to value of DOCKER_HOST_IP set above only if eNB/gNB is not running the same docker network/host\n```\n\nIf eNB/gNB is NOT running in the same docker network/host as the host running the dockerized Core/IMS then follow the below additional steps\n\nUnder mme section in docker compose file (docker-compose.yaml, nsa-deploy.yaml), uncomment the following part\n```\n...\n    # ports:\n    #   - \"36412:36412/sctp\"\n...\n```\n\nUnder amf section in docker compose file (docker-compose.yaml, nsa-deploy.yaml, sa-deploy.yaml), uncomment the following part\n```\n...\n    # ports:\n    #   - \"38412:38412/sctp\"\n...\n```\n\nIf deploying in SA mode only (sa-deploy.yaml), then uncomment the following part under upf section\n```\n...\n    # ports:\n    #   - \"2152:2152/udp\"\n...\n```\n\nIf deploying in NSA mode only (nsa-deploy.yaml, docker-compose.yaml), then uncomment the following part under sgwu section\n```\n...\n    # ports:\n    #   - \"2152:2152/udp\"\n...\n```\n\n## Register a UE information\n\nOpen (http://\u003cDOCKER_HOST_IP\u003e:3000) in a web browser, where \u003cDOCKER_HOST_IP\u003e is the IP of the machine/VM running the open5gs containers. Login with following credentials\n```\nUsername : admin\nPassword : 1423\n```\n\nUsing Web UI, add a subscriber\n\n## srsLTE eNB settings\n\nIf SGWU_ADVERTISE_IP is properly set to the host running the SGWU container in NSA deployment, then the following static route is not required.\nOn the eNB, make sure to have the static route to SGWU container (since internal IP of the SGWU container is advertised in S1AP messages and UE wont find the core in Uplink)\n\n```\n# NSA - 4G5G Hybrid deployment\nip r add \u003cSGWU_CONTAINER_IP\u003e via \u003cSGWU_ADVERTISE_IP\u003e\n```\n\n## Not supported\n- IPv6 usage in Docker\n\n## Ta-daaa\n\u003cpre\u003e\n~/openimss (master) # docker ps\nCONTAINER ID   IMAGE                                      COMMAND                  CREATED         STATUS                   PORTS                                                                                                                          NAMES\n215bb6200149   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             2123/udp, 3868/sctp, 3868/tcp, 3868/udp, 5868/tcp, 5868/sctp, 5868/udp, 36412/sctp, 9091/tcp                                   mme\na0cab0060ee9   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             2123/udp, 8805/udp                                                                                                             sgwc\n8f057a5febe0   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             2152/udp, 8805/udp                                                                                                             sgwu\nbe53d5adaf23   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             2152/udp, 8805/udp, 9091/tcp                                                                                                   upf\n6e4d93f13983   docker_openimss_opensips                   \"/bin/bash -c ./star…\"   5 minutes ago   Up 5 minutes             3871/tcp, 3871/udp, 5060/tcp, 5060/udp, 5100-5120/tcp, 5100-5120/udp, 6100-6120/tcp, 8080/tcp, 6100-6120/udp                   pcscf\n9a644e5f2de0   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             2123/udp, 3868/sctp, 3868/tcp, 3868/udp, 5868/tcp, 5868/udp, 7777/tcp, 8805/udp, 5868/sctp, 9091/tcp                           smf\n0ba9d91f46f1   docker_openimss_opensips                   \"/bin/bash -c ./star…\"   5 minutes ago   Up 5 minutes             3869/tcp, 3869/udp, 4060/tcp, 8080/tcp, 4060/udp                                                                               icscf\n81763a3141e6   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             7777/tcp, 9091/tcp, 38412/sctp                                                                                                 amf\n593a93826ee0   timberio/vector:latest-alpine              \"/usr/local/bin/vect…\"   5 minutes ago   Up 5 minutes                                                                                                                                            vector_logs\ndb47f463c3f3   sipcapture/heplify-server                  \"./heplify-server\"       5 minutes ago   Up 5 minutes             9090/tcp, 0.0.0.0:9060-9061-\u003e9060-9061/tcp, 0.0.0.0:9060-\u003e9060/udp, :::9060-9061-\u003e9060-9061/tcp, :::9060-\u003e9060/udp, 9096/tcp   heplify-server\neffabab912d1   timberio/vector:latest-alpine              \"/usr/local/bin/vect…\"   5 minutes ago   Up 5 minutes                                                                                                                                            vector\n3ea4c8cd33a4   docker_openimss_fhoss                      \"/bin/sh -c /mnt/fho…\"   5 minutes ago   Up 5 minutes             3868/tcp, 3868/udp, 0.0.0.0:8080-\u003e8080/tcp, :::8080-\u003e8080/tcp                                                                  fhoss\nb63d0d547968   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             7777/tcp                                                                                                                       bsf\nec3749c08add   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             7777/tcp, 9091/tcp                                                                                                             pcf\n645c01d56b32   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             7777/tcp                                                                                                                       ausf\ne588b76710f2   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             7777/tcp                                                                                                                       udm\n65923334962a   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             7777/tcp                                                                                                                       nssf\naef322972ad7   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             7777/tcp                                                                                                                       udr\n4cb9027cbab7   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             3868/sctp, 3868/tcp, 3868/udp, 5868/sctp, 5868/tcp, 5868/udp                                                                   hss\n39004a28aa34   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             3868/sctp, 3868/tcp, 3868/udp, 5868/sctp, 5868/tcp, 5868/udp                                                                   pcrf\n8d84f59f20a0   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             0.0.0.0:3000-\u003e3000/tcp, :::3000-\u003e3000/tcp                                                                                      webui\n17e909a22b89   timberio/vector:latest-alpine              \"/usr/local/bin/vect…\"   5 minutes ago   Up 5 minutes                                                                                                                                            vector-coroot\nd4ec0c185e29   docker_openimss_osmomsc                    \"/bin/sh -c '/mnt/os…\"   5 minutes ago   Up 5 minutes             2775/tcp, 29118/sctp                                                                                                           osmomsc\n458a787106cf   grafana/grafana-oss:latest                 \"/run.sh\"                5 minutes ago   Up 5 minutes             0.0.0.0:9080-\u003e3000/tcp, :::9080-\u003e3000/tcp                                                                                      grafana\neab34b76e65b   qxip/qryn:latest                           \"docker-entrypoint.s…\"   5 minutes ago   Up 5 minutes             0.0.0.0:3100-\u003e3100/tcp, :::3100-\u003e3100/tcp                                                                                      qryn\n1e0b3bddba04   docker_openimss_mongo                      \"/bin/sh -c /mnt/mon…\"   5 minutes ago   Up 5 minutes             27017/tcp, 27017/udp                                                                                                           mongo\n77003e897f85   ghcr.io/coroot/coroot                      \"/opt/coroot/coroot\"     5 minutes ago   Up 5 minutes             0.0.0.0:8013-\u003e8080/tcp, :::8013-\u003e8080/tcp                                                                                      coroot\n985d0b119222   docker_openimss_mysql                      \"/bin/sh -c /mysql_i…\"   5 minutes ago   Up 5 minutes             3306/tcp                                                                                                                       mysql\nf7d4e0e4a968   clickhouse/clickhouse-server:22.8-alpine   \"/entrypoint.sh\"         5 minutes ago   Up 5 minutes (healthy)   9000/tcp, 0.0.0.0:8123-\u003e8123/tcp, :::8123-\u003e8123/tcp, 9009/tcp                                                                  clickhouse-serv\ner\n2133a1f57a52   ghcr.io/coroot/coroot-node-agent           \"coroot-node-agent -…\"   5 minutes ago   Up 5 minutes             80/tcp                                                                                                                         exporter\n49ea9dd767fa   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             7777/tcp                                                                                                                       scp\nc260a4a8a053   portainer/portainer-ce:latest              \"/portainer\"             5 minutes ago   Up 5 minutes             0.0.0.0:8000-\u003e8000/tcp, :::8000-\u003e8000/tcp, 0.0.0.0:9443-\u003e9443/tcp, :::9443-\u003e9443/tcp, 9000/tcp                                 portainer\n5868a53cc66e   docker_openimss_osmohlr                    \"/bin/sh -c '/mnt/os…\"   5 minutes ago   Up 5 minutes             4222/tcp                                                                                                                       osmohlr\n48efb254ba8e   docker_openimss_dns                        \"/bin/sh -c '/mnt/dn…\"   5 minutes ago   Up 5 minutes             53/udp                                                                                                                         dns\nc7665137d42c   docker_openimss_rtpengine                  \"/bin/sh -c /mnt/rtp…\"   5 minutes ago   Up 5 minutes             2223/udp, 49000-50000/udp                                                                                                      rtpengine\n09bd99f2a02b   docker_openimss_open5gs                    \"/bin/sh -c /open5gs…\"   5 minutes ago   Up 5 minutes             7777/tcp                                                                                                                       nrf\n5e0a05b79569   docker_openimss_metrics                    \"/bin/sh -c /mnt/met…\"   5 minutes ago   Up 5 minutes             0.0.0.0:9090-\u003e9090/tcp, :::9090-\u003e9090/tcp                                                                                      metrics\n\n\n\n~/openimss (master) # docker-compose -f srsenb.yaml up -d \u0026\u0026 docker attach srsenb\nWARNING: Found orphan containers (scscf, clickhouse-server, mysql, portainer, fhoss, hss, sgwc, rtpengine, dns, icscf, bsf, qryn, exporter, nssf, coroot, osmomsc, udm, osmohlr, smf, pcscf, mme, sgwu, heplify-server, ausf, pcrf, webui, vector-coroot, mongo, vector, v\nector_logs, scp, upf, nrf, amf, grafana, metrics, pcf, udr) for this project. If you removed or renamed this service in your compose file, you can run this command with the --remove-orphans flag to clean it up.\nStarting srsenb ... done\n\nBuilt in Release mode using commit 10f81ca03 on branch lc/main.\n\nOpening 1 channels in RF device=default with args=default\nSupported RF device list: UHD soapy zmq lime file\nTrying to open RF device 'UHD'\n[INFO] [UHD] linux; GNU C++ version 9.4.0; Boost_107100; UHD_4.4.0.0-0ubuntu1~focal1\n[INFO] [LOGGING] Fastpath logging disabled at runtime.\n[INFO] [B200] Loading firmware image: /usr/share/uhd/images/usrp_b200_fw.hex...\nOpening USRP channels=1, args: type=b200,master_clock_rate=23.04e6\n[INFO] [UHD RF] RF UHD Generic instance constructed\n[INFO] [B200] Detected Device: B210\n[INFO] [B200] Loading FPGA image: /usr/share/uhd/images/usrp_b210_fpga.bin...\n[INFO] [B200] Operating over USB 3.\n[INFO] [B200] Detecting internal GPSDO.... \n[INFO] [GPS] No GPSDO found\n[INFO] [B200] Initialize CODEC control...\n[INFO] [B200] Initialize Radio control...\n[INFO] [B200] Performing register loopback test... \n[INFO] [B200] Register loopback test passed\n[INFO] [B200] Performing register loopback test... \n[INFO] [B200] Register loopback test passed\n[INFO] [B200] Asking for clock rate 23.040000 MHz... \n[INFO] [B200] Actually got clock rate 23.040000 MHz.\nRF device 'UHD' successfully opened\n\n==== eNodeB started ===\nType \u003ct\u003e to view trace\nSetting frequency: DL=2660.0 Mhz, UL=2540.0 MHz for cc_idx=0 nof_prb=50\n[INFO] [UHD RF] Tx while waiting for EOB, timed out... 14.8769 \u003e= 0. Starting new burst...\n\n\u003c/pre\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoicenterteam%2Fopenimss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoicenterteam%2Fopenimss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoicenterteam%2Fopenimss/lists"}