Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Premium Codebase Documentation #50

Merged
merged 1 commit into from
Oct 16, 2024
Merged

Premium Codebase Documentation #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions config/_default/menus.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@
identifier = "about"
url = "/docs/about/"

[[docs]]
name = "Map Examples"
weight = 1
identifier = "examples"
url = "/docs/about/"


[[main]]
name = "Login"
Expand Down
6 changes: 3 additions & 3 deletions content/docs/about/kepler-gl-map-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Kepler.gl maps examples"
title: "BigQuery Kepler.gl Maps Examples"
description: "Kepler.gl maps examples created on Dekart with public BigQuery datasets, Overture Data, and OpenStreetMap data"
lead: ""
date: 2024-05-21T07:13:05+02:00
lastmod: 2024-05-21T07:13:05+02:00
images: []
menu:
docs:
parent: "about"
parent: "examples"
name: "BigQuery Public Datasets"
weight: 999
toc: true
canonical: ""
Expand Down
5 changes: 3 additions & 2 deletions content/docs/about/overture-maps-examples/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Overture Maps Examples"
title: "BigQuery Overture Maps Examples"
description: "Collection of kepler.gl maps created from Overture Data in BigQuery public dataset using SQL and Dekart."
lead: ""
date: 2024-08-28T07:26:19+02:00
Expand All @@ -8,7 +8,8 @@ draft: false
images: ["77dc6f7f-c91c-4099-8dc3-8f043d46cdfb.png"]
menu:
docs:
parent: "about"
parent: "examples"
name: "BigQuery Overture Maps"
weight: 999
toc: true
canonical: ""
Expand Down
7 changes: 4 additions & 3 deletions content/docs/about/snowflake-kepler-gl-examples/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
title: "Snowflake Kepler.gl Examples"
description: "Collection of Kepler.gl maps created with Snowflake public dataset using SQL."
title: "Snowflake Kepler.gl Maps Examples"
description: "Collection of Kepler.gl maps examples created with Snowflake public dataset using SQL."
lead: ""
date: 2024-08-28T07:26:19+02:00
lastmod: 2024-09-23T07:26:19+02:00
draft: false
images: ["f392b7ab-b64a-43f3-b100-650eb7b8fdef.png"]
menu:
docs:
parent: "about"
parent: "examples"
name: "Snowflake Free Datasets"
weight: 999
toc: true
canonical: ""
Expand Down
3 changes: 0 additions & 3 deletions content/docs/about/your-datasets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ lastmod: 2021-02-21T09:17:56+01:00
draft: false
toc: false
images: []
menu:
docs:
parent: "about"

---

Expand Down
5 changes: 4 additions & 1 deletion content/docs/configuration/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ images: []
| Name | Description |
| ------------- | ------------- |
| `DEKART_MAPBOX_TOKEN` | <a href="https://docs.mapbox.com/help/how-mapbox-works/access-tokens/">Mapbox Token</a> to show a map|
| `DEKART_POSTGRES_DB` | Database name. Dekart needs Postgres Database to store query meta information. <br> *Example*: `dekart`|
| `DEKART_POSTGRES_DB` | Database name. Dekart needs Postgres Database to store query meta information. Alternatively SQLite can be used, see bellow. <br> *Example*: `dekart`|
| `DEKART_POSTGRES_HOST` | *Example*: `localhost`|
| `DEKART_POSTGRES_PORT` | *Example*: `5432`|
| `DEKART_POSTGRES_USER` | *Example*: `postgres`|
Expand All @@ -26,6 +26,7 @@ images: []
| `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><li>`SNOWFLAKE` Queries will be cached in Snowflake query result cache. Works only with Snowflake data source. <small class="badge badge-info">version &gt;= 0.17</small></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` <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>|
| `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` |
| `DEKART_SQLITE_DB_PATH=` <br/><a href="/self-hosted/"><small class="badge badge-primary">premium &gt;= 0.17.2</small></a> | Dekart will use SQLite database instead of Postgres to store query meta information. <br> *Example*: `./dekart.db` |


## AWS
Expand Down Expand Up @@ -70,6 +71,8 @@ Required to query BigQuery and use Cloud Storage
| `DEKART_SNOWFLAKE_ACCOUNT_ID` <br/><small class="badge badge-info">version &gt;= 0.12</small> | <a target="_blank" href="https://docs.snowflake.com/en/user-guide/admin-account-identifier#using-an-account-name-as-an-identifier">Snowflake Account Identifier</a> <br> *Example*: `orgname-account_name`|
| `DEKART_SNOWFLAKE_USER` <br/><small class="badge badge-info">version &gt;= 0.12</small> | Snowflake user with default warehouse configured <br> *Example*: `example_user`|
| `DEKART_SNOWFLAKE_PASSWORD` <br/><small class="badge badge-info">version &gt;= 0.12</small> | Snowflake user password <br> *Example*: `******`|
| `DEKART_SNOWFLAKE_STAGE` <br/><a href="/self-hosted/"><small class="badge badge-primary">premium &gt;= 0.17.2</small></a> | Persist Dekart application state on Snowflake stage. Work with `DEKART_SQLITE_DB_PATH` <br> *Example*: `app_public.app_state_stage`|
| `DEKART_REQUIRE_SNOWFLAKE_CONTEXT=` <br/><a href="/self-hosted/"><small class="badge badge-primary">premium &gt;= 0.17.2</small></a> | Authorize user using `Sf-Context-Current-User` header. Used in Snowpark environment. <br> *Example*: `1`|

## Postgres (as a data source)

Expand Down
15 changes: 8 additions & 7 deletions content/self-hosted/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ type: "html-content"

<article class="pb-5">
<div class="pb-3">
<h1 class="cloud-title display-3"><span>You Host It</span></h1>
<h1 class="cloud-title display-3"><span>Your Data. Your Rules.</span></h1>
<p class="lead text-left">
<span class="btn-group d-inline-block mr-3">
<a href="/cloud/" class="btn btn-outline-info">Cloud</a><span class="btn btn-info" role="button">Self-Hosted</span>
</span>
<span class="d-inline-block">
<mark>Run Dekart on your own setup.</mark>
<mark>You host it. Run Dekart on your own setup.</mark>
</span>
</p>
</div>
Expand Down Expand Up @@ -61,7 +61,7 @@ type: "html-content"
<li class="small mb-2">Access to the Premium Codebase on GitHub</li>
<li class="small mb-2">Monthly updates</li>
<li class="small mb-2">Slack support</li>
<li class="small mb-2">&nbsp;</li>
<li class="small mb-2"><a href="https://app.snowflake.com/marketplace/listing/GZSYZJNO4W/dekart-xyz" target="_blank">Snowpark Application Access</a></li>
</ul>
<p class="text-center mb-0"><span class="badge badge-success">Most Popular</span></p>
</div>
Expand Down Expand Up @@ -91,10 +91,10 @@ type: "html-content"
</div>
</div>
<div class="text-center pt-4 mb-4">
<p>Unlock insider discounts and learn about our roadmap.</p>
<p>
<a class="btn btn-primary btn-lg" href="https://calendly.com/vladi-dekart/30min" role="button">Book a Call</a>
</p>
<p>Unlock insider discounts and learn about our roadmap.</p>
</div>
<div class="d-flex flex-column align-items-center">
<div class="col-xl-10">
Expand All @@ -105,11 +105,12 @@ type: "html-content"
<p>Run Dekart inside your Snowflake account.</p>
<h4>Run Without Postgres</h4>
<p>Run Dekart as a single Docker instance without dependency on Postgres. The Dekart application state is automatically saved and restored from Snowflake stages, S3 (coming soon), and GCP (coming soon) buckets.</p>
<h4 class="text-muted">User Management (Coming Soon)</h4>
<h2>Get New Features First</h2>
<h4>User Management <span class="badge badge-primary">October 2024</span></h4>
<p>Assign admin, editor, or viewer permissions to users. Manage who has access to PII data and database connections.</p>
<h4 class="text-muted">Kepler.gl v3 Support (Coming Soon)</h4>
<h4>Kepler.gl v3 Support <span class="badge badge-primary">November 2024</span></h4>
<p>Get all the features of the new Kepler.gl version, including 3D tiles support.</p>
<h4 class="text-muted">Faster Data Loading with Apache Arrow</h4>
<h4>Faster Data Loading with Apache Arrow <span class="badge badge-primary">November 2024</span></h4>
<p>Use Apache Arrow to transfer more data to the client, enabling larger and faster map visualizations.</p>
</div>
</div>
Expand Down
Loading