Documentation

Gator Docs

Start with the practical docs for deploying Gator, understanding its current scope, and running OPNsense workflows safely.

Use these docs to get oriented fast

Start here if you want install steps, scope, and the operational details that matter before you put Gator on a live firewall.

Getting Started

Install Gator, connect OPNsense, sign in locally, and verify your first run.

Read →

Current Scope

See what Gator supports today, where pfSense stands, and what data stays local.

Read →

Start here

  1. Start with Getting Started to install Gator and verify that it is talking to OPNsense.
  2. Read Current Scope for a clear view of what Gator manages today and where pfSense stands.

Need the repository details?

If you want releases, compose files, or the full README, visit GitHub.