From 93c427550de9a6a3be9501695a8129f386aa4f90 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 11 Dec 2025 12:03:18 +0000 Subject: [PATCH 1/2] Update self-host/customize-deployment/google-sheets-integration.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- .../google-sheets-integration.mdx | 59 +++++++++++-------- 1 file changed, 36 insertions(+), 23 deletions(-) diff --git a/self-host/customize-deployment/google-sheets-integration.mdx b/self-host/customize-deployment/google-sheets-integration.mdx index 14945e75..5c150cd6 100644 --- a/self-host/customize-deployment/google-sheets-integration.mdx +++ b/self-host/customize-deployment/google-sheets-integration.mdx @@ -1,23 +1,36 @@ ---- -title: Configure a Google Sheets integration for self-hosted Lightdash -description: "In this guide we will show you how you can [upload to Google Sheets in scheduled deliveries](/references/google-sheets) and upload results from Google Sheets on `charts` on your on self-hosted Lightdash server." -sidebarTitle: Google sheets ---- - -### Enable Google SSO - -To authenticate Google users, first you need to enable [Google SSO](https://docs.lightdash.com/self-host/customize-deployment/use-sso-login-for-self-hosted-lightdash#google) on your server. - -If you still want to keep users to login via email/password or another SSO provider, you can set this `AUTH_GOOGLE_ENABLED` variable to `false` - -### Create an API key for Google file picker - -We use Google Drive picker API to allow you to select your spreadsheet files on `Syncs` - -To create a Google Drive picker API you need to add a new API key in [APIs and services in Google Cloud](https://console.cloud.google.com/apis/credentials). Your Google project must have the following API's enabled: - -* Google Drive API -* Google Picker API -* Google Sheets API - -Save the API key in a new environment variable `GOOGLE_DRIVE_API_KEY` +--- +title: Configure a Google Sheets integration for self-hosted Lightdash +description: "In this guide we will show you how you can [upload to Google Sheets in scheduled deliveries](/references/google-sheets) and upload results from Google Sheets on `charts` on your on self-hosted Lightdash server." +sidebarTitle: Google sheets +--- + +### Configure Google OAuth client + +To use Google Sheets sync, you need to set up a Google OAuth client, even if you don't want to enable Google login. + +1. Go to [APIs and services credentials in Google Cloud](https://console.cloud.google.com/apis/credentials) +2. Create a new OAuth 2.0 Client ID (Web application type) +3. Configure the following: + - **Authorised JavaScript origins**: `https://` + - **Authorised redirect URI**: `https:///api/v1/oauth/redirect/google` +4. Save the client ID and secret as environment variables: + - `AUTH_GOOGLE_OAUTH2_CLIENT_ID` + - `AUTH_GOOGLE_OAUTH2_CLIENT_SECRET` + + +Lightdash automatically requests the necessary OAuth scopes (`drive.file` and `spreadsheets`) when users connect to Google Sheets. You don't need to configure scopes on the OAuth client itself. + + +If you already use another SSO provider (like Okta) for login and only want Google Sheets functionality, set `AUTH_GOOGLE_ENABLED=false`. This hides Google as a login option while still allowing the Google Sheets integration to work. + +### Create an API key for Google file picker + +We use Google Drive picker API to allow you to select your spreadsheet files on `Syncs` + +To create a Google Drive picker API you need to add a new API key in [APIs and services in Google Cloud](https://console.cloud.google.com/apis/credentials). Your Google project must have the following API's enabled: + +* Google Drive API +* Google Picker API +* Google Sheets API + +Save the API key in a new environment variable `GOOGLE_DRIVE_API_KEY` From 5f1379c8bdf755d41b58774bf059e5b9a972676a Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 11 Dec 2025 12:14:40 +0000 Subject: [PATCH 2/2] Documentation edits made through Mintlify web editor --- .../google-sheets-integration.mdx | 27 ++++++------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/self-host/customize-deployment/google-sheets-integration.mdx b/self-host/customize-deployment/google-sheets-integration.mdx index 5c150cd6..a99af6b1 100644 --- a/self-host/customize-deployment/google-sheets-integration.mdx +++ b/self-host/customize-deployment/google-sheets-integration.mdx @@ -1,36 +1,25 @@ --- -title: Configure a Google Sheets integration for self-hosted Lightdash +title: "Configure a Google Sheets integration for self-hosted Lightdash" description: "In this guide we will show you how you can [upload to Google Sheets in scheduled deliveries](/references/google-sheets) and upload results from Google Sheets on `charts` on your on self-hosted Lightdash server." -sidebarTitle: Google sheets +sidebarTitle: "Google sheets" --- -### Configure Google OAuth client +### Enable Google SSO -To use Google Sheets sync, you need to set up a Google OAuth client, even if you don't want to enable Google login. +To authenticate Google users, first you need to enable [Google SSO](https://docs.lightdash.com/self-host/customize-deployment/use-sso-login-for-self-hosted-lightdash#google) on your server. -1. Go to [APIs and services credentials in Google Cloud](https://console.cloud.google.com/apis/credentials) -2. Create a new OAuth 2.0 Client ID (Web application type) -3. Configure the following: - - **Authorised JavaScript origins**: `https://` - - **Authorised redirect URI**: `https:///api/v1/oauth/redirect/google` -4. Save the client ID and secret as environment variables: - - `AUTH_GOOGLE_OAUTH2_CLIENT_ID` - - `AUTH_GOOGLE_OAUTH2_CLIENT_SECRET` +If you still want to keep users to login via email/password or another SSO provider, set `AUTH_GOOGLE_ENABLED=false`. This hides Google as a login option while still allowing the Google Sheets integration to work. -Lightdash automatically requests the necessary OAuth scopes (`drive.file` and `spreadsheets`) when users connect to Google Sheets. You don't need to configure scopes on the OAuth client itself. + Lightdash requests the necessary OAuth scopes -`drive.file` and `spreadsheets` when users connect to Google Sheets. -If you already use another SSO provider (like Okta) for login and only want Google Sheets functionality, set `AUTH_GOOGLE_ENABLED=false`. This hides Google as a login option while still allowing the Google Sheets integration to work. - ### Create an API key for Google file picker We use Google Drive picker API to allow you to select your spreadsheet files on `Syncs` To create a Google Drive picker API you need to add a new API key in [APIs and services in Google Cloud](https://console.cloud.google.com/apis/credentials). Your Google project must have the following API's enabled: -* Google Drive API -* Google Picker API -* Google Sheets API +- Google Picker API -Save the API key in a new environment variable `GOOGLE_DRIVE_API_KEY` +Save the API key in a new environment variable `GOOGLE_DRIVE_API_KEY` \ No newline at end of file