Skip to content

docs(enterprise): add path-based sandbox routing documentation#486

Closed
jpshackelford wants to merge 4 commits intomainfrom
docs/path-based-sandbox-routing
Closed

docs(enterprise): add path-based sandbox routing documentation#486
jpshackelford wants to merge 4 commits intomainfrom
docs/path-based-sandbox-routing

Conversation

@jpshackelford
Copy link
Copy Markdown
Contributor

Summary

This PR updates the enterprise quick-start guide to document the path-based sandbox routing feature introduced in OpenHands-Cloud PR #563.

Background

Some enterprise deployments cannot obtain wildcard TLS certificates due to:

  • Internal CA restrictions that prohibit wildcard certs
  • Compliance requirements that forbid wildcards
  • DNS limitations that don't support wildcard records

The path-based routing feature (released in v1.25.1) enables these deployments by routing all sandboxes through a single hostname with path-based routing instead of subdomain-based routing.

Changes

Updates to enterprise/quick-start.mdx:

  • DNS and TLS Setup: Added tabbed section explaining both routing modes with specific DNS records and certificate requirements for each
  • Preflight DNS Checks: Updated to include checks for both subdomain and path-based routing modes
  • Requirements Table: Clarified which DNS/cert requirements apply to which routing mode
  • Sandbox Routing Configuration: Added new section explaining how to select routing mode in the Admin Console

Testing

The documentation follows the existing mdx format and uses standard Mintlify components (Tabs, Tab, Info, Warning).


This PR was created by an AI agent (OpenHands) on behalf of the user.

Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Good taste - Clear, well-structured documentation that addresses a real enterprise deployment constraint.

[RISK ASSESSMENT]

  • [Overall PR] ⚠️ Risk Assessment: 🟢 LOW

Documentation-only change addressing verified enterprise requirement (wildcard certificate restrictions). Uses Mintlify components correctly, provides clear guidance for both routing modes, and maintains consistent terminology throughout. No code modifications.

VERDICT:
Worth merging: Solid documentation that solves a real problem.

KEY INSIGHT:
Tabbed structure elegantly separates two distinct deployment modes while keeping the documentation DRY and maintainable.

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 4, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview May 4, 2026, 2:07 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread enterprise/quick-start.mdx Outdated
Comment thread enterprise/quick-start.mdx Outdated
Copy link
Copy Markdown
Contributor

@jlav jlav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some nits, but overall LGTM.

Copy link
Copy Markdown
Contributor

@jlav jlav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some nits, but overall LGTM.

Update the enterprise quick-start guide to document the path-based
sandbox routing feature introduced in OpenHands-Cloud PR #563.

Key changes:
- Add tabbed DNS/TLS setup section covering both routing modes
- Document path-based mode for environments without wildcard cert support
- Update preflight DNS checks for both routing modes
- Add Sandbox Routing Configuration section in Admin Console setup
- Update requirements table to clarify routing mode dependencies

Co-authored-by: openhands <openhands@all-hands.dev>
Add a warning callout explaining why subdomain-based routing is
preferred from a security perspective - cookie isolation between
sandboxes. Encourage customers to seek IT security exceptions.

Co-authored-by: openhands <openhands@all-hands.dev>
…port

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Copy link
Copy Markdown
Contributor Author

Closing in favor of #488 - this PR had persistent merge state issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants