Merge pull request dekart-xyz#3 from dekart-xyz/release-0-10

Release v0.10 documentation
Tsovak · Nov 19, 2022 · bd3087b · bd3087b
2 parents e821a39 + 7c67248
commit bd3087b
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 6 deletions.
diff --git a/.github/workflows/pages.yaml b/.github/workflows/pages.yaml
@@ -1,5 +1,9 @@
 name: Publish Pages
-on: [push]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
 jobs:
   publish:
     runs-on: ubuntu-latest
@@ -15,6 +19,7 @@ jobs:
       - run: npm run build
 
       - name: Deploy
+        if: github.event_name != 'pull_request'
         uses: JamesIves/github-pages-deploy-action@4.0.0
         with:
           branch: gh-pages

diff --git a/content/docs/configuration/environment-variables.md b/content/docs/configuration/environment-variables.md
@@ -42,6 +42,7 @@ Optionally, secure deployment with Google IAP. You have 2 options:
 | `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></ul>|
 | `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>|
 | `DEKART_CLOUD_STORAGE_BUCKET`      | Google Cloud Storage or AWS S3 bucket name where Dekart Query results will be stored. <br> *Example*: `dekart-bucket`|
+| `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` |
 
 
 ## AWS
@@ -77,6 +78,15 @@ Required to query BigQuery and use Cloud Storage
 | `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.|
 
 
+## File upload
+
+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.
+
+| Name        | Description           |
+| ------------- | ------------- |
+| `DEKART_ALLOW_FILE_UPLOAD` <br/><small class="badge badge-info">version &gt;= 0.10</small> | Enable file upload <br> *Example value*: `1`|
+
+
 ## User authorization via Google IAP
 
 Dekart can read <a target="_blank" href="https://cloud.google.com/iap/docs/signed-headers-howto">claims provided by Google IAP</a> and authorize users to:

diff --git a/content/docs/self-hosting/docker.md b/content/docs/self-hosting/docker.md
@@ -41,9 +41,9 @@ docker run \
   -e DEKART_ATHENA_CATALOG=${DEKART_ATHENA_CATALOG} \
   -e DEKART_ATHENA_S3_OUTPUT_LOCATION=${DEKART_ATHENA_S3_OUTPUT_LOCATION} \
   -e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
-  -e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
+  -e DEKART_CORS_ORIGIN=${DEKART_CORS_ORIGIN} \
   -p 8080:8080 \
-  dekartxyz/dekart:0.9
+  dekartxyz/dekart:0.10
 ```
 
 
@@ -73,8 +73,9 @@ docker run \
 		-e DEKART_BIGQUERY_PROJECT_ID=${DEKART_BIGQUERY_PROJECT_ID} \
 		-e DEKART_BIGQUERY_MAX_BYTES_BILLED=53687091200 \
 		-e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
+    -e DEKART_CORS_ORIGIN=${DEKART_CORS_ORIGIN} \
 		-p 8080:8080 \
-		dekartxyz/dekart:0.9
+		dekartxyz/dekart:0.10
 ```
 
 See details on [environment variables](/docs/configuration/environment-variables)

diff --git a/content/docs/self-hosting/upgrade.md b/content/docs/self-hosting/upgrade.md
@@ -18,10 +18,12 @@ Before you begin: it is always recommended to backup your postgres database befo
 
 For all Docker based deployments, update docker tag, for example:
 
-`dekartxyz/dekart:0.8` -> `dekartxyz/dekart:0.9`
+`dekartxyz/dekart:0.9` -> `dekartxyz/dekart:0.10`
+
+Configure `DEKART_CORS_ORIGIN` environment variable to ensure security of your instance and prevent warnings in logs.
 
 Then redeploy application
 
 ## Migration instructions
 
-There is no breaking configuration changes in version `0.9`
+There is no breaking configuration changes in version `0.10`