96 lines
2.7 KiB
Markdown
96 lines
2.7 KiB
Markdown
# peardata-website
|
||
|
||
Official marketing site and public documentation for **[PearData](https://peardata.rest)**
|
||
([source](https://git.ssh.surf/snxraven/peardata)).
|
||
|
||
Owned by **HoneyPeer, LLC**. Product is P2P real-time host monitoring / fleet observability on HyperDHT.
|
||
|
||
Deep engineering docs also live in the **peardata** repo under `docs/` and `user-guide/`.
|
||
This site is the public operator mirror (HTML) plus marketing pages. Keep claims in sync when the product changes.
|
||
|
||
## Site origin
|
||
|
||
**https://peardata.rest**
|
||
|
||
Env override: `SITE_ORIGIN=https://peardata.rest`
|
||
|
||
## Install story (keep in sync with main repo)
|
||
|
||
Canonical installer:
|
||
|
||
```bash
|
||
curl -fsSL https://install.peardata.rest | bash
|
||
```
|
||
|
||
Official install host: **https://install.peardata.rest/**
|
||
|
||
- **Agent (Linux):** Bare binary → `/opt/peardata`, `peardata.service`
|
||
- **Client:** rolling `peardata-client-VERSION-HOST.tar.gz` (macOS / Linux / Windows Electron)
|
||
- **Assets:** `https://git.ssh.surf/snxraven/peardata/releases/tag/rolling`
|
||
|
||
When peardata’s **install process** changes, update:
|
||
|
||
- `download.html`
|
||
- `docs/quickstart.html`
|
||
- `docs/operator.html`
|
||
- `docs/faq.html`
|
||
- `docs/release.html`
|
||
- home page install teaser in `index.html`
|
||
|
||
## Product / feature docs (keep in sync)
|
||
|
||
| Area | Website files |
|
||
|------|----------------|
|
||
| Features marketing | `index.html` |
|
||
| Operator production guide | `docs/operator.html` |
|
||
| REST / RPC overview | `docs/api.html` |
|
||
| Architecture | `docs/architecture.html` |
|
||
| Concepts | `learn/index.html` |
|
||
| Auth / threat model | `docs/security.html` |
|
||
| FAQ | `docs/faq.html` |
|
||
| Docs hub | `docs/index.html` |
|
||
| Screenshots | `public/assets/screenshots/` |
|
||
| Branding | `public/assets/logo`, `favicons`, `brand` (from peardata-branding) |
|
||
|
||
Especially check claims for:
|
||
|
||
- Overview KPIs + Charts wall
|
||
- Custom **Dashboard** tab
|
||
- **Alerts** (open thresholds + recent events)
|
||
- **QVAC** (on-device AI, multi-agent, stop, auto-nav)
|
||
- Data Manager retention / prune
|
||
- Roles viewer / operator / admin + `pd1.` invites
|
||
- Optional Docker metrics (`PEARDATA_DOCKER`) — not a Docker management product
|
||
|
||
## Releases API
|
||
|
||
- UI: `/releases`
|
||
- API: `GET /api/releases`, `/api/releases/latest`, `/api/releases/tags/:tag`
|
||
- Upstream: `https://git.ssh.surf/api/v1/repos/snxraven/peardata/releases`
|
||
|
||
## Sitemap
|
||
|
||
- Dynamic: `GET /sitemap.xml` from `server.mjs`
|
||
- Origin: `SITE_ORIGIN` (default `https://peardata.rest`)
|
||
|
||
## Progress
|
||
|
||
See **[progress.md](./progress.md)** for the full launch checklist.
|
||
|
||
## Dev
|
||
|
||
```bash
|
||
npm install
|
||
npm run dev # Vite (proxies /api/releases → Gitea)
|
||
npm run build # → dist/
|
||
npm start # static dist + Gitea proxy (PORT=4173)
|
||
```
|
||
|
||
## Production
|
||
|
||
```bash
|
||
npm run build
|
||
SITE_ORIGIN=https://peardata.rest npm start
|
||
# or: pm2 start server.mjs --name peardata-website
|
||
```
|