Skip to content

Commit a830bba

Browse files
committed
docs: strengthen proxied: false as last-resort, recommend unauthenticated: true first
1 parent e77874b commit a830bba

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

docs/roo-code-cloud/environments.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,11 @@ Invalid examples:
197197

198198
### Direct Port Access (Non-Proxied)
199199

200-
By default, all ports are proxied through an authentication layer that validates requests before forwarding them to your application. Setting `proxied: false` bypasses this proxy and exposes the port directly on the sandbox domain.
200+
By default, all ports are proxied through an authentication layer that validates requests before forwarding them to your application. Setting `proxied: false` bypasses this proxy entirely and exposes the port directly on the sandbox domain.
201+
202+
:::tip[Try `unauthenticated: true` first]
203+
If you just need to skip authentication (e.g., for a public-facing endpoint or webhook), use `unauthenticated: true` instead. It keeps the proxy in place while disabling the auth check, and doesn't count against the stricter non-proxied port limit. Only reach for `proxied: false` when the proxy itself is the problem.
204+
:::
201205

202206
```yaml
203207
ports:
@@ -208,13 +212,13 @@ ports:
208212
proxied: false
209213
```
210214

211-
Use `proxied: false` when you need:
215+
Use `proxied: false` only when the proxy layer itself is incompatible with your use case:
212216

213-
- **Direct socket access** for protocols that don't work well through the HTTP proxy
214-
- **Internal services** that handle their own authentication or don't need external access control
217+
- **Direct socket access** for protocols that don't work through the HTTP proxy
218+
- **Non-HTTP services** that need the raw port exposed without any intermediary
215219

216220
:::warning[Warning]
217-
When `proxied` is `false`, the port is **completely exposed without authentication**, regardless of the `unauthenticated` setting. Only use this for ports that either handle their own security or don't serve sensitive content.
221+
When `proxied` is `false`, the port is **completely exposed without authentication**, regardless of the `unauthenticated` setting. Non-proxied ports also count against a stricter limit (1 per environment vs. 10 for proxied ports). Only use this as a last resort when other options don't work.
218222
:::
219223

220224
The `ROO_<NAME>_HOST` environment variable for a non-proxied port points to the direct sandbox domain instead of the preview proxy URL. Your application code doesn't need to change -- just use the injected variable as usual:

0 commit comments

Comments
 (0)