Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions enterprise/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,27 @@
You'll provision infrastructure (AWS Terraform or a manual VM setup), configure
GitHub for user authentication, and configure your LLM provider.

## Who This Is For
## Who is this for

This guide is **not** for single-user local laptop installs. It is for a **30-day trial of OpenHands Enterprise** on a
**dedicated VM/server** on your own infrastructure. The deployment requires DNS records, network, and compute setup before installation.
This guide is **not** for single-user local laptop installs. It is for a **30-day trial** of **OpenHands Enterprise** on a **dedicated VM/server on your own infrastructure**. The deployment requires DNS records, network, and compute setup before installation.

If you want to use OpenHands immediately without infrastructure setup:
Which scenario makes the most sense for you?

- Use OpenHands Cloud (SaaS)
- Run OpenHands open-source locally using Docker, CLI or SDK
### I am looking to use OpenHands for myself

### Accounts and Credentials
Consider [OpenHands Agent Canvas](openhands/usage/agent-canvas/overview), which can be downloaded locally on your machine and runs for a single-user environment.

<Card title="Download Agent Canvas" href="/openhands/usage/agent-canvas/setup">
100% Open Source (MIT license). Single-user. Runs on your local machine.
</Card>

### I am looking to use OpenHands within my team or organization

If you are looking to use OpenHands across **multiple users in your organization**, then you are at the right place.

Before you begin, make sure you have the following ready:

<Card title="Register for a Trial Account" icon="user-plus" href="https://install.r9.all-hands.dev/openhands/signup">
<Card title="Register for an OpenHands Enterprise Trial" icon="user-plus" href="https://install.r9.all-hands.dev/openhands/signup">
Sign up for a free 30-day OpenHands Enterprise trial account. You'll need this to access the installer dashboard.
</Card>

Expand All @@ -36,7 +42,7 @@
You will need a VM to host OpenHands Enterprise. Choose one of the options below to provision your infrastructure.

<Note>
The requirements below are the trial baseline, which comfortably supports about 15 concurrent sandboxes. For a larger rollout, pick your VM from the [Sizing Guide](/enterprise/sizing-guide) before provisioning.

Check warning on line 45 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L45

Did you really mean 'rollout'?
</Note>

<Tabs>
Expand Down Expand Up @@ -209,7 +215,7 @@
done
```

Expected: each hostname resolves to your VM's public IP address through the

Check warning on line 218 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L218

Did you really mean 'hostname'?

Check warning on line 218 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L218

Did you really mean 'VM's'?
wildcard record.

### Outbound connectivity checks
Expand Down Expand Up @@ -239,7 +245,7 @@
done
```

Any HTTP response code other than `000` is acceptable for reachability checks

Check warning on line 248 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L248

Did you really mean 'reachability'?
(for example `200`, `301`, `302`, `401`, `403`, `405`).

If any check fails, stop and resolve before continuing:
Expand All @@ -250,10 +256,10 @@

| Requirement | Why It Exists |
|------------|----------------|
| `443/TCP` inbound | Primary HTTPS entrypoint for users and service hostnames |

Check warning on line 259 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L259

Did you really mean 'hostnames'?
| `30000/TCP` inbound | Replicated/KOTS Admin Console for install and configuration |
| `80/TCP` inbound | HTTP entrypoint used for ingress/redirect behavior |
| `*.<domain>` DNS + cert SAN | Application services and sandboxes are addressed by hostnames under the base domain |

Check warning on line 262 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L262

Did you really mean 'hostnames'?
| `replicated.app`, `proxy.replicated.com` | Replicated control-plane/license/install paths |
| `images.r9...`, `charts.r9...`, `updates.r9...`, `install.r9...` | Vendor distribution image/chart/update/install endpoints |
| `traefik.github.io` | Embedded cluster ingress chart repository |
Expand Down Expand Up @@ -306,7 +312,7 @@

For trials and production deployments, use a publicly trusted TLS certificate whenever possible.
Private CA certificates may work for users after manual trust setup, but external integrations
such as GitHub, GitLab, Slack, Jira, and Bitbucket must also trust the certificate chain. If they

Check warning on line 315 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L315

Did you really mean 'Jira'?
do not, webhook or OAuth callbacks can fail TLS verification and repeatedly retry.
</Warning>

Expand All @@ -326,7 +332,7 @@
### 5. Upload TLS certificate (if not provided with the install command)

If you did not provide certificates with the `install` command, select **"Upload your own"**,
enter `admin.<your-base-domain>` under **Hostname**, upload your private key and SSL certificate, then click **Continue**.

Check warning on line 335 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L335

Did you really mean 'Hostname'?

If you upload a private CA certificate, make sure any external webhook or OAuth provider that
calls OpenHands also trusts that CA.
Expand Down Expand Up @@ -354,7 +360,7 @@

### Domain Configuration

- Keep the Hostname Configuration Mode set to **"Simple (default)"**

Check warning on line 363 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L363

Did you really mean 'Hostname'?
- Enter your base domain (e.g., `openhands.example.com`)

### Certificate Configuration
Expand Down Expand Up @@ -399,7 +405,7 @@

### Additional Integrations

If your team uses Jira Data Center or Bitbucket Data Center, follow these guides

Check warning on line 408 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L408

Did you really mean 'Jira'?
to configure Admin Console values before deployment and complete webhook setup
inside OpenHands after deployment.

Expand All @@ -408,7 +414,7 @@
Configure Bitbucket Data Center login, repository access, bot identity, and pull request webhooks.
</Card>
<Card title="Jira Data Center" icon="building" href="/enterprise/integrations/jira-data-center">
Configure Jira issue triggers, OAuth account linking, service account credentials, and Jira webhooks.

Check warning on line 417 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L417

Did you really mean 'Jira'?
</Card>
</CardGroup>

Expand Down
Loading