os-zoraxy — OPNsense Plugin for Zoraxy Reverse Proxy

OPNsense plugin that integrates Zoraxy reverse proxy into the OPNsense web GUI under Services → Zoraxy.

Features

• Enable/disable Zoraxy from the OPNsense GUI
• Configure web ui listening port and log directory
• Service start/stop/restart via the GUI service widget
• GeoIP database update button
• Update Zoraxy binary button

Prerequisites

• OPNsense firewall with internet access (for downloading the binary)
• Reassigned WebUI port from 80 to e.g. 8080 (System → Settings → Administration → TCP Port)
• The plugin automatically downloads the latest zoraxy_freebsd_amd64 binary from GitHub Releases during installation and places it at /usr/local/sbin/zoraxy.

Installation

1. Clone the opnsense/plugins repo on the OPNsense box
2. Clone this repo to plugins/www/os-zoraxy
3. Build the package: cd plugins/www/os-zoraxy && make package
4. Install the package: pkg add work/pkg/os-zoraxy-devel-1.0.pkg

git clone https://github.com/opnsense/plugins.git
cd plugins/www
git clone https://github.com/andyburri/os-zoraxy.git
cd os-zoraxy
make package
pkg add work/pkg/os-zoraxy-devel-1.0.pkg

Configuration

After installation:

1. Navigate to Services → Zoraxy in the OPNsense web GUI
2. Check Enable Zoraxy
3. Set the HTTP Port (e.g. 0.0.0.0:8000)
4. Optionally set the Log Directory
5. Click Save

The service will start automatically. Use the service widget at the top of the page to stop/restart.

Uninstall

Delete the package from the Plugins page.

Or use the following commands:

pkg delete os-zoraxy
service configd restart

Directory Layout

After installation, files are deployed to:

Component	Path
MVC Controllers	/usr/local/opnsense/mvc/app/controllers/OPNsense/Zoraxy/
MVC Models	/usr/local/opnsense/mvc/app/models/OPNsense/Zoraxy/
MVC Views	/usr/local/opnsense/mvc/app/views/OPNsense/Zoraxy/
Configd Actions	/usr/local/opnsense/service/conf/actions.d/actions_zoraxy.conf
Configd Templates	/usr/local/opnsense/service/templates/OPNsense/Zoraxy/
Plugin Inc	/usr/local/etc/inc/plugins.inc.d/zoraxy.inc
Service Script	/usr/local/etc/rc.d/opnsense-zoraxy
Control Script	/usr/local/opnsense/scripts/OPNsense/Zoraxy/zoraxy_control.sh
Working Directory	/var/db/zoraxy/ (created at runtime)
Generated Config	/usr/local/etc/zoraxy.conf (generated by configd template)

Service Management (CLI)

service opnsense-zoraxy start
service opnsense-zoraxy stop
service opnsense-zoraxy restart
service opnsense-zoraxy status