Skip to content

Replicated Installer MVP Docs#408

Merged
jlav merged 9 commits intomainfrom
jl/enterprise-mvp-docs
Mar 24, 2026
Merged

Replicated Installer MVP Docs#408
jlav merged 9 commits intomainfrom
jl/enterprise-mvp-docs

Conversation

@jlav
Copy link
Copy Markdown
Contributor

@jlav jlav commented Mar 19, 2026

  • 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

Adding a quick start guide to begin the free trial for OpenHands Enterprise. It has detailed instructions to get someone stood up in the easiest default configuration, which includes:

  • A single-node application cluster
  • Embedded Postgres
  • GitHub Authentication
  • Anthropic as the LLM Provider

As we validate more authentication integrations and LLM providers for self hosted, I think we can adjust this quick start guide to point out to more detailed docs for the other integrations. For now, I think it makes sense for this doc to focus very specifically on GitHub+Anthropic since those are our highest confidence paths.

@enyst
Copy link
Copy Markdown
Collaborator

enyst commented Mar 20, 2026

Out of curiosity, is this supposed to be accurate?
image

I thought the Cloud has some level of implementation of organizations now. That doesn't sound like users: 1?

@jlav
Copy link
Copy Markdown
Contributor Author

jlav commented Mar 20, 2026

Orgs support was added earlier this week, but right now there's only 1 OpenHands org and it's not generally available. I think we'll want to keep the existing enterprise docs as-is for now until we're ready for GA and marketing.

@enyst

This comment was marked as outdated.

@openhands-ai

This comment was marked as outdated.

@enyst
Copy link
Copy Markdown
Collaborator

enyst commented Mar 20, 2026

@OpenHands Merge main branch into this branch and fix the conflicts. It's probably only that main branch has those changes now, so maybe just reset those exact 2 files with conflicts (do NOT change any other file, just those with conflicts). Do not push with force, push normally. Figure it out.

@openhands-ai
Copy link
Copy Markdown

openhands-ai bot commented Mar 20, 2026

I'm on it! enyst can track my progress at all-hands.dev

Resolved the only merge conflicts by taking main's versions of llms.txt and llms-full.txt.

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

enyst commented Mar 20, 2026

Merged main into jl/enterprise-mvp-docs in b8785f4 and resolved the only conflicts by taking main's versions of llms.txt and llms-full.txt. Pushed normally with no force push.

@openhands-ai

This comment was marked as duplicate.

@DevinVinson
Copy link
Copy Markdown

I went through the steps and was able to stand up an instance. I made some notes on where I encountered some friction that might help.

  1. In Prerequisites it could be helpful to call out that you need the same ones in https://github.com/All-Hands-AI/OpenHands-Cloud/tree/main/terraform/aws#prerequisites AND that you'll need to do this first.
  2. In that terraform bit you can't just use aws login you need to have done aws configure
  3. Maybe make a note when doing the terraform steps that if you get hung up running make apply or make plan you can end it and rerun it. I did and...no issues.
  4. Once I started the steps in Run the Installer it was easy to follow along. However it was so easy that when I was doing step 3, Run the installation commands I missed the extra command in 3-4 to include the --tls-cert.
  5. In Configure OpenHands we could add a note that 'If you were unable to set anything in Secure the Admin Console you can complete those now' since I was able to finish everything after continuing through that step. If any of those steps are vital to be set before this step for security we could emphasize them Step 4 "Access the Admin Console" more loudly.
    A few others I ran into have already been addressed.

- Move TLS certificate flags into a Warning block so they're harder to miss
- Add link to Terraform repo on "Terraform module" text
@jlav
Copy link
Copy Markdown
Contributor Author

jlav commented Mar 24, 2026

Thanks @DevinVinson!

I updated the docs to incorporate your feedback, and have some questions/thoughts below.

In Prerequisites it could be helpful to call out that you need the same ones in https://github.com/All-Hands-AI/OpenHands-Cloud/tree/main/terraform/aws#prerequisites AND that you'll need to do this first.

Are you asking to add on the docs site that terraform is a prerequisite? I deliberately left that only in the terraform module readme since some readers may go through the manual VM step instead.

I've added some additional text under Provision Infrastructure to call out that you must either use the terraform module or manually create a VM.

In that terraform bit you can't just use aws login you need to have done aws configure

Looks like we've got that covered here: Terraform Readme

Maybe make a note when doing the terraform steps that if you get hung up running make apply or make plan you can end it and rerun it. I did and...no issues.

Do you remember where the hangup occurred? Terraform might take a couple of minutes to provision the certificates, but it should have been printing progress the entire time. I'm leaning towards not making a specific call out about this one, since graceful termination on ctrl+c/SIGINT is generally well supported by terraform providers.

  1. Once I started the steps in Run the Installer it was easy to follow along. However it was so easy that when I was doing step 3, Run the installation commands I missed the extra command in 3-4 to include the --tls-cert.
  2. In Configure OpenHands we could add a note that 'If you were unable to set anything in Secure the Admin Console you can complete those now' since I was able to finish everything after continuing through that step. If any of those steps are vital to be set before this step for security we could emphasize them Step 4 "Access the Admin Console" more loudly.

I tried making these instructions more prominent with a warning panel. If someone skips the warning, the following steps explain how to manually upload the certs so I think most folks would be able to continue through the guide without any trouble.

@DevinVinson
Copy link
Copy Markdown

since some readers may go through the manual VM step instead.

Good point @jlav . I didn't think about that.

I'm leaning towards not making a specific call out about this one, since graceful termination on ctrl+c/SIGINT is generally well supported by terraform providers.

Totally fair to leave that out 👍

@jlav jlav merged commit fc258ff into main Mar 24, 2026
5 checks passed
@jlav jlav deleted the jl/enterprise-mvp-docs branch March 24, 2026 19:39
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