Developer Docs

Note

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

For user guides and general information, please see:

• General OpenWISP Quickstart

• OpenWISP Users Usage Docs

• Developer Installation Instructions
  • Installing for Development
  • Alternative Sources
• Admin Utilities
  • MultitenantAdminMixin
  • MultitenantOrgFilter
  • MultitenantRelatedOrgFilter
• Django REST Framework Utilities
  • Authentication
  • Permission Classes
  • ProtectedAPIMixin
  • Mixins for Multi-Tenancy
• Miscellaneous Utilities
  • Organization Membership Helpers
  • UsersAuthenticationBackend
  • PasswordExpirationMiddleware
  • PasswordReuseValidator
• Extending OpenWISP Users
  • 1. Initialize Your Custom Module
  • 2. Install OpenWISP Users
  • 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 the admin
  • 11. Create Root URL Configuration
  • 12. Import the Automated Tests
  • Other Base Classes that can be Inherited and Extended

Other useful resources:

• REST API

• Settings