Fix catalog PDF links; add bring-online guide; feature zappier billing
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
PDFs rewrite in-document .md/.html links to sibling PDFs. Catalog start page is GETTING-STARTED (install, first-up, monitor). Billing and user platform is zappier-edge (original ~/zappier tree).
This commit is contained in:
parent
e401635fd6
commit
65bfa544b2
10 changed files with 149 additions and 25 deletions
|
|
@ -1,6 +1,8 @@
|
|||
# Documentation index
|
||||
|
||||
Read **high-level first**, then **architecture**, then the rest. Live catalog (PDF by default): https://zapier.georgelambert.org/ — [Markdown indexes](https://zapier.georgelambert.org/index-md.html)
|
||||
**Bring the system online:** https://zapier.georgelambert.org/packages/verae-ops/GETTING-STARTED.pdf
|
||||
|
||||
Live catalog (PDF by default): https://zapier.georgelambert.org/ — [Markdown indexes](https://zapier.georgelambert.org/index-md.html)
|
||||
|
||||
Operator console (loopback): http://127.0.0.1:3850/ · [CONSOLE.pdf](https://zapier.georgelambert.org/packages/verae-fleet/docs/CONSOLE.pdf)
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
High-level description of the whole system: what it is, which **independent git repositories** implement it, how it stays up, how it behaves when the local network fails, and how it talks to the **central Verae NATS.IO 3-server cluster**. New work is added by **new address routing**, not by teaching Zapier about NATS.
|
||||
|
||||
**This repo:** https://git.georgelambert.org/marchon/overview
|
||||
**Bring online:** https://zapier.georgelambert.org/packages/verae-ops/GETTING-STARTED.pdf
|
||||
**Live catalog (PDF by default):** https://zapier.georgelambert.org/ · [Markdown indexes](https://zapier.georgelambert.org/index-md.html)
|
||||
**Clone:** `ssh://git@git.georgelambert.org:2223/marchon/overview.git`
|
||||
|
||||
|
|
|
|||
95
packages/verae-ops/GETTING-STARTED.md
Normal file
95
packages/verae-ops/GETTING-STARTED.md
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
# Bring Verae Time × Zapier online
|
||||
|
||||
This is the **top document** for install, first-up, and monitoring. Platform-specific detail lives in the numbered ops chapters; do not start there.
|
||||
|
||||
**Catalog:** https://zapier.georgelambert.org/packages/verae-ops/GETTING-STARTED.pdf
|
||||
**Billing / users (zappier-edge):** https://zapier.georgelambert.org/packages/zappier/docs/USER-MANUAL.pdf
|
||||
**Operator console:** http://127.0.0.1:3850/ (loopback) · https://zapier.georgelambert.org/packages/verae-fleet/docs/CONSOLE.pdf
|
||||
|
||||
## What you are turning on
|
||||
|
||||
| Piece | Job | Default |
|
||||
|-------|-----|---------|
|
||||
| **zappier-edge** | Billing, API keys, customer portal, admin, Stripe | `:3000` public HTTPS |
|
||||
| **verae-middleware** | Zapier `/zapier/v1`, chain, NATS | `:3100` |
|
||||
| **NATS JetStream** | Private jobs / archive | `:4222` **not public** |
|
||||
| **worm ×3, tree-node ×3** | Off-chain files and Merkle leaves | fleet floor |
|
||||
| **fleet** | Replica floors, SSH hosts, Trace, Docs | `:3850` loopback |
|
||||
|
||||
Zapier cloud talks **only** to zappier-edge over HTTPS.
|
||||
|
||||
The billing and user platform is the standalone **zappier** project (`/Users/marchon/zappier`, Forgejo [zappier-edge](https://git.georgelambert.org/marchon/zappier-edge)): portal signup, TOTP, API keys, rate card, Stripe meter, PO invoices, admin users. Verae middleware does **not** replace it.
|
||||
|
||||
## 15-minute lab (one machine)
|
||||
|
||||
```bash
|
||||
git clone ssh://git@git.georgelambert.org:2223/marchon/master-zapier-plan-draft.git
|
||||
cd master-zapier-plan-draft
|
||||
export MONOREPO="$PWD"
|
||||
cd packages/verae-ops
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
Check:
|
||||
|
||||
```bash
|
||||
curl -fsS http://127.0.0.1:3000/health # zappier-edge (billing + users)
|
||||
curl -fsS http://127.0.0.1:3100/health # middleware
|
||||
```
|
||||
|
||||
Open:
|
||||
|
||||
- Customer portal: http://127.0.0.1:3000/portal — sign up, copy `x-api-key`
|
||||
- Admin: http://127.0.0.1:3000/admin
|
||||
- API docs: http://127.0.0.1:3000/docs
|
||||
|
||||
Do **not** publish NATS `4222`.
|
||||
|
||||
## Operator console (monitor)
|
||||
|
||||
On the same machine (or SSH tunnel `ssh -L 3850:127.0.0.1:3850 user@host`):
|
||||
|
||||
```bash
|
||||
cd "$MONOREPO/packages/verae-fleet"
|
||||
node src/cli.js serve
|
||||
```
|
||||
|
||||
http://127.0.0.1:3850/ — Fleet (green/yellow/red), Trace, Docs. Tree-node **min 3**; pause does not count.
|
||||
|
||||
```bash
|
||||
node src/cli.js status
|
||||
node src/cli.js ssh-check ns1
|
||||
```
|
||||
|
||||
## Point Zapier at the lab
|
||||
|
||||
1. TLS in front of `:3000` (Caddy).
|
||||
2. Zapier app env: `MIDDLEWARE_BASE_URL=https://<zappier-host>` (edge meters, then proxies to middleware).
|
||||
3. Connect with the portal API key.
|
||||
|
||||
## Production (pick one)
|
||||
|
||||
| Where | Read |
|
||||
|-------|------|
|
||||
| Docker | [02-docker.pdf](02-docker.pdf) |
|
||||
| Proxmox | [03-proxmox.pdf](03-proxmox.pdf) |
|
||||
| Cloud VMs | [04-virtual-servers.pdf](04-virtual-servers.pdf) |
|
||||
| Dedicated / NS1 | [05-dedicated-hardware.pdf](05-dedicated-hardware.pdf) |
|
||||
| Env vars & NATS | [06-linking-services.pdf](06-linking-services.pdf) |
|
||||
| Backup / upgrade | [07-maintenance.pdf](07-maintenance.pdf) |
|
||||
|
||||
## Daily monitor
|
||||
|
||||
| Check | Expect |
|
||||
|-------|--------|
|
||||
| `curl -fsS https://zappier.example.com/health` | 200 |
|
||||
| `curl -fsS https://middleware.example.com/health` | 200 |
|
||||
| NATS `http://127.0.0.1:8222/healthz` on each node | ok (localhost only) |
|
||||
| Fleet tree-node available ≥ 3 | green |
|
||||
| Portal login + key still works | 200 `/v1/status` with `x-api-key` |
|
||||
|
||||
## If something is red
|
||||
|
||||
1. Fleet row color: yellow = paused/degraded, red = below floor — `restart` that replica.
|
||||
2. 401/402 from Zapier → zappier-edge keys and rate card, not NATS.
|
||||
3. Archive lookup empty → bloom miss is **silence**; check worm/tree floors, not “error replies”.
|
||||
|
|
@ -11,6 +11,7 @@ This is the operations repo. Application code lives in the other independent git
|
|||
|
||||
## Reading order
|
||||
|
||||
0. **[GETTING-STARTED.md](GETTING-STARTED.md)** — install, first-up, monitor (read this first)
|
||||
1. [01-dependencies.md](01-dependencies.md) — what must exist, who talks to whom
|
||||
2. [02-docker.md](02-docker.md) — Compose (NATS 3-node cluster + HTTPS edges)
|
||||
3. [03-proxmox.md](03-proxmox.md) — LXC / QEMU VMs
|
||||
|
|
|
|||
|
|
@ -5,8 +5,11 @@ monthly credits, a usage ledger, Stripe metered billing, purchase-order
|
|||
invoicing, a company admin console, a self-service customer portal, and a
|
||||
Zapier integration.
|
||||
|
||||
This is the **billing and user platform** (originally the standalone `zappier` git tree at `~/zappier`). Forgejo name: **zappier-edge**. It owns signup, TOTP, API keys, rate card, Stripe meter, PO invoices, admin users, and the customer portal. Verae middleware does not replace this.
|
||||
|
||||
**Forgejo:** https://git.georgelambert.org/marchon/zappier-edge
|
||||
**Catalog README:** https://zapier.georgelambert.org/packages/zappier/README.pdf
|
||||
**Catalog README:** https://zapier.georgelambert.org/packages/zappier/README.pdf
|
||||
**Bring the whole system online:** https://zapier.georgelambert.org/packages/verae-ops/GETTING-STARTED.pdf
|
||||
|
||||
## Documentation (public PDFs)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue