mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-04-25 08:46:22 +02:00
91 lines
3.1 KiB
Text
91 lines
3.1 KiB
Text
---
|
|
title: Gmail
|
|
description: Connect your Gmail to SurfSense
|
|
---
|
|
|
|
# Gmail OAuth Integration Setup Guide
|
|
|
|
This guide walks you through setting up a Google OAuth 2.0 integration for SurfSense to connect your Gmail account.
|
|
|
|
## Step 1: Access the Google Cloud Console
|
|
|
|
1. Navigate to [Google Cloud Console](https://console.cloud.google.com/)
|
|
2. Select an existing project or create a new one
|
|
|
|
## Step 2: Enable Required APIs
|
|
|
|
1. Go to **APIs & Services** > **Library**
|
|
2. Search for and enable the following APIs:
|
|
- **People API** (required for Google OAuth)
|
|
- **Gmail API** (required for Gmail connector)
|
|
|
|
|
|
|
|
## Step 3: Configure OAuth Consent Screen
|
|
|
|
1. Go to **APIs & Services** > **OAuth consent screen**
|
|
2. Select **External** user type (or Internal if using Google Workspace)
|
|
3. Fill in the required information:
|
|
- **App name**: `SurfSense`
|
|
- **User support email**: Your email address
|
|
- **Developer contact information**: Your email address
|
|
4. Click **Save and Continue**
|
|
|
|
|
|
|
|
### Add Scopes
|
|
|
|
1. Click **Add or Remove Scopes**
|
|
2. Add the following scopes:
|
|
- `https://www.googleapis.com/auth/gmail.modify` - Read, compose, send, and permanently delete Gmail messages
|
|
- `https://www.googleapis.com/auth/userinfo.email` - View user email address
|
|
- `https://www.googleapis.com/auth/userinfo.profile` - View user profile info
|
|
- `openid` - OpenID Connect authentication
|
|
3. Click **Update** and then **Save and Continue**
|
|
|
|
<Callout type="info">
|
|
The `gmail.modify` scope is required for HITL (Human-in-the-Loop) tools like sending emails, creating drafts, and trashing messages. If you only need read access, you can use `gmail.readonly` instead, but HITL tools will not work.
|
|
</Callout>
|
|
|
|
## Step 4: Create OAuth Client ID
|
|
|
|
1. Go to **APIs & Services** > **Credentials**
|
|
2. Click **Create Credentials** > **OAuth client ID**
|
|
3. Select **Web application** as the application type
|
|
4. Enter **Name**: `SurfSense`
|
|
5. Under **Authorized redirect URIs**, add:
|
|
```
|
|
http://localhost:8000/api/v1/auth/google/gmail/connector/callback
|
|
```
|
|
6. Click **Create**
|
|
|
|
|
|
|
|
## Step 5: Get OAuth Credentials
|
|
|
|
1. After creating the OAuth client, you'll see a dialog with your credentials
|
|
2. Copy your **Client ID** and **Client Secret**
|
|
|
|
<Callout type="warn">
|
|
Never share your client secret publicly.
|
|
</Callout>
|
|
|
|
|
|
|
|
---
|
|
|
|
## Running SurfSense with Gmail Connector
|
|
|
|
Add the Google OAuth credentials to your `.env` file (created during [Docker installation](/docs/docker-installation/docker-compose)):
|
|
|
|
```bash
|
|
GOOGLE_OAUTH_CLIENT_ID=your_google_client_id
|
|
GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret
|
|
GOOGLE_GMAIL_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/gmail/connector/callback
|
|
```
|
|
|
|
Then restart the services:
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|