Skip to content

Commit 8e65fc8

Browse files
committed
chore: add requirements section
1 parent dae391a commit 8e65fc8

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/install/olake-ui/index.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,13 @@ This will create and use `/custom/path/to/olake-data` instead of the default `./
136136

137137
OLake supports using an **external PostgreSQL instance** instead of the built-in Postgres service included in the docker-compose file. PostgreSQL stores all job data, configurations, sync state, and Temporal workflow data.
138138

139+
**Requirements:**
140+
141+
- PostgreSQL 12+ with `btree_gin` extension enabled
142+
- This can be enabled with `CREATE EXTENSION IF NOT EXISTS btree_gin;`, then run `\dx` to verify if its enabled.
143+
- Both OLake and Temporal databases created on the PostgreSQL instance
144+
- Network connectivity from the machine to the PostgreSQL instance
145+
139146
**Configure `docker-compose.yml`**
140147

141148
Within the compose file, an extension field named `x-db-envs` defines all database configuration values used by OLake and Temporal. These values can be modified to point to the external PostgreSQL instance.

0 commit comments

Comments
 (0)