Add SearchXNG and SethSearch project context docs

2026-03-13 05:29:34 +00:00
commit 8d323c9393
7 changed files with 199 additions and 0 deletions
@@ -0,0 +1,36 @@
+# Operations Runbook
+
+## Common commands
+
+- SethSearch service status:
+  - `ssh pve173 "pct exec 620 -- systemctl status sethsearch --no-pager"`
+- SethSearch logs:
+  - `ssh pve173 "pct exec 620 -- journalctl -u sethsearch -n 100 --no-pager"`
+- SearXNG service status:
+  - `ssh pve173 "pct exec 119 -- systemctl status searxng --no-pager"`
+- SearXNG logs:
+  - `ssh pve173 "pct exec 119 -- journalctl -u searxng -n 100 --no-pager"`
+
+## Verify behavior
+
+- General search endpoint:
+  - `curl -s "https://sethsearch.sethpc.xyz/search?q=home&source=general&limit=5"`
+- Sethflix endpoint:
+  - `curl -s "https://sethsearch.sethpc.xyz/search?q=always%20sunny&source=sethflix&limit=5"`
+- Stats:
+  - `curl -s "https://sethsearch.sethpc.xyz/stats"`
+
+## Config touchpoints
+
+- SethSearch config: `/opt/sethsearch/config.json`
+- SethSearch code: `/opt/sethsearch/sethsearch.py`
+- SearXNG config: `/etc/searxng/settings.yml`
+- Caddy config: `/etc/caddy/Caddyfile`
+
+## Change protocol
+
+1. Edit SethSearch code/config.
+2. Restart SethSearch and verify `/health` and `/stats`.
+3. Edit SearXNG engines (if needed).
+4. Restart SearXNG and verify `/config` engine list.
+5. Validate top query use-cases.