Skip to content

Commit 574e4be

Browse files
authored
Merge pull request #19 from dekart-xyz/release-0.15
Release 0.15
2 parents 21ad11c + 7b9ef4f commit 574e4be

File tree

5 files changed

+74
-10
lines changed

5 files changed

+74
-10
lines changed

content/docs/configuration/environment-variables.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ images: []
2121
| `DEKART_POSTGRES_USER` | *Example*: `postgres`|
2222
| `DEKART_POSTGRES_PASSWORD` | *Example*: `******`|
2323
|`DEKART_PORT`| *Example*: `8080`|
24-
|`DEKART_POSTGRES_URL` <br><small class="badge badge-info">version &gt;= 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><small class="badge badge-info">version &gt;= 0.8</small> | Which datasource to use: <br>Values<ul><li>`BQ` BigQuery, default</li><li>`ATHENA` AWS Athena</li><li>`SNOWFLAKE` Snowflake <small class="badge badge-info">version &gt;= 0.12</small></li></ul>|
24+
|`DEKART_POSTGRES_URL` <br><small class="badge badge-info">version &gt;= 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><small class="badge badge-info">version &gt;= 0.8</small> | Which datasource to use: <br>Values<ul><li>`BQ` BigQuery, default</li><li>`ATHENA` AWS Athena</li><li>`SNOWFLAKE` Snowflake <small class="badge badge-info">version &gt;= 0.12</small></li></ul>|
2526
| `DEKART_STORAGE=GCS` <br><small class="badge badge-info">version &gt;= 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 <small class="badge badge-info">version &gt;= 0.15</small></li></ul>|
2728
| `DEKART_CORS_ORIGIN=` <br/><small class="badge badge-info">version &gt;= 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` |
2829

2930

@@ -58,7 +59,7 @@ Required to query BigQuery and use Cloud Storage
5859

5960
| Name | Description |
6061
| ------------- | ------------- |
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><small class="badge badge-info">version &gt;= 0.15</small> If value is empty, users will be able to define project ID via UI.|
6263
| `DEKART_BIGQUERY_MAX_BYTES_BILLED` <br/><small class="badge badge-info">version &gt;= 0.7</small> | Sets `maximumBytesBilled` in BigQuery Job Configuration to implement <a href="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.|
6364
| `DEKART_GCP_EXTRA_OAUTH_SCOPES` <br/><small class="badge badge-info">version &gt;= 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`. |
6465

@@ -73,12 +74,39 @@ Required to query BigQuery and use Cloud Storage
7374

7475
## File upload
7576

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.
7778

7879
| Name | Description |
7980
| ------------- | ------------- |
8081
| `DEKART_ALLOW_FILE_UPLOAD` <br/><small class="badge badge-info">version &gt;= 0.10</small> | Enable file upload <br> *Example value*: `1`|
8182

83+
## User authorization via Google OAuth 2.0 flow
84+
85+
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/><small class="badge badge-info">version &gt;= 0.15</small> | Enables Google OAuth 2.0 flow. Requires users to be authenticated. <br> *Example value*: `1`|
101+
| `DEKART_GOOGLE_OAUTH_CLIENT_ID`<br/><small class="badge badge-info">version &gt;= 0.15</small>| Google OAuth 2.0 Client ID. <br> *Example value*: `1234567890-abcde.apps.googleusercontent.com`|
102+
| `DEKART_GOOGLE_OAUTH_CLIENT_SECRET`<br/><small class="badge badge-info">version &gt;= 0.15</small>| Google OAuth 2.0 Client Secret. <br> *Example value*: `******`|
103+
104+
105+
Creating Google OAuth 2.0 Client ID and Client Secret:
106+
107+
1. Configure [OAuth Consent Screen](https://console.cloud.google.com/apis/credentials/consent) in your Google Cloud Project
108+
2. Create [OAuth 2.0 Client ID](https://console.cloud.google.com/apis/credentials) with `Web application` type
109+
3. Add `https://your-dekart-url.com/api/v1/authenticate` to `Authorized redirect URIs`
82110

83111
## User authorization via Google IAP
84112

content/docs/self-hosting/docker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ docker run \
4545
-e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
4646
-e DEKART_CORS_ORIGIN=${DEKART_CORS_ORIGIN} \
4747
-p 8080:8080 \
48-
dekartxyz/dekart:0.14
48+
dekartxyz/dekart:0.15
4949
```
5050

5151
### Google BigQuery
@@ -66,7 +66,7 @@ docker run \
6666
-e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
6767
-e DEKART_CORS_ORIGIN=${DEKART_CORS_ORIGIN} \
6868
-p 8080:8080 \
69-
dekartxyz/dekart:0.14
69+
dekartxyz/dekart:0.15
7070
```
7171

7272
### Snowflake
@@ -90,7 +90,7 @@ docker run -it --rm \
9090
-e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
9191
-e DEKART_CORS_ORIGIN=${DEKART_CORS_ORIGIN} \
9292
-p 8080:8080 \
93-
dekartxyz/dekart:0.14
93+
dekartxyz/dekart:0.15
9494
```
9595

9696

content/docs/self-hosting/upgrade.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,13 @@ menu:
1616
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.
1717
</div></p>
1818

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`
2020

2121
## Migration instructions
2222

23+
**`dekartxyz/dekart:0.14` -> `dekartxyz/dekart:0.15`**
24+
No breaking changes, just update the docker tag. New Postgres migrations will be applied on the first run.
25+
2326
**`dekartxyz/dekart:0.13` -> `dekartxyz/dekart:0.14`**
2427

2528
No breaking changes, just update the docker tag. New Postgres migrations will be applied on the first run.

layouts/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
background-size: 100%;
99
-webkit-background-clip: text;
1010
-moz-background-clip: text;
11-
-webkit-text-fill-color: transparent;
11+
-webkit-text-fill-color: transparent;
1212
-moz-text-fill-color: transparent;
1313
">{{ .Title }}</h1>
1414
</div>
@@ -49,7 +49,7 @@
4949
<div class="col-lg-9 col-xl-8 text-center">
5050
<p class="mt-2"><a class="btn btn-primary btn-lg" href="/docs/about/playground/" role="button">BigQuery Live
5151
Demo</a></p>
52-
<p><a target="_blank" href="https://github.com/dekart-xyz/dekart/releases/tag/v0.14.1">Latest release 0.14.1</a>
52+
<p><a target="_blank" href="https://github.com/dekart-xyz/dekart/releases/tag/v0.15.0">Latest release 0.15.0</a>
5353
</p>
5454
</div>
5555
</div>

package-lock.json

Lines changed: 33 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)