Development Manual

The OPNsense® project invites developers to start developing with OPNsense: “For your own purpose or even better to join us in creating the best open source firewall available!” The development workflow & build process have been redesigned to make it more straightforward and easy for developers to build OPNsense.

Being able to get the sources and build it yourself is one of the key factors of open source software. One reason that for starting the OPNsense project is that the team believes sources and build tools should be freely available and as easy to use as possible.

• Development Workflow
• Coding Guidelines
  • Basics and Future
  • PSR-1 Basic Coding Standard
  • PSR-2 Coding Style Guide
  • PSR-12 Coding Style Guide
  • Python PEPs
• Architecture
• Backend
  • Overview
  • Bootup / autorun options
  • CARP status
  • Using configd
  • Using plugins
  • Using Templates
• Frontend
  • Creating Models
  • Creating Models / Field types
  • Routing
  • Using controllers and views
  • View construction (and tools)
  • Dashboard widgets
• Components
  • Menu System
  • Access Control List
  • Authentication
• API Reference
  • Captiveportal
  • Core
  • Cron
  • Dhcp
  • Dhcpv4
  • Dhcpv6
  • Dhcrelay
  • Diagnostics
  • Firewall
  • Firmware
  • Ids
  • Interfaces
  • Ipsec
  • Kea
  • Menu
  • Monit
  • Openvpn
  • Proxy
  • Routes
  • Routing
  • Syslog
  • Trafficshaper
  • Trust
  • Unbound
  • Wireguard
  • Acmeclient
  • Apcupsd
  • Backup
  • Bind
  • Caddy
  • Chrony
  • Cicap
  • Clamav
  • Collectd
  • Crowdsec
  • Dechw
  • Diagnostics
  • Dnscryptproxy
  • Dyndns
  • Fetchmail
  • Freeradius
  • Ftpproxy
  • Gridexample
  • Haproxy
  • Helloworld
  • Hwprobe
  • Iperf
  • Lldpd
  • Maltrail
  • Mdnsrepeater
  • Muninnode
  • Netdata
  • Netsnmp
  • Nginx
  • Nodeexporter
  • Nrpe
  • Ntopng
  • Nut
  • Openconnect
  • Postfix
  • Proxy
  • Proxysso
  • Proxyuseracl
  • Puppetagent
  • Qemuguestagent
  • Quagga
  • Radsecproxy
  • Redis
  • Relayd
  • Rspamd
  • Shadowsocks
  • Siproxd
  • Smart
  • Softether
  • Sslh
  • Stunnel
  • Tayga
  • Telegraf
  • Tftp
  • Tinc
  • Tor
  • Udpbroadcastrelay
  • Vnstat
  • Wazuhagent
  • Wireguard
  • Wol
  • Zabbixagent
  • Zabbixproxy
  • Zerotier
  • OPNBECore
• Examples
  • Hello world module & plugin
  • Using grids module & plugin
  • API enable standard services
• How-tos
  • Use the API
  • Profiling/Debugging the kernel
  • Remote debugging the kernel

Sources

Just looking for the sources? See: OPNsense repository