Developer Docs

Note

This page is for developers who want to customize or extend OpenWISP Monitoring, whether for bug fixes, new features, or contributions.

For user guides and general information, please see:

• General OpenWISP Quickstart

• OpenWISP Monitoring User Docs

• Developer Installation Instructions
  • Dependencies
  • Installing for Development
  • Alternative Sources
  • Install and Run on Docker
• Code Utilities
  • Registering / Unregistering Metric Configuration
  • Registering / Unregistering Chart Configuration
  • Monitoring Notifications
  • Signals
  • Exceptions
• Extending OpenWISP Monitoring
  • 1. Initialize your Custom Module
  • 2. Install openwisp-monitoring
  • 3. Add EXTENDED_APPS
  • 4. Add openwisp_utils.staticfiles.DependencyFinder
  • 5. Add openwisp_utils.loaders.DependencyLoader
  • 6. Inherit the AppConfig Class
  • 7. Create your Custom Models
  • 8. Add Swapper Configurations
  • 9. Create Database Migrations
  • 10. Create your Custom Admin
  • 11. Create Root URL Configuration
  • 12. Create celery.py
  • 13. Import Celery Tasks
  • 14. Create the Custom Command run_checks
  • 15. Import the Automated Tests
  • Other Base Classes that can be Inherited and Extended

Other useful resources:

• REST API Reference

• Settings