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
15 changes: 15 additions & 0 deletions enterprise/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@
<Card title="OpenHands AWS Terraform Module" icon="github" href="https://github.com/All-Hands-AI/OpenHands-Cloud/tree/main/terraform/aws">
Follow the README instructions to configure and apply the Terraform configuration.
</Card>

<Warning>
The recommended Terraform path provisions a publicly trusted TLS certificate. If you bring
your own certificate instead, use a publicly trusted CA whenever possible. Private CA
certificates require every external webhook or OAuth provider that calls OpenHands to trust
your CA.
</Warning>
</Tab>

<Tab title="Manual VM Setup">
Expand Down Expand Up @@ -183,9 +190,9 @@
done
```

Expected: each hostname above resolves to your VM's public IP address.

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L193

Did you really mean 'hostname'?

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L193

Did you really mean 'VM's'?

Test that a runtime wildcard hostname resolves:

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L195

Did you really mean 'hostname'?

```bash
getent hosts "test.runtime.${BASE_DOMAIN}" || nslookup "test.runtime.${BASE_DOMAIN}"
Expand Down Expand Up @@ -220,7 +227,7 @@
done
```

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

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L230

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

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

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

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L241

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 |
| `*.runtime.<domain>` DNS + cert SAN | Runtime sandboxes are addressed by dynamic runtime-specific hostnames |

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L244

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 @@ -282,6 +289,11 @@
If you provisioned manually and have your own certificates on the VM, pass them the same way.
You can also omit the `--tls-cert` and `--tls-key` flags and upload certificates later through
the Admin Console.

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 295 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L295

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

![Installation commands](./images/install-commands.png)
Expand All @@ -300,8 +312,11 @@
### 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 your base domain under **Hostname**, upload your private key and SSL certificate, then click **Continue**.

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 'Hostname'?

If you upload a private CA certificate, make sure any external webhook or OAuth provider that
calls OpenHands also trusts that CA.

![Upload TLS certificate](./images/upload-tls-certificate.png)

### 6. Log in to the Admin Console
Expand All @@ -325,7 +340,7 @@

### Domain Configuration

- Select **"Derive hostnames from domain (recommended)"**

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L343

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

### Certificate Configuration
Expand Down Expand Up @@ -366,7 +381,7 @@

### Additional Integrations

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

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L384

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

Expand All @@ -375,7 +390,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 393 in enterprise/quick-start.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/quick-start.mdx#L393

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

Expand Down
Loading