openwisp-controller

May 8, 2025 ยท View on GitHub

.. image:: https://github.com/openwisp/openwisp-controller/actions/workflows/ci.yml/badge.svg :target: https://github.com/openwisp/openwisp-controller/actions/workflows/ci.yml :alt: CI build status

.. image:: https://coveralls.io/repos/openwisp/openwisp-controller/badge.svg :target: https://coveralls.io/r/openwisp/openwisp-controller :alt: Test Coverage

.. image:: https://img.shields.io/librariesio/release/github/openwisp/openwisp-controller :target: https://libraries.io/github/openwisp/openwisp-controller#repository_dependencies :alt: Dependency monitoring

.. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg :target: https://gitter.im/openwisp/general :alt: Chat

.. image:: https://badge.fury.io/py/openwisp-controller.svg :target: http://badge.fury.io/py/openwisp-controller :alt: Pypi Version

.. image:: https://pepy.tech/badge/openwisp-controller :target: https://pepy.tech/project/openwisp-controller :alt: Downloads

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

.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/controller_demo.gif :target: https://github.com/openwisp/openwisp-controller/tree/docs/docs/controller_demo.gif :alt: Feature Highlights

Need a quick overview? Try the OpenWISP Demo <https://openwisp.org/demo.html>_.

OpenWISP Controller is a configuration manager that allows to automate several networking tasks like adoption, provisioning, management VPN configuration, X509 certificates automatic generation, revocation of x509 certificates and a lot more features.

OpenWISP is not only an application designed for end users, but can also be used as a framework on which custom network automation solutions can be built on top of its building blocks.

Other popular building blocks that are part of the OpenWISP ecosystem are:

  • openwisp-monitoring <https://openwisp.io/docs/stable/monitoring/>_: provides device status monitoring, collection of metrics, charts, alerts, possibility to define custom checks
  • openwisp-firmware-upgrader <https://openwisp.io/docs/stable/firmware-upgrader/>_: automated firmware upgrades (single devices or mass network upgrades)
  • openwisp-radius <https://openwisp.io/docs/stable/radius/>_: based on FreeRADIUS, allows to implement network access authentication systems like 802.1x WPA2 Enterprise, captive portal authentication, Hotspot 2.0 (802.11u)
  • openwisp-network-topology <https://openwisp.io/docs/stable/network-topology/>_: provides way to collect and visualize network topology data from dynamic mesh routing daemons or other network software (e.g.: OpenVPN); it can be used in conjunction with openwisp-monitoring to get a better idea of the state of the network
  • openwisp-ipam <https://openwisp.io/docs/stable/ipam/>_: allows to manage the assignment of IP addresses used in the network
  • openwisp-notifications <https://openwisp.io/docs/stable/notifications/>_: allows users to be aware of important events happening in the network.

For a more complete overview of the OpenWISP modules and architecture, see the OpenWISP Architecture Overview <https://openwisp.io/docs/stable/general/architecture.html>_.

.. image:: https://raw.githubusercontent.com/openwisp/openwisp2-docs/master/assets/design/openwisp-logo-black.svg :target: http://openwisp.org :alt: OpenWISP

Documentation

  • Usage documentation <https://openwisp.io/docs/stable/controller/>_
  • Developer documentation <https://openwisp.io/docs/stable/controller/developer/>_

Contributing

Please refer to the OpenWISP contributing guidelines <http://openwisp.io/docs/developer/contributing.html>_.

Changelog

See CHANGES <https://github.com/openwisp/openwisp-controller/blob/master/CHANGES.rst>_.

License

See LICENSE <https://github.com/openwisp/openwisp-controller/blob/master/LICENSE>_.

Support

See OpenWISP Support Channels <http://openwisp.org/support.html>_.