Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 728 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 728 Bytes
Raw

Contributing

Requirements

  • Go 1.22
  • GNU Make
  • Docker (optional)
  • OPNsense Box with admin access

Environment

This guide is for osx and Linux.

Create API key and secret in OPNsense

SYSTEM>ACCESS>USERS>[user]>API KEYS

OPNsense Documentation

Run the exporter locally

OPS_ADDRESS="ops.example.com" OPS_API_KEY=your-api-key OPS_API_SECRET=your-api-secret make local-run
  • test it
curl http://localhost:8080/metrics

Before PR

  • Make sure to sync the vendor if the dependencies have changed.
make sync-vendor
  • Make sure to run the tests and linters.
make test
make lint