Skip to content

Commit 0c2e029

Browse files
committed
chore: simplify doc and add x-envs section
1 parent dae391a commit 0c2e029

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

docs/install/olake-ui/index.mdx

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,9 @@ This will create and use `/custom/path/to/olake-data` instead of the default `./
134134

135135
### External PostgreSQL Configuration
136136

137-
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.
137+
OLake supports using an **external PostgreSQL instance** instead of the built-in Postgres service included in the docker-compose file. This PostgreSQL stores all job data, configurations, sync state, and Temporal workflow data.
138138

139-
**Configure `docker-compose.yml`**
140-
141-
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.
139+
Within the [compose file](https://raw.githubusercontent.com/datazip-inc/olake-ui/master/docker-compose.yml), 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.
142140

143141
```yaml
144142
x-db-envs:
@@ -151,33 +149,34 @@ x-db-envs:
151149
TEMPORAL_DB_NAME: &temporalDBName temporal
152150
```
153151

154-
The compose file includes optional TLS-related variables for Temporal's SQL connection.
155-
When Temporal is configured to use an external PostgreSQL instance particularly one with SSL/TLS enabled, these variables can be uncommented and configured as needed.
152+
If connection to external PostgreSQL instance is over TLS, the following variables need to be uncommented under `services.temporal.env` section in the compose file:
156153

157154
```yaml
158-
# for external postgres database
155+
# for TLS enabled external postgres database
159156
SQL_TLS: true
160157
SQL_TLS_DISABLE_HOST_VERIFICATION: true
161158
SQL_TLS_ENABLED: true
162159
SQL_HOST_VERIFICATION: false
163160
```
164161

165-
:::info **Note** (optional)
162+
:::info **Optional**
166163
A separate PostgreSQL container (`postgresql` service) is included by default.
167-
When an external database is used, this service is not needed and can be removed after all the services are started and healthy.
164+
When an external database is used, this service is not needed and can be stopped after all the services are started and healthy.
168165
:::
169166

170167
### Service Environment Variables
171168

172-
Key environment variables that can be customized within specific services:
169+
Key environment variables that can be customized within `x-envs` section. These variables are automatically injected into the `olake-ui` and `olake-worker` containers:
173170

174171
```yaml
175-
services:
176-
olake-ui:
177-
environment:
178-
PERSISTENT_DIR: *hostPersistencePath
179-
POSTGRES_DB: "postgres://olake:olake@postgresql:5432/olakedb"
180-
OLAKE_SECRET_KEY: *encryptionKey
172+
x-envs:
173+
shared: &sharedEnvs
174+
CONTAINER_REGISTRY_BASE: ${CONTAINER_REGISTRY_BASE:-registry-1.docker.io}
175+
OLAKE_SECRET_KEY: *encryptionKey
176+
PERSISTENT_DIR: *hostPersistencePath
177+
FOO: bar
178+
KEY: value
179+
NAME: example
181180
```
182181

183182
### Data Persistence

0 commit comments

Comments
 (0)