netjsonconfig

Network configuration management library based on NetJSON DeviceConfiguration

Showing:

Popularity

Downloads/wk

0

GitHub Stars

372

Maintenance

Last Commit

1mo ago

Contributors

27

Package

Dependencies

3

License

GPL3

Categories

Readme

netjsonconfig

.. image:: https://github.com/openwisp/netjsonconfig/workflows/Netjsonconfig%20CI%20Build/badge.svg?branch=master :target: https://github.com/openwisp/netjsonconfig/actions?query=workflow%3A%22Netjsonconfig+CI+Build%22

.. image:: https://coveralls.io/repos/openwisp/netjsonconfig/badge.svg :target: https://coveralls.io/r/openwisp/netjsonconfig

.. image:: https://requires.io/github/openwisp/netjsonconfig/requirements.svg?branch=master :target: https://requires.io/github/openwisp/netjsonconfig/requirements/?branch=master :alt: Requirements Status

.. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square :target: https://gitter.im/openwisp/general

.. image:: https://badge.fury.io/py/netjsonconfig.svg :target: http://badge.fury.io/py/netjsonconfig

.. image:: https://pepy.tech/badge/netjsonconfig :target: https://pepy.tech/project/netjsonconfig :alt: downloads

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://pypi.org/project/black/ :alt: code style: black


Netjsonconfig is a part of the OpenWISP project <http://openwisp.org> and it's the official configuration engine of OpenWISP 2 <https://github.com/openwisp/ansible-openwisp2>.

.. image:: http://netjsonconfig.openwisp.org/en/latest/_images/openwisp.org.svg :target: http://openwisp.org

netjsonconfig is a python library that converts NetJSON <http://netjson.org> DeviceConfiguration objects into real router configurations that can be installed on systems like OpenWRT <http://openwrt.org>, LEDE <https://www.lede-project.org/> or OpenWisp Firmware <https://github.com/openwisp/OpenWISP-Firmware>.

Its main features are listed below for your reference:

  • OpenWRT <http://openwrt.org> / LEDE <https://www.lede-project.org/> support
  • OpenWisp Firmware <https://github.com/openwisp/OpenWISP-Firmware>_ support
  • OpenVPN <https://openvpn.net>_ support
  • WireGuard <https://www.wireguard.com/>_ support
  • Possibility to support more firmwares via custom backends
  • Based on the NetJSON RFC <http://netjson.org/rfc.html>_
  • Validation based on JSON-Schema <http://json-schema.org/>_
  • Templates: store common configurations in templates
  • Multiple template inheritance: reduce repetition to the minimum
  • File inclusion: easy inclusion of arbitrary files in configuration packages
  • Variables: reference variables in the configuration
  • Command line utility: easy to use from shell scripts or from other programming languages

Documentation <http://netjsonconfig.openwisp.org/> | Change log <https://github.com/openwisp/netjsonconfig/blob/master/CHANGES.rst> | Support channels <http://openwisp.org/support.html> | Issue Tracker <https://github.com/openwisp/netjsonconfig/issues> | License <https://github.com/openwisp/netjsonconfig/blob/master/LICENSE>_

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100