You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 092dd74
Browse filesBrowse the repository at this point in the historyBrowse files
docs(grok): state what the integration actually does on non-loopback and reload
The guide told users to swap api_key on a non-loopback bind, which no longer
matches the code (auto-registration is refused there) and never addressed the
unreachable 127.0.0.1 base_url. It now explains why the fence is loopback-only,
gives a manual recipe with a reachable host and the admission token, and warns
against env_key -- an unresolved one makes Grok fall through to the xAI session
token and send it to whatever base_url the entry names.
The reload note claimed hot reload without a version guarantee. Grok does watch
config.toml and reload on a real [model] change, so the note now describes the
observed mechanism, points at grok inspect for verification (config sources and
rejected fields, not a model list), and records that one TOML error invalidates
the whole user layer -- which is why we write atomically.
Also corrects devlog 020, which recommended the responses backend against its own
receipt: Grok's Responses event enum has no catch-all, so an unknown top-level
type ends the turn with a non-retryable Serialization error.
For a proxy reachable over the network, point `base_url` at the address `grok` can actually
90
+
dial and use your admission token:
91
+
92
+
```toml
93
+
[model.ocx-opus]
94
+
model = "anthropic/claude-opus-4-8"
95
+
base_url = "http://192.168.1.10:10100/v1"# the reachable host, not 127.0.0.1
96
+
api_backend = "chat_completions"
97
+
api_key = "your-OPENCODEX_API_AUTH_TOKEN"
98
+
```
99
+
73
100
Do not rely on `[model_providers.<id>]` inheritance for the endpoint: as of Grok Build
74
101
0.2.101 the inherited `base_url` is not applied to inference routing (requests fall
75
102
through to the default xAI proxy and fail with 401). Direct per-model fields route
76
103
correctly.
77
104
105
+
Quote any alias containing a dot: bare `[model.grok-4.5]` is a three-segment key path, not
106
+
the id `grok-4.5`. Generated aliases avoid dots entirely for this reason.
107
+
78
108
## Known limitations
79
109
80
110
-**Responses backend and keep-alives:** opencodex emits a `response.heartbeat` keep-alive
@@ -88,7 +118,12 @@ correctly.
88
118
`ocx service` setup, and if that unmanaged process dies the managed block can point at
89
119
a dead proxy until the next `ocx start`/`ocx ensure` refreshes it.
90
120
-**Config read timing:** start opencodex first, then launch `grok` for the most
91
-
predictable results. Recent Grok Build versions watch `config.toml` and hot-reload
92
-
`[model.*]` changes into an open session; older builds may need a restart.
121
+
predictable results. Grok Build watches `~/.grok/config.toml` and reloads when the
122
+
`[model]` table actually changes (roughly a one-second debounce, compared by content), so
123
+
a refreshed block reaches an open session without a restart. To confirm what Grok parsed,
124
+
run `grok inspect`: it lists the config sources it loaded and warns about any field it
125
+
rejected. It does not print the resolved model list. Note that a single TOML error
126
+
invalidates the *entire* user config layer, which is why opencodex writes the file
127
+
atomically — Grok never sees a half-written config.
93
128
-**Catalog updates:** the fenced block reflects the catalog at injection time. After
94
129
adding providers or models, run `ocx ensure` (or restart the proxy) to refresh it.
0 commit comments