aboutsummaryrefslogtreecommitdiff
path: root/castle-search/README.md
diff options
context:
space:
mode:
authorIgor Soarez <igor@soarez.org>2026-11-18 10:50:14 +0000
committerIgor Soarez <igor@soarez.org>2026-11-18 10:50:14 +0000
commit910ac7cd424f6401ea042a84603c42ba055994f8 (patch)
tree3ff40da7d14c644428c71cab1b005eca0b186d13 /castle-search/README.md
parent39f887e07721c5b3ddd31657e5e8e25e4486d2e5 (diff)
castle-search: sign X back in when a search finds it signed out
Username, password, the authenticator code (TOTP) and, when X asks, the code it emails, read over IMAP. At most one try per 30 minutes, the password never sent twice, and any unknown step (a captcha) fails saying a person has to sign in. Details from the file CCS_X_LOGIN_FILE names.
Diffstat (limited to 'castle-search/README.md')
-rw-r--r--castle-search/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/castle-search/README.md b/castle-search/README.md
index 1b80994..1b74884 100644
--- a/castle-search/README.md
+++ b/castle-search/README.md
@@ -66,6 +66,15 @@ that comes sooner waits), and at most 30 an hour and 150 a day, beyond which a
search fails saying when the next may run. The counts live in memory, so a
restart starts them afresh.
+Signed out, it signs back in by itself when `CCS_X_LOGIN_FILE` names a JSON
+file of the account's details (`src/x-login.ts`): `username`, `password`,
+`totpSecret` (the authenticator app's base32 secret) and, optionally, `imap`
+(`host`, `user`, `password`) for the code X emails when a sign-in looks
+unusual, read from the subject over IMAP (`src/imap.ts`). Then it searches
+again, once. It tries at most once every 30 minutes, never sends the password
+twice in one try, and stops at any step it does not recognise, such as a
+captcha, saying a person has to sign in. A sign-in takes about 6 s.
+
## Engines
Four, with independent indexes and independent rate limits. That last part is