peardock-website

Official marketing site and documentation for peardock (source).

Code-level architecture docs live in the peardock repo under docs/. This site is the public operator mirror (HTML) plus marketing pages. Keep claims in sync when the product changes.

Install story (keep in sync with main repo)

Canonical installer host: https://install.peardock.boats

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 peardocks 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

Product / feature docs (keep in sync)

When peardock ships UI or RPC surface changes, update:

Area Website files
Features marketing index.html (#features, deep feature rows, screenshot alts)
Operator production guide docs/operator.html
RPC method groups docs/api.html
Architecture sketch docs/architecture.html
Concepts explainer learn/index.html
Auth / threat model docs/security.html
FAQ docs/faq.html
Docs hub blurbs docs/index.html
Screenshots public/assets/screenshots/screenshot-N.png (dark) + screenshot-N-light.png (light); theme toggle swaps via site.js

Especially check claims for:

  • Registry view (vault + browser). Not under “Access → Registry vault”.
  • Settings → Peers vs Access (ACL/invites)
  • Image update indicators / checkImageUpdates
  • Job tray + hybrid pull progress
  • Portainer-style templates / Add container / always-pull
  • Stack remove = project networks (compose down parity)
  • PROTOCOL_VERSION (currently 3)

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

npm install
npm run dev      # Vite (proxies /api/releases → Gitea)
npm run build    # → dist/
npm start        # static dist + Gitea proxy (PORT=4173)

Production

npm run build
npm start
# or: pm2 start server.mjs --name peardock-website
S
Description
No description provided
Readme
18 MiB
Languages
HTML 44.9%
CSS 37.1%
JavaScript 18%