Skip to main content

DashboardPluginOptions

Configuration options for the DashboardPlugin.

Signature
interface DashboardPluginOptions {    route: string;    appDir: string;    viteDevServerPort?: number;}

route

propertystring
Default:'dashboard'

The route to the Dashboard UI.

appDir

propertystring

The path to the dashboard UI app dist directory.

viteDevServerPort

propertynumber
Default:5173

The port on which to check for a running Vite dev server. If a Vite dev server is detected on this port, requests will be proxied to it instead of serving static files from appDir.

Was this chapter helpful?
Report Issue
Edited Feb 2, 2026·Edit this page