Skip to main content

DASHBOARD

Overview

swamp serve includes an opt-in web dashboard that provides a browser-based view of the running server. The dashboard is disabled by default and adds no overhead when not enabled.

Enabling the dashboard

Enable the dashboard with any of:

  • --dashboard flag on swamp serve
  • dashboard: true in the serve config file (.swamp/serve.yaml)
  • SWAMP_DASHBOARD=true environment variable
swamp serve --dashboard
# .swamp/serve.yaml
dashboard: true

When running as a daemon, --dashboard is not yet available on swamp serve daemon enable. Use the config file or environment variable instead.

Accessing the dashboard

Once enabled, the dashboard is available at:

http://<host>:<port>/dashboard

With the default settings (--host 127.0.0.1 --port 9090):

http://127.0.0.1:9090/dashboard

Authentication

The dashboard uses the same authentication as the rest of swamp serve. When --auth-mode is set to token or oauth, the dashboard requires authentication. See Serve Flags — Authentication modes for details.

  • Serve Flags — full flag reference including --dashboard
  • REST API — HTTP endpoints for health monitoring and run management
  • Daemon Management — running swamp serve as a system daemon
← PreviousWebhooksNext →Operational Commands