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: content/docs/configuration/environment-variables.md
+32-4Lines changed: 32 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,10 @@ images: []
21
21
|`DEKART_POSTGRES_USER`|*Example*: `postgres`|
22
22
|`DEKART_POSTGRES_PASSWORD`|*Example*: `******`|
23
23
|`DEKART_PORT`|*Example*: `8080`|
24
-
|`DEKART_POSTGRES_URL` <br><smallclass="badge badge-info">version >= 0.13</small> | Alternatively to specify `DEKART_POSTGRES_DB`, `DEKART_POSTGRES_HOST`, `DEKART_POSTGRES_PORT`, `DEKART_POSTGRES_USER`, `DEKART_POSTGRES_PASSWORD`, configure PostgreSQL by passing the connection string. If both specified `DEKART_POSTGRES_URL` is used. <br/> *Example*: `postgres://user:pass@hostname:5432/dekart?sslmode=verify-full`|, `DEKART_DATASOURCE=BQ` <br><smallclass="badge badge-info">version >= 0.8</small> | Which datasource to use: <br>Values<ul><li>`BQ` BigQuery, default</li><li>`ATHENA` AWS Athena</li><li>`SNOWFLAKE` Snowflake <smallclass="badge badge-info">version >= 0.12</small></li></ul>|
24
+
|`DEKART_POSTGRES_URL` <br><smallclass="badge badge-info">version >= 0.13</small> | Alternatively to specify `DEKART_POSTGRES_DB`, `DEKART_POSTGRES_HOST`, `DEKART_POSTGRES_PORT`, `DEKART_POSTGRES_USER`, `DEKART_POSTGRES_PASSWORD`, configure PostgreSQL by passing the connection string. If both specified `DEKART_POSTGRES_URL` is used. <br/> *Example*: `postgres://user:pass@hostname:5432/dekart?sslmode=verify-full`|
25
+
|`DEKART_DATASOURCE=BQ` <br><smallclass="badge badge-info">version >= 0.8</small> | Which datasource to use: <br>Values<ul><li>`BQ` BigQuery, default</li><li>`ATHENA` AWS Athena</li><li>`SNOWFLAKE` Snowflake <smallclass="badge badge-info">version >= 0.12</small></li></ul>|
25
26
|`DEKART_STORAGE=GCS` <br><smallclass="badge badge-info">version >= 0.8</small> | Which storage backend to use for storing queries and query results <br>Values<ul><li>`GCS` Google Cloud Storage, default, works only with BigQuery data source</li><li>`S3` AWS S3, works with BigQuery and AWS Athena</li></ul>|
26
-
|`DEKART_CLOUD_STORAGE_BUCKET`| Google Cloud Storage or AWS S3 bucket name where Dekart Query results will be stored. <br> *Example*: `dekart-bucket`|
27
+
|`DEKART_CLOUD_STORAGE_BUCKET`| Google Cloud Storage or AWS S3 bucket name where Dekart Query results will be stored. <br> *Example*: `dekart-bucket` <br><br> If value is empty, users will be able to define storage bucket via UI. Supported datasource `DEKART_DATASOURCE`: <ul><li>`BQ` BigQuery from <smallclass="badge badge-info">version >= 0.15</small></li></ul>|
27
28
|`DEKART_CORS_ORIGIN=` <br/><smallclass="badge badge-info">version >= 0.10</small> | CORS Origin to be allowed by Dekart backend and set in `Access-Control-Allow-Origin` header. If not set or set incorrectly, warning will appear in logs. If set incorrectly. <br> *Example*: `https://dekart.example.com`|
28
29
29
30
@@ -58,7 +59,7 @@ Required to query BigQuery and use Cloud Storage
58
59
59
60
| Name | Description |
60
61
| ------------- | ------------- |
61
-
|`DEKART_BIGQUERY_PROJECT_ID`| Unique identifier for your Google Cloud project with BigQuery API Enabled. <br> *Example*: `my-project`|
62
+
|`DEKART_BIGQUERY_PROJECT_ID`| Unique identifier for your Google Cloud project with BigQuery API Enabled. <br> *Example*: `my-project` <br><br><smallclass="badge badge-info">version >= 0.15</small> If value is empty, users will be able to define project ID via UI.|
62
63
|`DEKART_BIGQUERY_MAX_BYTES_BILLED` <br/><smallclass="badge badge-info">version >= 0.7</small> | Sets `maximumBytesBilled` in BigQuery Job Configuration to implement <ahref="https://cloud.google.com/bigquery/docs/best-practices-costs#limit_query_costs_by_restricting_the_number_of_bytes_billed">Best Practices for Controlling Query Cost</a>.<br> If not set warning message will appear in logs.|
63
64
|`DEKART_GCP_EXTRA_OAUTH_SCOPES` <br/><smallclass="badge badge-info">version >= 0.14</small> | Set additional scopes for the GCP OAuth token when connecting to BigQuery.<br> The value is interpreted as a comma-delimited list.<br> E.g., in order to query a BigQuery table backed by a Google Sheet in Google Drive, the value needs to be set to `https://www.googleapis.com/auth/drive`. |
64
65
@@ -73,12 +74,39 @@ Required to query BigQuery and use Cloud Storage
73
74
74
75
## File upload
75
76
76
-
Starting from version 0.10 Dekart supports file upload. File upload is disabled by default. Once uploaded file are stored in a same storage as query results. Both AWS S3 and Google Cloud Storage are supported. Recommended max file size is 100MB.
77
+
Starting from version 0.10 Dekart supports file upload. File upload is disabled by default. Once uploaded files are stored in the same storage as query results. Both AWS S3 and Google Cloud Storage are supported. The recommended max file size is 100MB.
Dekart can authorize users via Google OAuth 2.0 and use users' credentials to access BigQuery and Cloud Storage. When this option is enabled, Dekart does not require a service account and `GOOGLE_APPLICATION_CREDENTIALS` to be set. The user token is retrieved from Google OAuth 2.0 flow and stored in only in the browser memory. When the page is refreshed, the token is retrieved again. User short-lived token is then passed via Authorization header Dekart backend to access BigQuery and Cloud Storage.
86
+
87
+
No token is stored in the Dekart backend, database, or logs.
88
+
89
+
Each user needs to have access to BigQuery and Cloud Storage with following permissions:
90
+
* BigQuery Data Viewer
91
+
* BigQuery Job User
92
+
* BigQuery Read Session User
93
+
* Storage Object User
94
+
95
+
96
+
This option is only supported for BigQuery and Cloud Storage. It is not supported for AWS and Snowflake Data Sources.
97
+
98
+
| Name | Description |
99
+
| ------------- | ------------- |
100
+
|`DEKART_REQUIRE_GOOGLE_OAUTH` <br/><smallclass="badge badge-info">version >= 0.15</small> | Enables Google OAuth 2.0 flow. Requires users to be authenticated. <br> *Example value*: `1`|
Copy file name to clipboardExpand all lines: content/docs/self-hosting/upgrade.md
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -16,10 +16,13 @@ menu:
16
16
Before you begin: it is always recommended to back up your Postgres database before upgrading Dekart. On the first run, Dekart applies migrations to the database and you won't be able to downgrade.
17
17
</div></p>
18
18
19
-
For all Docker-based deployments, update the docker tag, for example `dekartxyz/`dekart:0.13` -> `dekartxyz/dekart:0.14`
19
+
For all Docker-based deployments, update the docker tag, for example `dekartxyz/`dekart:0.14` -> `dekartxyz/dekart:0.15`
0 commit comments