George Lambert
a32c91475c
Some checks are pending
offline / test (push) Waiting to run
High-level system map with diagrams, TOC, and a docs index. Template worker shows how to add a new verae.* address for search, storage, or unplanned functions without teaching Zapier NATS.
56 lines
2.9 KiB
Markdown
56 lines
2.9 KiB
Markdown
# zapier-docs-master
|
||
|
||
Summaries, NATS contracts, and message flows for every Verae Time × Zapier module.
|
||
|
||
**Live catalog:** https://zapier.georgelambert.org/
|
||
**Monorepo:** https://git.georgelambert.org/marchon/master-zapier-plan-draft (`main` and `master`)
|
||
|
||
## Git repos (Forgejo on NS1)
|
||
|
||
| Repo | URL |
|
||
|------|-----|
|
||
| master-zapier-plan-draft | https://git.georgelambert.org/marchon/master-zapier-plan-draft |
|
||
| zappier-edge | https://git.georgelambert.org/marchon/zappier-edge |
|
||
| verae-middleware | https://git.georgelambert.org/marchon/verae-middleware |
|
||
| verae-zapier-app | https://git.georgelambert.org/marchon/verae-zapier-app |
|
||
| verae-activate | https://git.georgelambert.org/marchon/verae-activate |
|
||
| verae-request-splitter | https://git.georgelambert.org/marchon/verae-request-splitter |
|
||
| verae-archive-worm | https://git.georgelambert.org/marchon/verae-archive-worm |
|
||
| verae-archive-aggregator | https://git.georgelambert.org/marchon/verae-archive-aggregator |
|
||
| verae-tree-node | https://git.georgelambert.org/marchon/verae-tree-node |
|
||
| verae-zapier-simulator | https://git.georgelambert.org/marchon/verae-zapier-simulator |
|
||
| zapier-user-docs | https://git.georgelambert.org/marchon/zapier-user-docs |
|
||
| verae-fleet | https://git.georgelambert.org/marchon/verae-fleet |
|
||
| **overview** | https://git.georgelambert.org/marchon/overview |
|
||
| verae-nats-process | https://git.georgelambert.org/marchon/verae-nats-process |
|
||
| **zapier-docs-master** (this repo) | https://git.georgelambert.org/marchon/zapier-docs-master |
|
||
|
||
Clone (SSH port 2223):
|
||
|
||
`git clone ssh://git@git.georgelambert.org:2223/marchon/<name>.git`
|
||
|
||
## Modules
|
||
|
||
| Module | Summary | NATS in | NATS out |
|
||
|--------|---------|---------|----------|
|
||
| zappier-edge | Metered HTTPS for Zapier | — | — (HTTPS to middleware) |
|
||
| verae-middleware | Job id + wait HTTP | jobs.events | jobs.watch |
|
||
| verae-activate | Pushable Zapier app | — | — |
|
||
| verae-zapier-app | Full Zapier nouns | — | — |
|
||
| request-splitter | Hash vs files | — | archive.put |
|
||
| archive-worm | Bloom WORM node | archive.query, archive.put | archive.reply.* (hit only) |
|
||
| archive-aggregator | Merge archive replies | archive.reply.* | archive.query |
|
||
| tree-node | Merkle leaf proofs | archive.query, archive.put | archive.reply.* (hit only) |
|
||
| zapier-simulator | Trace console (in-process) | — | — |
|
||
| zapier-user-docs | Signup → lookup guide | — | — |
|
||
| verae-fleet | Replica floors + monitor | — | — |
|
||
| overview | System map | — | — |
|
||
| nats-process | Template worker | example.process.in | example.process.out / reply.* |
|
||
|
||
## Documents in this repo
|
||
|
||
- [MESSAGE-FLOWS.md](MESSAGE-FLOWS.md) — numbered request paths
|
||
- [modules-and-nats.md](modules-and-nats.md) — address table
|
||
- [archive-nats.md](archive-nats.md) — bloom / multi-receipt design
|
||
- [composition.md](composition.md) — HTTPS hops
|
||
- `modules/<name>/SUMMARY.md` and `NATS.md`
|