docs(auth): add sign-in troubleshooting runbook (#2386)

2026-07-27 21:08:00 +00:00 · 2026-05-22 16:41:19 +05:30
parent 72fb7a8d5e
commit c14a196967
2 changed files with 63 additions and 0 deletions
@@ -4,6 +4,7 @@

 * [Welcome to OpenHuman](README.md)
 * [Getting Started](overview/getting-started.md)
+* [Troubleshooting Sign-In](overview/troubleshooting-sign-in.md)

 ## Features

@@ -0,0 +1,62 @@
+---
+description: >-
+  Diagnose sign-in failures, OAuth callbacks that do not complete, and remote
+  core RPC authentication problems.
+icon: key
+---
+
+# Troubleshooting Sign-In
+
+Use this checklist when social sign-in hangs, returns to the welcome screen, or the core logs an unauthorized `/auth` request.
+
+## Check backend reachability
+
+From the same network as the desktop app, verify the public OpenHuman endpoints:
+
+```bash
+curl -I https://tinyhumans.ai/
+curl -I https://api.tinyhumans.ai/health
+```
+
+If the website loads but the API endpoint fails, the desktop app may not be able to exchange OAuth callbacks for a session. Capture the HTTP status, region, and DNS result in the issue report.
+
+## Check the selected core
+
+If you use the **Advanced** remote-core mode, confirm both the RPC URL and bearer token before starting OAuth:
+
+```bash
+curl -sS https://your-core.example/rpc \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer CORE_TOKEN" \
+  -d '{"jsonrpc":"2.0","id":1,"method":"core.ping","params":{}}'
+```
+
+A `401` response means the desktop token and remote core token do not match. Fix that before retrying Google or GitHub sign-in.
+
+## Check the deep-link callback
+
+Successful desktop OAuth ends with an `openhuman://auth?...` callback. If the browser shows that URL but the app stays on the welcome screen:
+
+1. Make sure only one OpenHuman desktop instance is running.
+2. Restart the app, keep the same remote-core settings, and retry sign-in.
+3. If using a remote core, check whether the core receives `openhuman.auth_store_session`.
+
+For a remote core, a temporary manual injection can confirm the core is otherwise healthy:
+
+```bash
+curl -sS https://your-core.example/rpc \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer CORE_TOKEN" \
+  -d '{"jsonrpc":"2.0","id":1,"method":"openhuman.auth_store_session","params":{"token":"JWT_FROM_CALLBACK"} }'
+```
+
+Do not paste real JWTs into public GitHub issues. Redact tokens and attach only status codes, hostnames, app version, OS, and the relevant log lines.
+
+## What to include in a bug report
+
+* App version and OS.
+* Whether the core mode is local or remote.
+* The RPC URL host, redacted token status, and `core.ping` result.
+* The OAuth provider used.
+* Whether an `openhuman://auth` URL appeared in the browser.
+* The first unauthorized log line, if present.