Commit 1947825
docs(self-hosting): correct claims that contradict the source
An audit of the 27 self-hosting and enterprise pages checked every concrete
claim against the code it describes. This fixes what it found.
Errors that made a documented path fail:
- `openssl rand -hex 32` prints 64 hex characters, not the "32 hex chars" five
entries claimed. Only ENCRYPTION_KEY and API_ENCRYPTION_KEY are length-
validated; the rest are free-form minimums, so the fix differs per variable.
- API_ENCRYPTION_KEY was absent from the whole Kubernetes path and listed as
required elsewhere. It is optional, and unset means API keys are stored in
plain text behind one warning — a silent failure documented nowhere.
- The per-purpose S3 fallback was described backwards: knowledge-base, chat,
copilot and profile-picture buckets resolve to an empty string, not a literal.
The GCS table carried the mirror-image claim, and Azure had no warning at all.
- Local uploads go to /app/uploads, not /uploads, and no compose file or chart
mounts a volume there.
- The remote-sandbox table omitted the immutable template and snapshot refs, so
the documented configuration could not work.
- The GKE BackendConfig snippet set a values key no template renders.
- Retention deletion is scheduled by nothing in the chart, so a deployment that
followed the docs deleted nothing.
- Every "Settings → Enterprise/Security → X" path named nav groups that do not
exist, across eleven enterprise pages.
Claims that understated what ships:
- The outbound-proxy section said no platform traffic can be proxied. The server
runs on Bun, whose fetch honors the proxy variables, so provider SDK and
Resend traffic already proxies; guarded egress, SMTP, object storage and OTLP
do not. Replaced with a per-path table, including the constraint that the
per-request proxyUrl refuses a private address.
- Telemetry is off by default on Helm, not on, and enabling the collector
collects nothing until NEXT_TELEMETRY_DISABLED is cleared.
- The CronJob count was 18 in two places; there are 22 in both the chart and the
crontab.
- The permission-group table was stale throughout, named a deployment key that
does not exist, and inverted the checkbox semantic. About fifteen governed
toggles were undocumented.
Also documents ~25 environment variables nothing described, the migration
advisory lock and its operational knobs, the CloudWatch metrics that activate on
any deployment with AWS credentials, and sim-setup doctor.
Redundancy removed where a page restated itself: FAQ blocks that repeated their
own body, four drifting copies of the same tables, and three cloud tabs
identical but for a filename.
The sandbox base-image runbook moves from the enterprise enablement page, where
it was out of place, to its own self-hosting page rather than being lost.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015BwsJTEQRzWJaY4BRCkPZt1 parent bc2622a commit 1947825
35 files changed
Lines changed: 894 additions & 542 deletions
File tree
- apps/docs/content/docs/platform
- enterprise
- self-hosting
Lines changed: 89 additions & 82 deletions
Large diffs are not rendered by default.
Lines changed: 11 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| |||
149 | 149 | | |
150 | 150 | | |
151 | 151 | | |
152 | | - | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
38 | | - | |
| 38 | + | |
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
| |||
102 | 102 | | |
103 | 103 | | |
104 | 104 | | |
105 | | - | |
| 105 | + | |
106 | 106 | | |
107 | 107 | | |
108 | 108 | | |
| |||
Lines changed: 24 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
| |||
207 | 207 | | |
208 | 208 | | |
209 | 209 | | |
210 | | - | |
211 | | - | |
212 | | - | |
213 | | - | |
214 | 210 | | |
215 | 211 | | |
216 | 212 | | |
| |||
240 | 236 | | |
241 | 237 | | |
242 | 238 | | |
243 | | - | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
244 | 261 | | |
245 | | - | |
| 262 | + | |
Lines changed: 28 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
97 | 97 | | |
98 | 98 | | |
99 | 99 | | |
100 | | - | |
| 100 | + | |
101 | 101 | | |
102 | 102 | | |
103 | | - | |
| 103 | + | |
104 | 104 | | |
105 | 105 | | |
106 | 106 | | |
| |||
182 | 182 | | |
183 | 183 | | |
184 | 184 | | |
185 | | - | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
186 | 209 | | |
187 | 210 | | |
188 | 211 | | |
| |||
193 | 216 | | |
194 | 217 | | |
195 | 218 | | |
196 | | - | |
| 219 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | | - | |
| 65 | + | |
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
| |||
373 | 373 | | |
374 | 374 | | |
375 | 375 | | |
376 | | - | |
377 | | - | |
378 | | - | |
379 | | - | |
380 | 376 | | |
381 | | - | |
382 | | - | |
| 377 | + | |
383 | 378 | | |
384 | 379 | | |
385 | 380 | | |
| |||
392 | 387 | | |
393 | 388 | | |
394 | 389 | | |
395 | | - | |
| 390 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
7 | | - | |
8 | 6 | | |
9 | 7 | | |
10 | 8 | | |
11 | 9 | | |
12 | | - | |
| 10 | + | |
13 | 11 | | |
14 | | - | |
| 12 | + | |
15 | 13 | | |
16 | | - | |
| 14 | + | |
17 | 15 | | |
18 | | - | |
| 16 | + | |
19 | 17 | | |
20 | | - | |
21 | | - | |
22 | | - | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
23 | 21 | | |
24 | 22 | | |
25 | 23 | | |
26 | | - | |
| 24 | + | |
27 | 25 | | |
28 | | - | |
| 26 | + | |
29 | 27 | | |
30 | | - | |
| 28 | + | |
31 | 29 | | |
32 | 30 | | |
33 | 31 | | |
| |||
41 | 39 | | |
42 | 40 | | |
43 | 41 | | |
44 | | - | |
| 42 | + | |
45 | 43 | | |
46 | | - | |
| 44 | + | |
47 | 45 | | |
48 | 46 | | |
49 | 47 | | |
| |||
77 | 75 | | |
78 | 76 | | |
79 | 77 | | |
80 | | - | |
81 | | - | |
82 | | - | |
83 | | - | |
84 | | - | |
85 | | - | |
86 | | - | |
87 | | - | |
88 | 78 | | |
89 | 79 | | |
90 | 80 | | |
| |||
0 commit comments