Skip to content

albismart/client-api

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

alt text

Albismart snmp-driver is an opensource project, MIT-licensed. It is maintained by the core developers of Albismart company. Open to any contributors willing to give to the Internet Providing community.

![Client API - Intro](Watch youtube guide)

Introduction

The client-api, is a middleware between the decentralized servers and provisioning solutions. It is designed to provide your network infrastructure a modern REST API using JSON.

Prerequisites

In order to get the API running, setup a linux distro with the below services

1. PHP 5.4> running server with 
2. PHP Extensions: json, snmp, mysql, mysql-pdo
3. MySQL if you are planing to use https://freeradius.org
4. DHCP server in case you have one you can install our API inside that actual running server.
5. ([OMAPI](https://en.wikipedia.org/wiki/OMAPI)) and OMSHELL in order to manage the DHCP Hosts on the fly.

Installing

You may download our api from project page or get the zip from github.

After doing get the files inside your /var/www/html/ dir or your public apache/nginx based on your server configuration.

Our initial todo list (we may extend or eleminate items, depending on the project flow)

  • Server info
  • DHCP Provisioning Management API (OMAPI based)
  • PPPoE Provisioning Management API
  • CMTS - SNMP Read, Write API
  • CableModem - SNMP Read, Write API
  • OLT - SNMP Read, Write API
  • ONU/ONT - SNMP Read, Write API
  • Telnet connection API
  • Cronjob tasks for fixes, updates and collection purposes
  • GUI installation index.php, create config.php
  • Build an extensive wiki for the repo

Contributing

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

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

About

Open-source provisioning πŸŽ‡ middleware client-api πŸ”€ to manage network infrastructures 🌐

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages