Document dashboard login location and the session events startup grace

ML
2d ago
+11-1

Docs for netbirdio/netbird#8626 (dashboard login location) and the peer session event variables from netbirdio/netbird#8620 and netbirdio/netbird#8628. The peer connected and disconnected events themselves are documented in netbirdio/docs#1117.

  • Audit Events Logging: Dashboard login events now record the source IP and location, with a note on trustedHTTPProxies for self-hosted deployments.
  • Environment variables: adds NB_PEER_SESSION_EVENTS_STARTUP_GRACE and NB_DISABLE_PEER_SESSION_EVENTS.
  • External reverse proxy: notes that untrusted proxies also affect the IP recorded on login events.

Merge after #8620, #8626 and #8628.

Summary by CodeRabbit

  • Documentation
    • Clarified which location details are recorded for dashboard and MCP OAuth logins, and how reverse proxy settings affect the recorded IP address.
    • Documented runtime settings for peer-session audit events, including startup grace, event suppression, defaults, and behavior for invalid values.
    • Updated Cloudflare guidance to note that login audit events may record a Cloudflare address until its IP ranges are trusted.