about summary refs log tree commit diff
path: root/docs/nginx.md
diff options
context:
space:
mode:
authorPjotr <wrk@bosa.lan>2026-11-07 14:40:00 +0000
committerPjotr <wrk@bosa.lan>2026-11-07 14:40:00 +0000
commitf346dc273ef38cdb268fd68bb5697a8ee30e5fde (patch)
treefa68a18aefe6f530b4dab5bbaa42c557a3cb4127 /docs/nginx.md
parentafcb0b3f48d7ecf61ea41ce99618eef70b1030d1 (diff)
downloadgenenetwork4-f346dc273ef38cdb268fd68bb5697a8ee30e5fde.tar.gz
docs/www: rewrite the AI instructions for the live deployment
ai-instruction.md was written before anything was deployed: it took a
placeholder base URL, did not say where the API is mounted, and buried
the operator's deployment notes in an appendix labelled "not for the AI
reader" -- awkward to hand to an assistant, and confusing when it is.

So: the AI-facing page now names the deployment
(https://vesuvio.pu.ac.ke/gn4) and is self-contained, and the operator
material moves to operator-checklist.md. Everything in the page was
exercised against the running deployment.

Content changes, beyond the move:

* `next` hrefs arrive already prefixed (`/gn4/groups/BXD/strains`), so
  they resolve against the origin -- joining them to the current URL's
  directory double-prefixes them. Said plainly, since it is the one
  thing the prefix breaks.
* says what cannot work and should not be retried: get-test-token is a
  404, /compute/* is a 403 from the front end, and neither is a
  permissions problem to work around.
* `/publications/{pubmed_id}/traits` wants the PubMed id, not the
  internal `publication_id` in the same trait record, which 404s.
* states the current rate-limit position (none configured) instead of
  implying a 429 policy that does not exist yet.

* docs/www/ai-instruction.md: rewritten, paste-ready.
* docs/www/operator-checklist.md: new file, the former appendix, updated
  with what is now enforced at the proxy and a record of the verified
  request matrix.
* README.md, docs/nginx.md, etc/nginx-vesuvio.pu.ac.ke.conf: point at
  the operator checklist by its new name.
Diffstat (limited to 'docs/nginx.md')
-rw-r--r--docs/nginx.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/nginx.md b/docs/nginx.md
index 6b7c8e9..414d0e4 100644
--- a/docs/nginx.md
+++ b/docs/nginx.md
@@ -142,7 +142,7 @@ the same thing as a complete, drop-in file -- TLS, log format, the `/gn4`
 redirect, and the `/compute/` and `/get-test-token` refusals. Note that
 it refuses `/compute/*`: those endpoints take server-side file paths, so
 they belong on the internal listener only (see the operator checklist in
-[`docs/www/ai-instruction.md`](www/ai-instruction.md)); drop the two
+[`docs/www/operator-checklist.md`](www/operator-checklist.md)); drop the two
 `location` lines only if every token holder may read the server's files.
 
 `http2 on;` needs nginx >= 1.25.1; on older versions use `listen 443