Docs / Getting Started

Getting Started

Install Gator, connect your OPNsense instance, create the local admin password, and verify the first run.

What you need

  • An OPNsense firewall with API access enabled
  • Docker or a local Go + Node toolchain if you want to run from source
  • WireGuard enabled on OPNsense if you plan to use VPN or tunnel workflows

Quick start with Docker

git clone https://github.com/anothaDev/gator.git
cd gator
docker compose up -d

By default, Gator listens on http://localhost:8080. Persistent state is stored in the Docker volume used by the app container.

First run flow

  1. Open the app and save your OPNsense instance.
  2. Verify the API connection.
  3. Create the local admin password.
  4. Log in and confirm the dashboard loads live firewall state.
OPNsense only for now

Gator targets OPNsense. pfSense can connect and test, but full management isn't there yet.

What to do next

  • Create or import a WireGuard VPN profile
  • Review the Routing page for per-app policies and custom profiles
  • Create a backup before applying risky changes
  • Use the Current Scope page to understand what Gator manages and stores locally