Skip to content

Latest commit

 

History

History
147 lines (100 loc) · 7.65 KB

File metadata and controls

147 lines (100 loc) · 7.65 KB

NMS Prime Logo hosted by CableLabs Logo


Open in Visual Studio Code Crowdin StyleCI

NMS Prime — Community Edition

NMS PRIME is a modular CRM, BSS, and OSS platform for telcos and ISPs — built from ISPs, for ISPs. Run your core stack yourself, on premises or in the cloud, and keep full control over provisioning, billing, customer care, and operations in one extensible system.

The Community Edition in this repository delivers the complete OSS Provisioning layer: technology- and vendor-agnostic service activation and CPE management for DOCSIS, FTTH, FTTx, DSL, WiFi, and other access technologies. Extend the platform with enterprise modules for CRM, billing, ticketing, monitoring, and more — or build your own apps on top of the open-source core.

NMS Prime Application Marketplace

📱 Community Edition — OSS Provisioning

📡 Provisioning — full OSS layer for any access technology
📞 VoIP Provisioning
🎛️ Control & SNMP — network element management
🏢 Enterprise modules — CRM, BSS, billing, workforce & more → nmsprime.com

⚡ OSS Provisioning Capabilities

Access-Agnostic Activation
📶 DOCSIS 1.0, 1.1, 2.0, 3.0, 3.1
🏠 FTTH, DSL, and WiFi via TR-069 and RADIUS
🌐 Dual-stack IPv4 / IPv6

Network & Service Operations
🖧 CMTS, Router, OLT, and Switch Management via SNMP or TR-069
📡 Cable ingress detection
🗺️ Real-time topographic maps and entity relation diagrams
⚙️ Integrated Icinga2, Prometheus, Grafana, and Cacti
🎫 Ticket System
🛠️ Generic SNMP GUI creator
📚 Full documentation

📖 Explore the complete platform — CRM, billing, provisioning, monitoring, and more — at nmsprime.com and in the Official Documentation.

📺 YouTube Channel

🎬 Tutorials & demos — provisioning, OSS workflows, and platform walkthroughs
🚀 Feature deep dives — DOCSIS, FTTH, SNMP, billing, and more
📡 SubscribeNMS Prime on YouTube

🏗️ Architectural Concepts

NMS Prime is built on the Laravel framework with PHP 8 and a modern, responsive Bootstrap front end. The OSS layer integrates proven open-source infrastructure — not proprietary black boxes — so operators retain full control over their stack.

It is tested and developed under Rocky 9 (RHEL 9).

NMS Prime is built with standard Linux tools, like

🔌 ISC DHCP for IPv4
🌍 Kea for IPv6
📇 BIND
🐘 PostgreSQL
🔔 Icinga2
🔍 Prometheus
📊 Grafana
📈 Cacti

These tools are actively developed, approved and used. See Design Architecture for more information.

📦 Installation

🐧 Community Version

From RPM for Rocky 9 (RHEL 9)

curl -vsL https://github.com/cablelabs/os-provisioning/raw/dev/scripts/INSTALL-REPO.sh | bash
yum install nmsprime-*

🏢 Enterprise Platform

The full NMS Prime platform adds CRM, BSS, billing, dunning, workforce management, and further modules on top of the OSS core. Select your applications and run them in the Cloud or On-Prem: Enterprise Installation

👨‍💻 Developers only (source-code installation)

In order to track and install all NMS Prime dependencies, the workflow for getting a source code installation up and running starts like described above. You can use both variants (community or enterprise) to do so.

Afterwards the NMS Prime RPM packages are replaced with the GIT repository by issuing the following commands:

for module in $(rpm -qa "nmsprime-*" | grep -v '^nmsprime-repos'); do rpm -e --justdb --noscripts --nodeps "$module"; done

yum install git npm

php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php --install-dir=/usr/local/bin --filename=composer

cd /var/www
git clone https://github.com/cablelabs/os-provisioning nmsprimeGit
mv nmsprimeGit/.git/ nmsprime/
rm -rf nmsprimeGit/
cd nmsprime

git checkout -- .
git clean -f -x

# move enterprise apps into /root folder for reference, they are not needed for the community git version
for module in $(ls -1 modules | grep -v '^HfcReq$\|^HfcSnmp$\|^NmsMail$\|^ProvBase$\|^ProvVoip$'); do mv "$module" /root/; done

composer update
php artisan module:v6:migrate
find public/{css,js} -iname "*.br" -o -iname "*.gz"
rm -f public/mix-manifest.json
npm i && npm run dev

yum install $(for file in $(find /var/www/nmsprime -name config.cfg); do grep '^depends[[:space:]]*=' "$file" | cut -d'=' -f2- | cut -d'"' -f2; done | tr ';' '\n' | sed -e '/^$/d' -e '/^nmsprime-/d' | sort -u)

php artisan migrate
php artisan module:migrate --all
php artisan module:publish --all
php artisan bouncer:clean
php artisan nms:auth
php artisan optimize
systemctl restart supervisord

🤝 Contributors

📝 How to contribute

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

🧩 Write your own Application

If you want to develop your own open-source or proprietary application(s), please refer to Write your own Application

📖 History & Motivation

NMS Prime started as a German ISP initiative with a clear goal: a technology- and vendor-agnostic OSS/BSS reference platform that puts operators back in control of their core systems — from provisioning across DOCSIS, FTTH, and WiFi to the broader CRM and billing stack telcos need to grow profitably. Join the community and help shape the future of ISP software.

🗺️ Roadmap

See Upcoming Developments

⚖️ License

This project is licensed under the Apache-2.0 file for details. For more information: License Article