about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorPjotr <wrk@bosa.lan>2026-11-07 14:09:14 +0000
committerPjotr <wrk@bosa.lan>2026-11-07 14:09:14 +0000
commitafcb0b3f48d7ecf61ea41ce99618eef70b1030d1 (patch)
tree9329b8eb8d3a5911db3a51d0ff42cec9fb3b05c1 /docs
parent6cf4673bdd7c1a4607015430838c034814661d51 (diff)
downloadgenenetwork4-afcb0b3f48d7ecf61ea41ce99618eef70b1030d1.tar.gz
docs: SEARCH_ENGINE=native in the nginx deployment's environment
Without it /search forwards to GeneNetwork3 at GN3_URL (:5003) and
answers 502 backend_unreachable when nothing is listening there -- a
correct error, with the error body's links rewritten, but easy to
misread as the proxy being wrong. The deployment has an index, so native
is what it wants.

* docs/nginx.md (The server behind nginx): add the variable and say what
the default does.
* etc/nginx-vesuvio.pu.ac.ke.conf: same, in the start-up comment.
Diffstat (limited to 'docs')
-rw-r--r--docs/nginx.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/nginx.md b/docs/nginx.md
index db7032c..6b7c8e9 100644
--- a/docs/nginx.md
+++ b/docs/nginx.md
@@ -27,9 +27,16 @@ GENENETWORK4_TEST_TOKEN=false \
 AUTH_SERVER_URL=http://127.0.0.1:8081/ \
 SQL_URI=mysql://webqtlout:webqtlout@127.0.0.1/db_webqtl \
 XAPIAN_DB_PATH=/path/to/xapian-index \
+SEARCH_ENGINE=native \
 genenetwork4
 ```
 
+`SEARCH_ENGINE=native` is what makes `/search` use `XAPIAN_DB_PATH`. The
+default is `forward`, which proxies to GeneNetwork3 at `GN3_URL`
+(`127.0.0.1:5003`) -- correct when gn3 is running alongside, and a `502
+backend_unreachable` when it is not, which is easy to mistake for the
+proxy being misconfigured. See docs/search-engines.md.
+
 - `GENENETWORK4_BIND=127.0.0.1` -- nginx is on the same host, so nothing
   else needs the port. The default is `0.0.0.0` (all interfaces).
 - `GENENETWORK4_TEST_TOKEN=false` -- do not register