---

Welcome to OPNsense’s documentation!

OPNsense® is an open source, easy-to-use and easy-to-build FreeBSD based firewall and routing platform.

OPNsense includes most of the features available in expensive commercial firewalls, and more in many cases. It brings the rich feature set of commercial offerings with the benefits of open and verifiable sources.

Table of Contents

• Introduction
  • Welcome to OPNsense’s documentation!
  • Mission Statement
  • Reading guide
  • Feature set
  • OPNsense Core Features
• Releases
  • Community Edition
  • Business Edition
• Installation and setup
  • Hardware sizing & setup
  • Initial Installation & Configuration
  • Virtual & Cloud based Installation
  • Updates
  • Included software
  • Setup guides
• Lobby
  • General User Interface
  • Dashboard
  • Password
  • OPNsense Tools
• Reporting
  • System Health & Round Robin Data
  • Using Insight - Netflow Analyzer
  • Netflow Export & Analyses
  • Reporting Settings
  • Reporting Traffic
  • Setup guides
• System
  • Access / User Management
  • Configuration
  • Firmware
  • Gateways
  • Gateway groups / Multi WAN
  • High Availability
  • Routes
  • Settings
  • Trust
  • Log Files
  • Diagnostics
  • Setup guides
• Interfaces
  • Interface configuration
  • Overview
  • Settings
  • Virtual IPs
  • Wireless
  • Other Types
  • Using IPv6
  • Diagnostics
  • Log Files
  • Setup guides
• Firewall
  • Generic info
  • Aliases
  • Categories
  • [Interface] Groups
  • Network Address Translation
  • NPTv6
  • Rules
  • Traffic Shaping
  • (Advanced) Settings
  • Normalization
  • Configure CARP
  • Log Files
  • Diagnostics
  • Setup guides
• Virtual Private Networking
  • IPsec
  • OpenVPN (SSL VPN)
  • Plugin VPN options
• Services
  • Captive portal & GuestNET
  • DHCP
  • Dnsmasq DNS
  • Intrusion Prevention System
  • Monit
  • Network Time
  • OpenDNS
  • Unbound DNS
  • Caching Proxy
  • Router Advertisements
  • Log Files
  • Setup guides
• Community Plugins
  • DNS
  • VPN & Connectivity
  • Web
  • Other
  • Reporting
• Third-party Plugins
  • Deciso
  • Sunnyvalley
• Troubleshooting
  • General issue workflow
  • Topics
• Development Manual
  • Development Workflow
  • Coding Guidelines
  • Architecture
  • Backend
  • Frontend
  • Components
  • API Reference
  • Examples
  • How-tos
  • Sources
• Vendor / Hardware
  • Quickstart / getting started
  • Default Configurations
  • Serial Console connectivity
  • BIOS updates
• Project Relations
  • Deciso B.V.
  • FreeBSD®
  • M0n0wall
  • Open Source Initiative
• Legal notices
  • OPNsense License & Copyright
  • Packages and ports
  • Documentation Copyright
  • Pictures Copyright
  • Logos Copyright
  • Trademark policy
• Support Options
  • Commercial
  • Community
  • Community Support Levels
• Contribute
  • Financially
  • Development
  • Translations
  • Documentation & wiki articles
  • Forum & IRC
  • Social media
  • Closing Words
• History
  • About the Fork
• Security
  • Intro
  • Staying ahead
  • Upstream vulnerabilities
  • Reporting an incident
  • Information handling policies