README

About the OPNsense plugins
==========================

The plugins collection offers users and developers a way to quickly
build additions for OPNsense that can be optionally installed.  As
soon as they are upstreamed they will become available to everyone
through the firmware GUI pages.

Plugins can do the following:

 Modify the menu, access control lists and look and feel (themes)
 Add additional server software and their respective GUI pages
 Create new authentication methods to be used within other subsystems
 Provide other types of devices and interfaces to the firewall
 Pull in additional packages that will update automatically
 Enhance the backend services with additional work tasks
 Allow custom start, stop and early scripts
 Persistent /boot/loader.conf modifications
 Additional themes for the web GUI

Now we need your help to enrich the plugins.  Feel free to contact us
at project AT opnsense DOT org or open GitHub issue to get in touch.


Stay safe,
Your OPNsense team

A list of currently available plugins
=====================================


benchmarks/iperf -- Connection speed tester
databases/redis -- Redis DB
devel/debug -- Debugging Tools
devel/grid_example -- A sample framework application
devel/helloworld -- A sample framework application
dns/bind -- BIND domain name service
dns/ddclient -- Dynamic DNS client
dns/dnscrypt-proxy -- Flexible DNS proxy supporting DNSCrypt and DoH
dns/rfc2136 -- RFC-2136 Support
emulators/qemu-guest-agent -- QEMU Guest Agent for OPNsense
ftp/tftp -- TFTP server
mail/postfix -- SMTP mail relay
mail/rspamd -- Protect your network from spam
misc/theme-advanced -- Theme based on AdvancedTomato GUI
misc/theme-cicada -- The cicada theme - dark grey onyx
misc/theme-flexcolor -- Theme with 3 different color schemes: black as default, light and dark-light
misc/theme-rebellion -- A suitably dark theme
misc/theme-tukan -- The tukan theme - blue/white
misc/theme-vicuna -- The vicuna theme - blue sapphire
net/chrony -- Chrony time synchronisation
net/cloudflared -- Cloudflare Tunnel integration
net/firewall-legacy -- Firewall rules legacy support
net/freeradius -- RADIUS Authentication, Authorization and Accounting Server
net/frr -- The FRRouting Protocol Suite
net/ftp-proxy -- Control ftp-proxy processes
net/google-cloud-sdk -- Google Cloud SDK
net/haproxy -- Reliable, high performance TCP/HTTP load balancer
net/igmp-proxy -- IGMP-Proxy Service (not maintained)
net/isc-dhcp -- ISC DHCPv4/v6 server
net/mdns-repeater -- Proxy multicast DNS between networks
net/ndp-proxy-go -- IPv6 Neighbor Discovery Protocol (NDP) Proxy
net/netflector -- Reflect link-local service discovery between interfaces
net/ntopng -- Traffic Analysis and Flow Collection
net/radsecproxy -- RADIUS proxy provides both RADIUS UDP and TCP/TLS (RadSec) transport
net/realtek-re -- Realtek re(4) vendor driver
net/relayd -- Relayd Load Balancer
net/shadowsocks -- Secure socks5 proxy
net/siproxd -- Siproxd is a proxy daemon for the SIP protocol
n

Top issues