Skip to content

docs(enterprise): add Deployment Options page - #1101

Draft
jpelletier1 wants to merge 1 commit into
mainfrom
enterprise-deployment-options
Draft

jpelletier1 wants to merge 1 commit into
mainfrom
enterprise-deployment-options

Conversation

@jpelletier1

Copy link
Copy Markdown
Contributor
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

Adds enterprise/deployment-options.mdx as the first page under Enterprise → Deployment in docs.json. The page helps readers pick one of the three ways to deploy OpenHands Enterprise:

Option Purpose
Docker Compose Quick evaluation for fewer than 10 users on one machine. Sandboxes run as local Docker containers. Budgeting, the LiteLLM gateway, and the sandboxing infrastructure are off.
Helm install The recommended production path. Scalable, with budgeting, the LiteLLM gateway, a durable database, and the sandboxing infrastructure.
Replicated VM Production without managing Kubernetes. Scales less well than Helm, so it links to the Sizing Guide.

The page also has:

  • Enabled by Default: a table of what is on for a fresh deployment of each option. Agent Canvas UI, Automations, and OAuth V2 Login are on for all three. The built-in LiteLLM gateway and the sandboxing infrastructure are on for Helm and Replicated VM only.
  • Upgrade Scenarios: how to turn on the Super Admin Dashboard, OAuth V2 Login, and Automations after an upgrade. For each feature it gives the Replicated Admin Console setting, the Helm values, and the Docker Compose variables. A note says that turning on OAuth V2 Login removes Keycloak as a dependency.

I took the setting names and variables from the current source:

  • Admin Console labels come from OpenHands-Cloud/replicated/config.yaml.
  • The Helm env flags come from replicated/openhands.yaml. Both forms of each flag are needed: the server reads the plain variable and the web client reads the OH_WEB_CLIENT_FEATURE_FLAGS_ one.
  • The Compose variables come from enterprise/docker-compose.yml.

Open question for reviewers: the "Enabled by Default" table follows the product guidance for this page, but the current source does not fully match it:

  • In replicated/config.yaml, super_admin_dashboard_enabled and auth_v2_enabled both default to "0".
  • The Helm chart defaults to automation.enabled: false.
  • Docker Compose turns all three on, which matches the table.

Please confirm the defaults before this is merged.

Validation: mint broken-links reports no broken links. I did not run mint dev, so the rendering has not been checked.

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

@jpelletier1 can click here to continue refining the PR

Compare Docker Compose, Helm, and Replicated VM deployments, list features
enabled by default, and document the Admin Console settings, Helm values, and
Docker Compose variables for enabling features after an upgrade.

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

mintlify Bot commented Nov 7, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
all-hands-ai 🟢 Ready View Preview Nov 7, 2026, 6:55 PM

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

This branch was successfully deployed

1 active deployment
staging — deff5942 Deployed Nov 7, 2026 by mintlify[bot]
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.

2 participants