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
33 changes: 27 additions & 6 deletions enterprise/external-postgres.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,27 @@

OpenHands Enterprise requires **PostgreSQL 16.4.0 or above**. PostgreSQL 17 is also supported.

## Database Encoding Requirement

<Warning>
All databases used by OpenHands Enterprise **must use UTF8 encoding**. Using other encodings
(such as LATIN1) will cause database migrations to fail during installation or upgrades.
</Warning>

When creating databases manually or configuring your PostgreSQL instance, ensure UTF8 encoding
is set:

```sql
-- Check current database encoding
SELECT datname, pg_encoding_to_char(encoding) AS encoding FROM pg_database;

-- Create databases with explicit UTF8 encoding
CREATE DATABASE openhands WITH ENCODING 'UTF8';
```

If your PostgreSQL server's default encoding is not UTF8, you may need to specify the encoding
explicitly when creating each database, or configure the server's default encoding.

## Required Databases

OpenHands Enterprise uses the following databases:
Expand Down Expand Up @@ -48,12 +69,12 @@
databases before installation:

```sql
-- Create the databases
CREATE DATABASE openhands;
CREATE DATABASE bitnami_keycloak;
CREATE DATABASE litellm;
CREATE DATABASE runtime_api_db;
CREATE DATABASE automations;
-- Create the databases with UTF8 encoding
CREATE DATABASE openhands WITH ENCODING 'UTF8';
CREATE DATABASE bitnami_keycloak WITH ENCODING 'UTF8';
CREATE DATABASE litellm WITH ENCODING 'UTF8';
CREATE DATABASE runtime_api_db WITH ENCODING 'UTF8';
CREATE DATABASE automations WITH ENCODING 'UTF8';

-- Create user without CREATEDB
CREATE USER openhands_user WITH PASSWORD 'your-secure-password';
Expand Down Expand Up @@ -87,7 +108,7 @@
Ensure your PostgreSQL instance is accessible from:

- The OpenHands application pods/services
- The Keycloak service

Check warning on line 111 in enterprise/external-postgres.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/external-postgres.mdx#L111

Did you really mean 'Keycloak'?
- The LiteLLM proxy service
- The Runtime API service

Expand All @@ -99,7 +120,7 @@
When configuring OpenHands Enterprise, provide your external PostgreSQL connection details
in the Admin Console or Helm values:

- **Host**: Your PostgreSQL server hostname or IP

Check warning on line 123 in enterprise/external-postgres.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/external-postgres.mdx#L123

Did you really mean 'hostname'?
- **Port**: PostgreSQL port (default: 5432)
- **Username**: The database user created above
- **Password**: The user's password
Expand Down
Loading