@piifirewall/dashboard
v1.0.0
Published
PIIFirewall — local dashboard. Reads what the PIIFirewall products on this machine wrote, and shows it.
Readme
PII Firewall — local dashboard
Shows what the PII Firewall products on this machine have been doing: what was detected, what was masked, what was blocked, and what it saved.
It is a viewer and nothing else. It has no database, no account, and no server of ours to talk to — it reads what the products on this machine already wrote, and nothing it reads leaves the machine.
Install & run
npm install @piifirewall/dashboard
npx piifirewall-dashboardThen open http://localhost:4173. Set PORT to listen elsewhere.
Point it at a gateway other than the default (http://localhost:3001) by setting
VITE_PROXY_URL before building from source.
Where the figures come from
Two sources, and it uses whichever is there:
- The gateway, over HTTP (
/logs,/stats,/health) — used when you run the self-hosted gateway. - The SDK and the connector, through a file. They are libraries, not
servers, so with
PIIFW_LOCAL_TELEMETRY=onthey append their activity to~/.piifw/telemetry.json, and the dashboard reads it back.
With neither running, every panel says it has no data. That is the honest answer, and it is not the same thing as a zero.
What is shown, and what stays locked
Detection, masking, injection findings and their history are shown whichever product produced them. The cache and AI-cost panels need figures only the console gateway reports; with the public build they stay locked, and the dashboard says so rather than showing an empty chart.
Authentication
There is none, and by default there is nothing to authenticate: the dashboard runs on your machine and shows your own data to you.
If you put it somewhere more than one person can reach, authentication is yours
to add — the backend is your choice and your responsibility. Implement
src/lib/auth-backend.js against it; that file is the only seam you need.
Licence
Elastic License 2.0. See LICENSE, and NOTICE for the third-party components
distributed with this package.
