Developer Docs

Note

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

For user guides and general information, please see:

• General OpenWISP Quickstart

• OpenWISP Controller User Docs

• Developer Installation Instructions
  • Dependencies
  • Installing for Development
  • Alternative Sources
  • Install and Run on Docker
  • Troubleshooting Steps for Common Installation Issues
• Code Utilities
  • Registering / Unregistering Commands
  • Controller Notifications
  • Signals
• Extending OpenWISP Controller
  • 1. Initialize Your Project & Custom Apps
  • 2. Install openwisp-controller
  • 3. Add Your Apps to INSTALLED_APPS
  • 4. Add EXTENDED_APPS
  • 5. Add openwisp_utils.staticfiles.DependencyFinder
  • 6. Add openwisp_utils.loaders.DependencyLoader
  • 7. Initial Database Setup
  • 8. Django Channels Setup
  • 9. Other Settings
  • 10. Inherit the AppConfig Class
  • 11. Create Your Custom Models
  • 12. Add Swapper Configurations
  • 13. Create Database Migrations
  • 14. Create the Admin
  • 15. Create Root URL Configuration
  • 16. Import the Automated Tests
  • Other Base Classes that Can Be Inherited and Extended
  • Custom Subnet Division Rule Types
  • More Utilities to Extend OpenWISP Controller

Other useful resources:

• REST API Reference

• Settings