Raven Scott
28314838f7
Quick start, operator, security, FAQ, download, home, and learn pages now point operators at /opt/peardock/.env for public key and seed, and document viewer / admin / pd1. invite roles.
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
# peardock-website
|
||
|
||
Official marketing site and documentation for [peardock](https://peardock.boats)
|
||
([source](https://git.ssh.surf/snxraven/peardock)).
|
||
|
||
## Install story (keep in sync with main repo)
|
||
|
||
Canonical installer host: **https://install.peardock.boats**
|
||
|
||
```bash
|
||
curl -fsSL https://install.peardock.boats | bash
|
||
```
|
||
|
||
- **Server (Linux):** Bare binary → `/opt/peardock`, user `peardock` in docker group, `peardock.service`
|
||
- **Client:** rolling `peardock-client-VERSION-HOST.tar.gz` (macOS `.app`, Linux binary + desktop entry)
|
||
- **Assets:** `https://git.ssh.surf/snxraven/peardock/releases/tag/rolling`
|
||
|
||
When peardock’s install process changes, update:
|
||
|
||
- `download.html`
|
||
- `docs/quickstart.html`
|
||
- `docs/operator.html`
|
||
- `docs/faq.html`
|
||
- `docs/release.html`
|
||
- home page `#quickstart` teaser in `index.html`
|
||
|
||
## Releases
|
||
|
||
- UI: `/releases` (live list from Gitea)
|
||
- API: `GET /api/releases`, `/api/releases/latest`, `/api/releases/tags/:tag`
|
||
- Upstream: `https://git.ssh.surf/api/v1/repos/snxraven/peardock/releases`
|
||
- Web: `https://git.ssh.surf/snxraven/peardock/releases`
|
||
|
||
## Sitemap
|
||
|
||
- Dynamic: `GET /sitemap.xml` (generated from `dist/` HTML by `server.mjs`)
|
||
- Strict sitemaps.org 0.9: `loc`, `lastmod`, `changefreq`, `priority` only (`text/xml`)
|
||
- Excludes noindex stubs (e.g. `/legal/cookies`)
|
||
- Origin: `SITE_ORIGIN` env (default `https://peardock.boats`)
|
||
- Listed in `robots.txt` as `Sitemap: https://peardock.boats/sitemap.xml`
|
||
|
||
## 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
|
||
npm start
|
||
# or: pm2 start server.mjs --name peardock-website
|
||
```
|