https://github.com/cablelabs/os-provisioning
Open Source Network Provisioning Tool and Network Management Platform for DOCSIS, FTTH, FTTx, DSL, and WiFi
https://github.com/cablelabs/os-provisioning
cable cablelabs cmts docsis ftth nmsprime olt onu oss provisioning telecom telecommunications
Last synced: about 1 month ago
JSON representation
Open Source Network Provisioning Tool and Network Management Platform for DOCSIS, FTTH, FTTx, DSL, and WiFi
- Host: GitHub
- URL: https://github.com/cablelabs/os-provisioning
- Owner: cablelabs
- License: apache-2.0
- Created: 2021-04-30T17:10:12.000Z (almost 5 years ago)
- Default Branch: dev
- Last Pushed: 2024-02-16T12:19:02.000Z (about 2 years ago)
- Last Synced: 2024-07-30T20:04:49.398Z (over 1 year ago)
- Topics: cable, cablelabs, cmts, docsis, ftth, nmsprime, olt, onu, oss, provisioning, telecom, telecommunications
- Language: PHP
- Homepage: https://nmsprime.com
- Size: 91.1 MB
- Stars: 56
- Watchers: 18
- Forks: 25
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
hosted by
[](https://github.dev/cablelabs/os-provisioning)
[](https://crowdin.com/project/nmsprime)
[](https://github.styleci.io/repos/109520753)
# OS Provisioning Community Version
[NMS PRIME](https://nmsprime.com) is an Open Source Network **Provisioning Tool** and **Network Management Platform** that enables access across multiple access technologies/domains, like **DOCSIS**, **FTTH**, FTTx, **DSL** and WiFi. It allows a seamless user experience across multiple connectivity services. It reduces complexity for network operators through a simple and easy to adapt **application marketplace**.
## **Community** Applications
- **Provisioning**
- **VoIP Provisioning**
- **Control**, [.. and more](https://devel.nmsprime.com/confluence/display/NMS/Applications)
## Functionality
**Provisioning Tool**
- **DOCSIS** 1.0, 1.1, 2.0, **3.0, 3.1**
- **FTTH**, **DSL**, WiFi Provisioning, via **TR-069** and **RADIUS**
- IPv4 / IPv6
**Network Management Platform**
- **CMTS**, OLT, **Router** and Switch Management via SNMP or TR-069
- **Cable ingress detection**
- Show and manage your IT infrastructure in real-time in **topographic maps** and entity relation diagrams
- Auto configuration of **[Icinga2](https://icinga.com/)** and **[Cacti](https://www.cacti.net/)** from one database
- **Ticket System**
- Generic **SNMP GUI** creator
- Basic billing functionality
- [more informations..](https://devel.nmsprime.com/confluence/display/NMS/Applications)
For more information head over to the NMS Prime [Official Documentation](https://devel.nmsprime.com/confluence/display/NMS/NMS+PRIME)
## Architectural Concepts
NMS Prime is based on the [Laravel](https://laravel.com/) framework and uses [PHP 8](https://php.net) for the back end and a modern and responsive [Bootstrap](http://getbootstrap.com/) theme for the front end.
It is tested and developed under Rocky 9 (RHEL 9).
NMS Prime is build with standard Linux tools, like
- [ISC DHCP](https://www.isc.org/downloads/dhcp/) for IPv4
- [Kea](https://www.isc.org/kea/) for IPv6
- [BIND](https://linux.die.net/man/8/named)
- [Icinga2](https://icinga.com/)
- [Cacti](https://www.cacti.net/)
These tools are actively developed, approved and used. See [Design Architecture](https://devel.nmsprime.com/confluence/display/NMS/Architecture+Guidelines) for more information.
## Installation
### Community Version
**From RPM for Rocky 9 (RHEL 9)**
```bash
curl -vsL https://github.com/cablelabs/os-provisioning/raw/dev/scripts/INSTALL-REPO.sh | bash
yum install nmsprime-*
```
### Enterprise Version
Select your applications and run them in the **Cloud** or **On-Prem** here: [Enterprise Installation](https://www.nmsprime.com/trial/?m=osprov--)
### 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:
```bash
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](https://github.com/cablelabs/os-provisioning/blob/dev/CONTRIBUTING.md) 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](https://devel.nmsprime.com/confluence/x/qYJJ)
**History & Motivation**
NMS Prime started as an German initiative from ISP's for ISP's with the goal in mind to build an open source reference implementation for an technology and vendor agnostic provisioning solution (DOCSIS, FTTH, WiFi, ..). Get part of our movement and roll up your sleves by participating in our development.
**Roadmap**
See [Upcoming Developments](https://github.com/cablelabs/os-provisioning/wiki)
**License**
This project is licensed under the [Apache-2.0](https://github.com/cablelabs/os-provisioning/blob/dev/LICENSE) file for details. For more information: [License Article](https://devel.nmsprime.com/confluence/display/NMS/License)