Dashboard

Tags: applications

Added in version 0.5.

The harp_apps.dashboard application implements the administrative api and micro-frontend.

If enabled, a server will be available (by default, on port 4080) to access the HARP Dashboard and observe whatever goes through the proxy.

Loading

The dashboard application is loaded by default. You can --disable it if you want.

$ harp-proxy start ... --disable dashboard

Todo

Implement CLI to load or not load an application.

Configuration

Note

The dashboard is enabled by default and configured with reasonable defaults.

Main

Main settings for the dashboard.

dashboard:
  # external port to listen on
  port: 4080

Internal implementation: DashboardSettings

Authentication

Configuration for dashboard user authentication.

dashboard.auth:
  type: basic
  algorithm: plain
  users:
    admin: { password: "not-so-secret" }

dashboard.auth:
  type: basic
  algorithm: pbkdf2_sha256
  users:
    admin:
      password: $pbkdf2-sha256$29000$f4.RkvLeG2OstfZ.D8F4zw$4ONvNXnHCX.8Q.40SU9KjvBsAEAhqdrGJ80tsfLPA/s

Internal implementation: DashboardAuthSetting, DashboardAuthBasicSetting

To hash passwords, you can use python’s passlib package.

You can run a Python interpreter with passlib installed using:

uvx --from passlib python

Then use the following code to hash passwords:

from passlib.hash import pbkdf2_sha256

pbkdf2_sha256.hash("password")

Dev Server

Explicit configurations for the dashboard’s micro frontend dev server, served by vitejs.

dashboard.devserver:
  enabled: true  # default based on availability
  port: 11111  # default to a high available port

Internal

You most likely don’t need to configure the dev server unless you’re working on harp’s internals.

Enable/disable

To disable the dashboard globally, do not load the dashboard application.

$ harp-proxy start ... --disable dashboard