You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install/olake-ui/index.mdx
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -134,11 +134,9 @@ This will create and use `/custom/path/to/olake-data` instead of the default `./
134
134
135
135
### External PostgreSQL Configuration
136
136
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.
138
138
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.
142
140
143
141
```yaml
144
142
x-db-envs:
@@ -151,33 +149,34 @@ x-db-envs:
151
149
TEMPORAL_DB_NAME: &temporalDBName temporal
152
150
```
153
151
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:
156
153
157
154
```yaml
158
-
# for external postgres database
155
+
# for TLS enabled external postgres database
159
156
SQL_TLS: true
160
157
SQL_TLS_DISABLE_HOST_VERIFICATION: true
161
158
SQL_TLS_ENABLED: true
162
159
SQL_HOST_VERIFICATION: false
163
160
```
164
161
165
-
:::info **Note** (optional)
162
+
:::info **Optional**
166
163
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.
168
165
:::
169
166
170
167
### Service Environment Variables
171
168
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:
0 commit comments