gatenet.dashboard package

Submodules

gatenet.dashboard.app module

FastAPI-based dashboard app for Gatenet.

Provides diagnostics, service discovery, and monitoring endpoints and UI.

gatenet.dashboard.app.api_dns_lookup(host=Query(PydanticUndefined))[source]

DNS lookup for a host.

gatenet.dashboard.app.api_ping(host=Query(PydanticUndefined), count=Query(3))[source]

Ping a host and return the result.

gatenet.dashboard.app.api_port_scan(host=Query(PydanticUndefined), ports=Query(PydanticUndefined))[source]

Scan ports on a host.

gatenet.dashboard.app.api_traceroute(host=Query(PydanticUndefined))[source]

Traceroute to a host and return hops.

gatenet.dashboard.app.api_traceroute_stream(host=Query(PydanticUndefined))[source]

Stream traceroute hops as they are discovered (SSE).

gatenet.dashboard.app.index()[source]
gatenet.dashboard.app.launch_dashboard(host='127.0.0.1', port=8000, open_browser=True)[source]

Launch the Gatenet dashboard web app.

Parameters:

  • host (str) – Host to bind the server to.

  • port (int) – Port to run the server on.

  • open_browser (bool) – Whether to open the dashboard in a browser.

Return type:

None

Module contents

Gatenet Dashboard

A modern, extensible web dashboard for diagnostics, service discovery, and monitoring.

This module provides a FastAPI-based dashboard for Gatenet, with a public API for launching the app.

gatenet.dashboard.launch_dashboard(host='127.0.0.1', port=8000, open_browser=True)[source]

Launch the Gatenet dashboard web app.

Parameters:

  • host (str) – Host to bind the server to.

  • port (int) – Port to run the server on.

  • open_browser (bool) – Whether to open the dashboard in a browser.

Return type:

None