Skip to content

Commit eae1f7b

Browse files
committed
docs(troubleshooting): clarify Hermes API forward recovery
Signed-off-by: Rebecca Sliter <571084+rsliter@users.noreply.github.com>
1 parent e0fd772 commit eae1f7b

2 files changed

Lines changed: 12 additions & 5 deletions

File tree

docs/reference/troubleshooting.mdx

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4893,7 +4893,7 @@ Expected output:
48934893
Point an OpenAI-compatible client at `http://127.0.0.1:8642/v1` for chat completions.
48944894
For terminal use, run `nemohermes launch <name>`.
48954895

4896-
### Onboarding Reports "Hermes is not ready" With an Unreachable API Port
4896+
### Onboarding Reports Hermes Is Not Ready With an Unreachable API Port
48974897

48984898
Deployment verification probes the OpenAI-compatible API inside the sandbox and through its host-side API port forward.
48994899
When the API answers inside the sandbox but its host-side API port forward is unreachable, verification reports the API port forward as failed.
@@ -4904,7 +4904,12 @@ Onboarding then prints `Hermes is not ready` and exits with a nonzero status:
49044904
The OpenAI-compatible API on port 8642 is not reachable from the host. Run: openshell forward start --background 8642 <name>
49054905
```
49064906

4907-
The API remains reachable inside the sandbox.
4907+
Use the forward recovery below only when the in-sandbox `gateway` check passed.
4908+
The output omits passing checks, so confirm that it contains no `gateway` failure.
4909+
If the output contains a `gateway` failure, follow that diagnostic first.
4910+
Do not restart the host forward until the in-sandbox API responds.
4911+
4912+
When the `gateway` check passed and only the `api` check failed, the API remains reachable inside the sandbox.
49084913
Each Hermes sandbox owns an API port allocated from `8642` through `8652`, so use the port from the `api` diagnostic instead of assuming the default.
49094914
First, list the active OpenShell port forwards:
49104915

@@ -4927,10 +4932,12 @@ Do not run the health probe after `openshell forward start` fails.
49274932
After `openshell forward start` exits with status `0`, probe the health endpoint:
49284933

49294934
```bash
4930-
curl -sf http://127.0.0.1:<port>/health
4935+
curl -sS -o /dev/null -w '%{http_code}\n' --max-time 3 http://127.0.0.1:<port>/health
49314936
```
49324937

4933-
If the health probe still refuses connections, rerun `$$nemoclaw onboard` to collect fresh verification diagnostics.
4938+
An HTTP status of `200` or `401` means the host port forward is reachable.
4939+
Any other status, `000`, or connection failure requires fresh diagnostics.
4940+
Rerun `$$nemoclaw onboard` and follow the reported `gateway` or `api` failure.
49344941

49354942
### `docker port` shows no mapping for 8642 even though forwarding works
49364943

src/lib/verify-deployment.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ function hasSeparateAgentApiPort(chain: DashboardDeliveryChain): boolean {
319319
* The in-sandbox gateway probe only proves the API listens inside the sandbox;
320320
* it says nothing about the host forward operators actually connect through.
321321
* Onboarding advertises that host URL on the success screen, so it has to be
322-
* probed from the host too — otherwise a failed API forward leaves onboarding
322+
* probed from the host too. Otherwise, a failed API forward leaves onboarding
323323
* reporting a healthy deployment while the documented endpoint refuses every
324324
* connection (#9290).
325325
*/

0 commit comments

Comments
 (0)