apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-05-01 11:56:25 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: setup guides for Airtable and ClickUp OAuth integrations

Browse source
This commit is contained in:
DESKTOP-RTLN3BA\$punk 2026-01-07 20:40:54 -08:00
parent c9a9d29c54
commit 30401f50a5
14 changed files with 154 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

97
surfsense_web/content/docs/connectors/airtable.mdx
View file

@ -3,4 +3,99 @@ title: Airtable
description: Connect your Airtable bases to SurfSense
---
# Documentation in progress
# Airtable OAuth Integration Setup Guide
This guide walks you through setting up an Airtable OAuth integration for SurfSense.
## Step 1: Access Airtable OAuth Integrations
1. Navigate to [airtable.com/create/oauth](https://airtable.com/create/oauth)
2. In the **Builder Hub**, under **Developers**, click **"OAuth integrations"**
3. Click **"Register an OAuth integration"**
![Airtable OAuth Integrations Page](/docs/connectors/airtable/airtable-oauth-integrations.png)
## Step 2: Register an Integration
Fill in the basic integration details:
| Field | Value |
|-------|-------|
| **Name** | `SurfSense` |
| **OAuth redirect URL** | `http://localhost:8000/api/v1/auth/airtable/connector/callback` |
Click **"Register integration"**
![Register Integration Form](/docs/connectors/airtable/airtable-register-integration.png)
## Step 3: Configure Scopes
After registration, configure the required scopes (permissions) for your integration:
### Record data and comments
| Scope | Description |
|-------|-------------|
| ✅ `data.recordComments:read` | See comments in records |
| ✅ `data.records:read` | See the data in records |
### Base schema
| Scope | Description |
|-------|-------------|
| ✅ `schema.bases:read` | See the structure of a base, like table names or field types |
### User metadata
| Scope | Description |
|-------|-------------|
| ✅ `user.email:read` | See the user's email address |
![Scopes Configuration](/docs/connectors/airtable/airtable-scopes.png)
## Step 4: Configure Support Information
Scroll down to configure the support information and authorization preview:
| Field | Value |
|-------|-------|
| **Support email** | Your support email address |
| **Privacy policy URL** | Your privacy policy URL |
| **Terms of service URL** | Your terms of service URL |
The preview shows what users will see when authorizing SurfSense:
- The data in your records
- Comments in your records
- The structure of your base, like table names or field types
- Your email address
Click **"Save changes"**
![Support Information & Preview](/docs/connectors/airtable/airtable-support-info.png)
## Step 5: Get OAuth Credentials
After saving, you'll find your OAuth credentials on the integration page:
1. Copy your **Client ID**
2. Copy your **Client Secret**
> ⚠️ Never share your client secret publicly.
---
## Running SurfSense with Airtable Connector
Add the Airtable environment variables to your Docker run command:
```bash
docker run -d -p 3000:3000 -p 8000:8000 \
-v surfsense-data:/data \
# Airtable Connector
-e AIRTABLE_CLIENT_ID=your_airtable_client_id \
-e AIRTABLE_CLIENT_SECRET=your_airtable_client_secret \
-e AIRTABLE_REDIRECT_URI=http://localhost:8000/api/v1/auth/airtable/connector/callback \
--name surfsense \
--restart unless-stopped \
ghcr.io/modsetter/surfsense:latest
```

53
surfsense_web/content/docs/connectors/clickup.mdx
View file

@ -3,4 +3,55 @@ title: ClickUp
description: Connect your ClickUp workspace to SurfSense
---
# Documentation in progress
# ClickUp OAuth Integration Setup Guide
This guide walks you through setting up a ClickUp OAuth integration for SurfSense.
## Step 1: Access ClickUp API Settings
1. Open your ClickUp workspace
2. Navigate to **Settings** (gear icon) → **ClickUp API**
3. You'll see the **ClickUp API Settings** page
![ClickUp API Settings Page](/docs/connectors/clickup/clickup-api-settings.png)
## Step 2: Create an App
1. Click **"+ Create an App"** in the top-right corner
2. Fill in the app details:
| Field | Value |
|-------|-------|
| **App Name** | `SurfSense` |
| **Redirect URL(s)** | `localhost:8000` |
3. Click **"Save"** to create the app
![App Created with Credentials](/docs/connectors/clickup/clickup-app-credentials.png)
## Step 3: Get OAuth Credentials
After creating the app, you'll see your credentials:
1. Copy your **Client ID**
2. Copy your **Client Secret** (click "Show" to reveal, or "Regenerate" if needed)
> ⚠️ Never share your client secret publicly.
---
## Running SurfSense with ClickUp Connector
Add the ClickUp environment variables to your Docker run command:
```bash
docker run -d -p 3000:3000 -p 8000:8000 \
-v surfsense-data:/data \
# ClickUp Connector
-e CLICKUP_CLIENT_ID=your_clickup_client_id \
-e CLICKUP_CLIENT_SECRET=your_clickup_client_secret \
-e CLICKUP_REDIRECT_URI=http://localhost:8000/api/v1/auth/clickup/connector/callback \
--name surfsense \
--restart unless-stopped \
ghcr.io/modsetter/surfsense:latest
```

2
surfsense_web/content/docs/connectors/confluence.mdx
View file

@ -85,7 +85,7 @@ Select the **"Granular scopes"** tab and enable:
1. In the left sidebar, click **"Settings"**
2. Copy your **Client ID** and **Client Secret**
> ⚠️ Never share your client secret publicly or include it in code repositories.
> ⚠️ Never share your client secret publicly.
---

2
surfsense_web/content/docs/connectors/gmail.mdx
View file

@ -60,7 +60,7 @@ This guide walks you through setting up a Google OAuth 2.0 integration for SurfS
1. After creating the OAuth client, you'll see a dialog with your credentials
2. Copy your **Client ID** and **Client Secret**
> ⚠️ Never share your client secret publicly or include it in code repositories.
> ⚠️ Never share your client secret publicly.
![Google Developer Console Config](/docs/connectors/google/google_oauth_config.png)

2
surfsense_web/content/docs/connectors/google-calendar.mdx
View file

@ -59,7 +59,7 @@ This guide walks you through setting up a Google OAuth 2.0 integration for SurfS
1. After creating the OAuth client, you'll see a dialog with your credentials
2. Copy your **Client ID** and **Client Secret**
> ⚠️ Never share your client secret publicly or include it in code repositories.
> ⚠️ Never share your client secret publicly.
![Google Developer Console Config](/docs/connectors/google/google_oauth_config.png)

2
surfsense_web/content/docs/connectors/google-drive.mdx
View file

@ -60,7 +60,7 @@ This guide walks you through setting up a Google OAuth 2.0 integration for SurfS
1. After creating the OAuth client, you'll see a dialog with your credentials
2. Copy your **Client ID** and **Client Secret**
> ⚠️ Never share your client secret publicly or include it in code repositories.
> ⚠️ Never share your client secret publicly.
![Google Developer Console Config](/docs/connectors/google/google_oauth_config.png)

2
surfsense_web/content/docs/connectors/jira.mdx
View file

@ -72,7 +72,7 @@ This guide walks you through setting up an Atlassian OAuth 2.0 (3LO) integration
1. In the left sidebar, click **"Settings"**
2. Copy your **Client ID** and **Client Secret**
> ⚠️ Never share your client secret publicly or include it in code repositories.
> ⚠️ Never share your client secret publicly.
---

2
surfsense_web/content/docs/connectors/slack.mdx
View file

@ -32,7 +32,7 @@ After creating the app, you'll be taken to the **Basic Information** page. Here
1. Copy your **Client ID**
2. Copy your **Client Secret** (click Show to reveal)
> ⚠️ Never share your app credentials publicly or include them in code repositories.
> ⚠️ Never share your app credentials publicly.
![Basic Information - App Credentials](/docs/connectors/slack/slack-app-credentials.png)