Files
wadamesh/deploy/README.md
T
Michael A. CojocariandClaude Opus 5 72fb10254f docs: pager cards on the standalone flasher page, and what that page actually is (#289)
Last item on oumike's list. deploy/flasher/ carried two manifests and no pager,
so the board was missing from the standalone install page.

It now has a card per radio variant, both pointing at latest-beta -- the pager is
a beta-feed board, so latest/ is the wrong pointer for it, unlike the two stable
boards already there. Each card names its radio and says so again in the body,
because flashing an LR1121 build onto an SX1262 unit leaves the user with a
device whose radio does not come up, and the two SKUs look identical.

version is set to "beta" rather than a tag. These manifests point at a rolling
feed, so any tag hardcoded here is wrong the moment the next build ships -- which
is what happened to the two existing files, both still claiming beta_1. Worth
fixing those separately or dropping the local copies entirely.

Which leads to the caveat, now written down in deploy/README.md: no deploy script
publishes deploy/flasher/. deploy-site.sh ships deploy/site/ only, and
flasher.wadamesh.com 301s to the apex, so the page users actually reach is
deploy/site/index.html -- which has covered every board for a while. The README
also had the redirect backwards, claiming the apex redirects to the flasher.

So this is parity for a directory that may be dead. Kaj reached the same
conclusion independently in e2d07d8 and left it alone; the files are cheap and
the ticket asked for them, but the real decision is wire it up or delete it, and
that is now stated where someone will find it.

Also refreshes TLORA_PAGER_PORT.md, which still listed the release pipeline as
TODO (both envs have been in release.sh and gen-flasher-meta.py for a while) and
still described CAP_SD/CAP_FILESYSTEM as 0 by design in four places, along with a
deferred-SD list that has almost entirely landed. Only lock-screen wallpaper SD
scanning is genuinely still T-Deck/M9-only. Adds a dated status section at the
top; the milestone narrative below it is kept, since the war stories are why
several non-obvious things are the way they are.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-21 15:43:24 -04:00

93 lines
4.5 KiB
Markdown

# wadamesh.com infrastructure
Distribution stack for wadamesh: a **VPS nginx origin behind Cloudflare**.
```
tiles.wadamesh.com →CF (HTTP, edge-cached) → nginx → OpenStreetMap / OpenTopoMap
firmware.wadamesh.com →CF (cache bins) → nginx → /srv/wadamesh/firmware
flasher.wadamesh.com →CF (HTTPS) → 301 → wadamesh.com
wadamesh.com →CF (HTTPS) → nginx → /srv/wadamesh/site
```
**Map tile styles.** The default `/{z}/{x}/{y}.jpg` route serves **OpenStreetMap**
(the firmware default). An opt-in **OpenTopoMap** topographic style is served from
`/opentopo/{z}/{x}/{y}.jpg` (explicit OSM alias at `/osm/...`); the device requests
it only when the user enables *Map → Options → Topographic map*. Legal: OpenTopoMap
map tiles are **© OpenTopoMap (CC-BY-SA)** over **© OpenStreetMap contributors
(ODbL) + SRTM** — the touch UI shows that attribution when topo is active, and the
14-day disk cache keeps each tile hitting OpenTopoMap at most once per fortnight
(their tile-usage policy asks for a contactable UA + caching, both of which the
transcode service provides). Deploying the topo routes = update
`tiles.wadamesh.com.conf` + `tile-transcode.py`, then
`systemctl restart wadamesh-tile-transcode && nginx -t && systemctl reload nginx`
and purge the Cloudflare cache for `tiles.wadamesh.com/opentopo/*`.
The firmware fetches **tiles + the update-check over plain HTTP** (on-device HTTPS
isn't viable — mbedTLS needs ~30 KB heap, only ~5 KB is free post-Wi-Fi), so the
tile + firmware hosts must stay reachable over HTTP. Cloudflare provides the edge
cache, HTTPS for the flasher, and hides the origin IP (so no IP lives in this repo
or the firmware).
## 1. VPS (origin)
```bash
sudo apt install nginx
sudo mkdir -p /srv/wadamesh/firmware/releases/TOUCH /var/cache/nginx/wadamesh-tiles
sudo cp deploy/nginx/tiles.wadamesh.com.conf /etc/nginx/sites-available/
sudo cp deploy/nginx/firmware.wadamesh.com.conf /etc/nginx/sites-available/
sudo ln -s /etc/nginx/sites-available/tiles.wadamesh.com.conf /etc/nginx/sites-enabled/
sudo ln -s /etc/nginx/sites-available/firmware.wadamesh.com.conf /etc/nginx/sites-enabled/
sudo nginx -t && sudo systemctl reload nginx
```
## 2. Cloudflare
- **DNS:** `A`/`AAAA` records for `tiles`, `firmware`, `flasher`, `@` → the VPS IP,
all **Proxied** (orange cloud).
- **SSL/TLS:** mode **Flexible** (CF↔origin HTTP) is enough since the origin is
HTTP-only. **Do NOT enable "Always Use HTTPS"** on `tiles.` or `firmware.` — the
firmware needs plain HTTP there.
- **Cache Rules:**
- `tiles.wadamesh.com/*` → Eligible for cache, Edge TTL ~14d.
- `firmware.wadamesh.com/releases/*/*.bin` → cache, Edge TTL ~1d.
- `firmware.wadamesh.com/releases/TOUCH` (the listing) → short TTL (~60s) or
Bypass, so new releases appear promptly.
## 3. Publishing a release
From a wadamesh checkout (builds both boards, refreshes the listing, rsyncs up):
```bash
WADAMESH_VPS=user@your-vps scripts/release.sh beta_2
```
The on-device check GETs `http://firmware.wadamesh.com/releases/TOUCH`, finds the
highest `beta_<N>`, and (once OTA-over-Wi-Fi is re-enabled) pulls
`…/releases/TOUCH/beta_<N>/<board>.bin`.
## Done
- **Web flasher** ✅ — the guided install page at `wadamesh.com`, served from
`deploy/site/` and published by `scripts/deploy-site.sh` (esp-web-tools / Web
Serial, per-board install buttons + .bin downloads, manifests generated per
release by `scripts/build/gen-flasher-meta.py` into the `/latest/` and
`/latest-beta/` feeds that `release.sh` refreshes each publish).
- **`flasher.wadamesh.com` 301-redirects to the apex** (see
`deploy/nginx/flasher.wadamesh.com.conf`) — it is an alias, not its own page.
- **`deploy/flasher/`** is the original standalone flasher page. **No deploy
script publishes it** — `deploy-site.sh` ships `deploy/site/` only — so it is
effectively an offline/local copy kept in parity by hand. Retire it or wire it
into a deploy target; until then, treat `deploy/site/index.html` as the only
install page users can reach.
## TODO before public launch
- **Re-enable OTA-over-Wi-Fi** in the firmware (currently it version-checks then
defers to manual flashing).
- **Flip `wadamesh` repo public** = launch.
- Decide tile-proxy sharing: dedicated `tiles.wadamesh.com` (this config) vs
reusing the meshcomod proxy.
> Never commit the VPS IP, SSH keys, or `WADAMESH_VPS`. Cloudflare fronts the
> origin; the deploy target is supplied via the environment at publish time.