Developer Docs

Note

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

For user guides and general information, please see:

• General OpenWISP Quickstart

• OpenWISP RADIUS User Docs

• Developer Installation Instructions
  • Dependencies
  • Installing for Development
  • Alternative Sources
  • Migrating an existing freeradius database
  • Troubleshooting Steps for Common Installation Issues
• Code Utilities
  • Signals
  • Captive portal mock views
• Extending OpenWISP RADIUS
  • 1. Initialize your custom module
  • 2. Install openwisp-radius
  • 3. Add your App to INSTALLED_APPS
  • 4. Add EXTENDED_APPS
  • 5. Add openwisp_utils.staticfiles.DependencyFinder
  • 6. Add openwisp_utils.loaders.DependencyLoader
  • 7. Inherit the AppConfig class
  • 8. Create your custom models
  • 9. Add swapper configurations
  • 10. Create database migrations
  • 11. Create the admin
  • 12. Setup Freeradius API Allowed Hosts
  • 13. Setup Periodic tasks
  • 14. Create root URL configuration
  • 15. Import the automated tests
  • Other base classes that can be inherited and extended

Other useful resources:

• REST API Reference

• Settings