Attention

This is the documentation for HARP Proxy, actually published as an early preview. Both the software and documentation are a work in progress, and although we already use it on various production servers, they may contain inaccuracies, typographical errors, huge mistakes and empty pages. We work hard to eradicate all mistakes and implement stuff, but it is a long and tedious process. We appreciate your patience and understanding. Of course, any help will be greatly appreciated.

Dashboard

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 observe whatever goes through the proxy.

Loading

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

$ harp 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

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 start ... --disable dashboard