OpenWISP Documentation

This page contains all the documentation you will need to get started on with using OpenWISP.

Need a quick overview? Try the OpenWISP Demo.

Contents:

• Quickstart
  • 0. Try the Demo
  • 1. Install the OpenWISP server application
  • 2. Install openwisp-config on your devices
  • 3. Install openwisp-monitoring on your devices
  • 4. Watch video demonstrations
  • 5. Look for help
• Connect OpenWRT to OpenWISP
  • 1. Install OpenWISP
  • 2. Flash OpenWRT on a device
  • 3. Install openwisp-config
  • Compile your own OpenWRT image
• Monitoring
  • Deploy instructions
  • Quickstart Guide
  • Find out more about OpenWISP Monitoring
• Configuration Templates
  • Template ordering and override
  • Shared templates vs organization specific
  • Default Templates
  • Required Templates
  • Template tags
• How to Use Configuration Variables
  • Predefined device variables
  • User defined device variables
  • Template default values
  • Global variables
  • System defined variables
  • Example usage of variables
• OpenVPN tunnel Automation
  • Installing OpenVPN Server and importing the OpenVPN configuration
  • Preparing the configuration template for VPN Clients
• Wireguard and Wireguard over VXLAN tunnel automation
  • How to setup WireGuard tunnels
  • How to setup VXLAN over WireGuard tunnels
• ZeroTier tunnel automation
  • How to setup ZeroTier Tunnels
• How to Configure Push Updates
  • 1. Generate SSH key
  • 2. Save SSH private key in OpenWISP (access credentials)
  • 3. Add the public key to your devices
  • 4. Test it
• Sending Commands to Devices
  • Default command options
  • How to define new options in the commands menu
• Subnet division rules
  • Enabling the subnet division rule app
  • Configuring the automatic provisioning of subnets and IPs
  • Important notes for using Subnet Division
  • Limitations of Subnet Division
• Firmware Upgrades
  • Deploy instructions
  • Quickstart Guide
  • Find out more about OpenWISP Firmware Upgrader
• Network Topology
  • Deploy instructions
  • Quickstart Guide
  • Find out more about OpenWISP Network Topology
• RADIUS
  • Deploy instructions
  • Find out more about OpenWISP RADIUS
• WiFi Login Pages
  • Screenshots
  • Overview
• How to Edit Django Settings
  • Modules (a.k.a Django Apps)
  • Editing settings with the ansible role
  • Editing settings with docker-openwisp
• Collection of Usage Metrics
  • Opting out from metric collection
• OpenWISP Demo
  • Accessing the demo system
  • Firmware instructions (flashing OpenWISP Firmware)
  • Alternative firmware instructions
  • Connecting your device to OpenWISP
  • Monitoring charts and status
  • Get help
  • Next steps
• How to Set Up Wi-Fi Access Point SSIDs
  • Set Up an Open Access Point SSID on a Device
  • Set Up a WPA Encrypted Access Point SSID on a Device
  • Set Up the Same SSID and Password on Multiple Devices
  • Multiple SSIDs, multiple radios
  • Roaming (802.11r: Fast BSS Transition)
  • Monitoring WiFi Clients
• WiFi Hotspot & Captive Portal
  • Enable Captive Portal Template
  • Accessing the Public WiFI Hotspot
  • Logging Out
  • Session Limits
  • Automatic Captive Portal Login
  • Sign Up
  • Social Login
  • Paid WiFi Hotspot Subscription Plans
• How to Set Up a Wireless Mesh Network
  • Firmware Requirements for Mesh
  • General Assumptions
  • Creating the Template
  • Enable the Mesh Template on the Devices
  • Monitoring the Mesh Nodes
  • Mesh Topology Collection and Visualization
  • Changing the Default 802.11s Routing Protocol
• How to Set Up WPA Enterprise (EAP-TTLS-PAP) authentication
  • Pre-requisites for following this tutorial
  • Configuring FreeRADIUS for WPA Enterprise
  • Creating the NAS
  • Creating the Template
  • Enable the WPA Enterprise Template on the Devices
  • Connecting to the WiFi with WPA 2 Enterprise
• Architecture, Modules, Technologies
  • Architecture Overview
  • OpenWISP Modules
  • Main Technologies Used
• Values and Goals of OpenWISP
  • What is OpenWISP?
  • History
  • Core Values
  • Goals
• Help us to grow
  • Are you using OpenWISP for your organization?
  • How to help
• Press
  • Presentations
  • Blog Posts
  • Google Summer of Code Blog Posts
  • Research and publications
  • Logos and Graphic material
• Code of Conduct
  • 1. Purpose
  • 2. Open Source Citizenship
  • 3. Expected Behavior
  • 4. Unacceptable Behavior
  • 5. Consequences of Unacceptable Behavior
  • 6. Reporting Guidelines
  • 7. Addressing Grievances
  • 8. Scope
  • 9. Contact info
  • 10. License and attribution
• Contributing guidelines
  • Introduce yourself
  • Look for open issues
  • Priorities for the next release
  • Setup
  • How to commit your changes properly
  • Coding Style Conventions
  • Thank You
• Hacking OpenWISP: Python and Django
  • Why Python?
  • Why Django?
  • Why Django REST framework?
  • Useful Development Tools
• Google Summer of Code
  • How to run a successful Google Summer of Code
  • Traits we look for in applicants
  • How to become an OpenWISP star
  • Time to start hacking
  • Project ideas
  • Application Template
• GSoC Project Ideas 2024
  • General suggestions and warnings
  • Project Ideas
• Google Code-in
  • How to run a successful GCI
  • How to become an OpenWISP star
  • Evaluation criteria
  • Time to start hacking
  • FAQs
• Hacktoberfest
  • How to get started
  • Main Rules