Jinemi/thermograph
4
0
Fork 0
Code Issues 2 Pull requests 9 Projects Releases Packages Wiki Activity Actions
thermograph/deploy/thermograph.env.example

42 lines
2.4 KiB
Text
Raw Normal View History

Initial commit: app + VPS deploy pipeline
2026-07-11 00:29:47 +00:00
# Copy to /etc/thermograph.env on the VPS and edit.
# Read by the systemd unit (EnvironmentFile).
# Port uvicorn binds on loopback. Caddy proxies to this. Keep 8137 unless it clashes.
PORT=8137
# Base path the app is served under.
Serve the app on thermograph.org at root; redirect emigriffith.dev/thermograph (#91) Move Thermograph to its own domain. thermograph.org now serves the app at its root, and emigriffith.dev/thermograph* permanently redirects there (prefix stripped, so deep links map straight across). - app.py: BASE now supports an empty root prefix. THERMOGRAPH_BASE=/ (or empty) yields BASE="" so routes sit at "/", "/calendar", "/api/v2/…" with no double slashes; the bare-base redirect is skipped and the static mount falls back to "/". Non-empty values keep the existing "/thermograph" sub-path behavior unchanged (backward compatible). - deploy/Caddyfile: add a thermograph.org site block reverse-proxying to the uvicorn on 127.0.0.1:8137; turn emigriffith.dev's /thermograph handler into a permanent redirect to thermograph.org (handle_path strips the prefix; the bare /thermograph goes to the root). - deploy/thermograph.env.example: default THERMOGRAPH_BASE=/ (app owns the domain). - DEPLOY.md: document the two-domain layout and that deploy.sh does not ship the Caddyfile or env — those are applied on the VPS by hand. The frontend already uses base-relative URLs, so it follows the root base with no changes. Verified both modes locally (root serves /, /calendar, /api/v2/*; the /thermograph sub-path still redirects bare→slash and 404s at root) and the full test suite (123) passes.
2026-07-15 19:58:32 +00:00
# / -> app at the domain root (Thermograph owns the whole domain —
# this is what the Caddyfile expects: thermograph.org proxies "/")
Scope app to /thermograph, free the domain root for a portfolio (#10) - Drop the app-level "/" redirect so the FastAPI app no longer claims the domain root; it stays scoped to THERMOGRAPH_BASE (/thermograph). Root now 404s at the app, leaving it for another service behind the proxy. - Caddyfile: serve a static portfolio at / and reverse-proxy /thermograph* to uvicorn, on emigriffith.dev with automatic Let's Encrypt TLS. - Default THERMOGRAPH_BASE to /thermograph in the env example to match.
2026-07-11 03:01:16 +00:00
# /thermograph -> app under a sub-path (share the host with other apps, e.g. a
Serve the app on thermograph.org at root; redirect emigriffith.dev/thermograph (#91) Move Thermograph to its own domain. thermograph.org now serves the app at its root, and emigriffith.dev/thermograph* permanently redirects there (prefix stripped, so deep links map straight across). - app.py: BASE now supports an empty root prefix. THERMOGRAPH_BASE=/ (or empty) yields BASE="" so routes sit at "/", "/calendar", "/api/v2/…" with no double slashes; the bare-base redirect is skipped and the static mount falls back to "/". Non-empty values keep the existing "/thermograph" sub-path behavior unchanged (backward compatible). - deploy/Caddyfile: add a thermograph.org site block reverse-proxying to the uvicorn on 127.0.0.1:8137; turn emigriffith.dev's /thermograph handler into a permanent redirect to thermograph.org (handle_path strips the prefix; the bare /thermograph goes to the root). - deploy/thermograph.env.example: default THERMOGRAPH_BASE=/ (app owns the domain). - DEPLOY.md: document the two-domain layout and that deploy.sh does not ship the Caddyfile or env — those are applied on the VPS by hand. The frontend already uses base-relative URLs, so it follows the root base with no changes. Verified both modes locally (root serves /, /calendar, /api/v2/*; the /thermograph sub-path still redirects bare→slash and 404s at root) and the full test suite (123) passes.
2026-07-15 19:58:32 +00:00
# portfolio at the root)
THERMOGRAPH_BASE=/
Add IndexNow, stable sitemap lastmod, and search-verification meta (#127) Faster search-engine indexing for the ~14k climate/city/record URLs: - IndexNow (backend/indexnow.py): instantly notify Bing/DuckDuckGo/Yandex of new or changed URLs. Per-host key resolved env → gitignored file → generated (mirrors push.py), served at /{key}.txt, and echoed in submissions. `submit_all()` + a `make indexnow` CLI push every indexable URL, batched under the 10k cap. Google doesn't use IndexNow, so it stays on the sitemap. - Sitemap: replace the per-request today() <lastmod> (which churns every fetch and trains crawlers to ignore lastmod) with a stable content-build date; factor the URL list into public_paths() shared with IndexNow so the two never drift. - Search-console verification: render google-site-verification + msvalidate.01 <meta> tags from env into every page's <head> — the SEO pages via base.html.j2 and the static pages (incl. the homepage Google verifies) via _page(). - Docs: env example documents the three new vars; .gitignore ignores the key. Tests: key-file route, stable single-date lastmod, IndexNow payload/batching, and verification meta on both SEO and static pages.
2026-07-16 18:08:09 +00:00
# --- SEO: search-engine verification + IndexNow ---------------------------------
# Ownership-verification tokens, rendered as <meta> tags in every page's <head>.
# Google Search Console → add property https://thermograph.org → "HTML tag" method
# → paste just the content="…" value below. (Or verify via DNS TXT and skip this.)
#THERMOGRAPH_GOOGLE_VERIFY=
# Bing Webmaster Tools → add site → "HTML Meta Tag" (msvalidate.01) → paste the
# content value. (Bing can also import verification from Google Search Console.)
#THERMOGRAPH_BING_VERIFY=
# IndexNow key (Bing/DuckDuckGo/Yandex instant re-crawl). Auto-generated to
# data/indexnow_key.txt on first use; set here to pin a specific key.
#THERMOGRAPH_INDEXNOW_KEY=
Auto-submit IndexNow on deploy when the URL set changes (#130) Hook the production deploy (deploy/deploy.sh) to ping IndexNow after the health check passes, so new/changed pages reach Bing/DuckDuckGo/Yandex without a manual run. Best-effort — wrapped so it can never fail a deploy — and it sources /etc/thermograph.env so its key matches the one the running service serves. To avoid re-blasting ~14k URLs on every code push, indexnow.py gains a --if-changed mode gated by a signature of the URL set (persisted to data/indexnow_state.txt): code-only deploys skip; a deploy that adds or removes a city submits. `make indexnow` still forces a full submit.
2026-07-16 20:38:59 +00:00
# Public site URL for IndexNow. The deploy hook auto-pings IndexNow after a
# successful deploy, but only when the URL set changed (a new/removed city), so
# code-only deploys don't resubmit. `make indexnow` forces a full submit.
Add IndexNow, stable sitemap lastmod, and search-verification meta (#127) Faster search-engine indexing for the ~14k climate/city/record URLs: - IndexNow (backend/indexnow.py): instantly notify Bing/DuckDuckGo/Yandex of new or changed URLs. Per-host key resolved env → gitignored file → generated (mirrors push.py), served at /{key}.txt, and echoed in submissions. `submit_all()` + a `make indexnow` CLI push every indexable URL, batched under the 10k cap. Google doesn't use IndexNow, so it stays on the sitemap. - Sitemap: replace the per-request today() <lastmod> (which churns every fetch and trains crawlers to ignore lastmod) with a stable content-build date; factor the URL list into public_paths() shared with IndexNow so the two never drift. - Search-console verification: render google-site-verification + msvalidate.01 <meta> tags from env into every page's <head> — the SEO pages via base.html.j2 and the static pages (incl. the homepage Google verifies) via _page(). - Docs: env example documents the three new vars; .gitignore ignores the key. Tests: key-file route, stable single-date lastmod, IndexNow payload/batching, and verification meta on both SEO and static pages.
2026-07-16 18:08:09 +00:00
THERMOGRAPH_BASE_URL=https://thermograph.org
Push: surface delivery failures (no longer a silent success) (#157) A failed web push (e.g. VAPID key mismatch -> 401/403) was swallowed: /push/test still returned 202 and the UI showed 'Sent', while the only trace was a journald WARNING. Now: push.send logs failures to the errors JSONL (phase=push) so they show up like other errors; /push/test returns a 'failed' count; and the 'Send test' button reports 'No device' / 'Sent' / 'Failed' from the real result. Document the VAPID env vars (missing from thermograph.env.example) and how to pin/diagnose them.
2026-07-17 00:12:14 +00:00
# --- Web Push (VAPID) -----------------------------------------------------------
# Keys that sign push notifications. If unset, the app generates a pair into
# data/vapid.json on first run — fine as long as that file PERSISTS (it lives in the
# writable data dir and survives deploys). PIN them here to be safe: if the keys ever
# change, every existing browser subscription silently stops receiving (the push
# service rejects with 401/403), and users must toggle alerts off/on to re-subscribe.
# Generate a pair: cd backend && ../.venv/bin/python -c "import push,json; k=push._generate(); print('PRIVATE=',k['private_key']); print('PUBLIC=',k['public_key'])"
#THERMOGRAPH_VAPID_PRIVATE_KEY=
#THERMOGRAPH_VAPID_PUBLIC_KEY=
# Contact (mailto: or https URL) sent to push services in the VAPID claim.
#THERMOGRAPH_VAPID_CONTACT=mailto:you@example.com
Reference in a new issue Copy permalink