apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-05-17 18:35:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: update connector documentation to specify adding credentials to .env file instead of Docker run command

Browse source
This commit is contained in:
Anish Sarkar 2026-02-26 19:24:55 +05:30
parent 2e8e85a4ef
commit 7d99dbc0d5
12 changed files with 121 additions and 121 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -88,16 +88,16 @@ After saving, you'll find your OAuth credentials on the integration page:
## Running SurfSense with Airtable Connector ## Running SurfSense with Airtable Connector
Add the Airtable environment variables to your Docker run command: Add the Airtable credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ AIRTABLE_CLIENT_ID=your_airtable_client_id
-v surfsense-data:/data \ AIRTABLE_CLIENT_SECRET=your_airtable_client_secret
# Airtable Connector AIRTABLE_REDIRECT_URI=http://localhost:8000/api/v1/auth/airtable/connector/callback
-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 \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

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

@ -44,16 +44,16 @@ After creating the app, you'll see your credentials:
## Running SurfSense with ClickUp Connector ## Running SurfSense with ClickUp Connector
Add the ClickUp environment variables to your Docker run command: Add the ClickUp credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ CLICKUP_CLIENT_ID=your_clickup_client_id
-v surfsense-data:/data \ CLICKUP_CLIENT_SECRET=your_clickup_client_secret
# ClickUp Connector CLICKUP_REDIRECT_URI=http://localhost:8000/api/v1/auth/clickup/connector/callback
-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 \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

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

@ -97,16 +97,16 @@ Select the **"Granular scopes"** tab and enable:
## Running SurfSense with Confluence Connector ## Running SurfSense with Confluence Connector
Add the Atlassian environment variables to your Docker run command: Add the Atlassian credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ ATLASSIAN_CLIENT_ID=your_atlassian_client_id
-v surfsense-data:/data \ ATLASSIAN_CLIENT_SECRET=your_atlassian_client_secret
# Confluence Connector CONFLUENCE_REDIRECT_URI=http://localhost:8000/api/v1/auth/confluence/connector/callback
-e ATLASSIAN_CLIENT_ID=your_atlassian_client_id \ ```
-e ATLASSIAN_CLIENT_SECRET=your_atlassian_client_secret \
-e CONFLUENCE_REDIRECT_URI=http://localhost:8000/api/v1/auth/confluence/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

22
surfsense_web/content/docs/connectors/discord.mdx
View file

@ -64,17 +64,17 @@ You'll also see your **Application ID** and **Public Key** on this page.
## Running SurfSense with Discord Connector ## Running SurfSense with Discord Connector
Add the Discord environment variables to your Docker run command: Add the Discord credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ DISCORD_CLIENT_ID=your_discord_client_id
-v surfsense-data:/data \ DISCORD_CLIENT_SECRET=your_discord_client_secret
# Discord Connector DISCORD_REDIRECT_URI=http://localhost:8000/api/v1/auth/discord/connector/callback
-e DISCORD_CLIENT_ID=your_discord_client_id \ DISCORD_BOT_TOKEN=your_discord_bot_token
-e DISCORD_CLIENT_SECRET=your_discord_client_secret \ ```
-e DISCORD_REDIRECT_URI=http://localhost:8000/api/v1/auth/discord/connector/callback \
-e DISCORD_BOT_TOKEN=http://localhost:8000/api/v1/auth/discord/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

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

@ -70,16 +70,16 @@ This guide walks you through setting up a Google OAuth 2.0 integration for SurfS
## Running SurfSense with Gmail Connector ## Running SurfSense with Gmail Connector
Add the Google OAuth environment variables to your Docker run command: Add the Google OAuth credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ GOOGLE_OAUTH_CLIENT_ID=your_google_client_id
-v surfsense-data:/data \ GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret
# Gmail Connector GOOGLE_GMAIL_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/gmail/connector/callback
-e GOOGLE_OAUTH_CLIENT_ID=your_google_client_id \ ```
-e GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret \
-e GOOGLE_GMAIL_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/gmail/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

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

@ -69,16 +69,16 @@ This guide walks you through setting up a Google OAuth 2.0 integration for SurfS
## Running SurfSense with Google Calendar Connector ## Running SurfSense with Google Calendar Connector
Add the Google OAuth environment variables to your Docker run command: Add the Google OAuth credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ GOOGLE_OAUTH_CLIENT_ID=your_google_client_id
-v surfsense-data:/data \ GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret
# Google Calendar Connector GOOGLE_CALENDAR_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/calendar/connector/callback
-e GOOGLE_OAUTH_CLIENT_ID=your_google_client_id \ ```
-e GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret \
-e GOOGLE_CALENDAR_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/calendar/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

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

@ -70,16 +70,16 @@ This guide walks you through setting up a Google OAuth 2.0 integration for SurfS
## Running SurfSense with Google Drive Connector ## Running SurfSense with Google Drive Connector
Add the Google OAuth environment variables to your Docker run command: Add the Google OAuth credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ GOOGLE_OAUTH_CLIENT_ID=your_google_client_id
-v surfsense-data:/data \ GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret
# Google Drive Connector GOOGLE_DRIVE_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/drive/connector/callback
-e GOOGLE_OAUTH_CLIENT_ID=your_google_client_id \ ```
-e GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret \
-e GOOGLE_DRIVE_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/drive/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

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

@ -84,16 +84,16 @@ This guide walks you through setting up an Atlassian OAuth 2.0 (3LO) integration
## Running SurfSense with Jira Connector ## Running SurfSense with Jira Connector
Add the Atlassian environment variables to your Docker run command: Add the Atlassian credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ ATLASSIAN_CLIENT_ID=your_atlassian_client_id
-v surfsense-data:/data \ ATLASSIAN_CLIENT_SECRET=your_atlassian_client_secret
# Jira Connector JIRA_REDIRECT_URI=http://localhost:8000/api/v1/auth/jira/connector/callback
-e ATLASSIAN_CLIENT_ID=your_atlassian_client_id \ ```
-e ATLASSIAN_CLIENT_SECRET=your_atlassian_client_secret \
-e JIRA_REDIRECT_URI=http://localhost:8000/api/v1/auth/jira/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

20
surfsense_web/content/docs/connectors/linear.mdx
View file

@ -53,17 +53,17 @@ After creating the application, you'll see your OAuth credentials:
## Running SurfSense with Linear Connector ## Running SurfSense with Linear Connector
Add the Linear environment variables to your Docker run command: Add the Linear credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ LINEAR_CLIENT_ID=your_linear_client_id
-v surfsense-data:/data \ LINEAR_CLIENT_SECRET=your_linear_client_secret
# Linear Connector LINEAR_REDIRECT_URI=http://localhost:8000/api/v1/auth/linear/connector/callback
-e LINEAR_CLIENT_ID=your_linear_client_id \ ```
-e LINEAR_CLIENT_SECRET=your_linear_client_secret \
-e LINEAR_REDIRECT_URI=http://localhost:8000/api/v1/auth/linear/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

20
surfsense_web/content/docs/connectors/microsoft-teams.mdx
View file

@ -90,16 +90,16 @@ After registration, you'll be taken to the app's **Overview** page. Here you'll
## Running SurfSense with Microsoft Teams Connector ## Running SurfSense with Microsoft Teams Connector
Add the Microsoft Teams environment variables to your Docker run command: Add the Microsoft Teams credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ TEAMS_CLIENT_ID=your_microsoft_client_id
-v surfsense-data:/data \ TEAMS_CLIENT_SECRET=your_microsoft_client_secret
# Microsoft Teams Connector TEAMS_REDIRECT_URI=http://localhost:8000/api/v1/auth/teams/connector/callback
-e TEAMS_CLIENT_ID=your_microsoft_client_id \ ```
-e TEAMS_CLIENT_SECRET=your_microsoft_client_secret \
-e TEAMS_REDIRECT_URI=http://localhost:8000/api/v1/auth/teams/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

20
surfsense_web/content/docs/connectors/notion.mdx
View file

@ -91,16 +91,16 @@ For additional information:
## Running SurfSense with Notion Connector ## Running SurfSense with Notion Connector
Add the Notion environment variables to your Docker run command: Add the Notion credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ NOTION_OAUTH_CLIENT_ID=your_notion_client_id
-v surfsense-data:/data \ NOTION_OAUTH_CLIENT_SECRET=your_notion_client_secret
# Notion Connector NOTION_REDIRECT_URI=http://localhost:8000/api/v1/auth/notion/connector/callback
-e NOTION_OAUTH_CLIENT_ID=your_notion_client_id \ ```
-e NOTION_OAUTH_CLIENT_SECRET=your_notion_client_secret \
-e NOTION_REDIRECT_URI=http://localhost:8000/api/v1/auth/notion/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```

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

@ -80,16 +80,16 @@ Click **"Add an OAuth Scope"** to add each scope.
## Running SurfSense with Slack Connector ## Running SurfSense with Slack Connector
Add the Slack environment variables to your Docker run command: Add the Slack credentials to your `.env` file (created during [Docker installation](/docs/docker-installation)):
```bash ```bash
docker run -d -p 3000:3000 -p 8000:8000 \ SLACK_CLIENT_ID=your_slack_client_id
-v surfsense-data:/data \ SLACK_CLIENT_SECRET=your_slack_client_secret
# Slack Connector SLACK_REDIRECT_URI=http://localhost:8000/api/v1/auth/slack/connector/callback
-e SLACK_CLIENT_ID=your_slack_client_id \ ```
-e SLACK_CLIENT_SECRET=your_slack_client_secret \
-e SLACK_REDIRECT_URI=https://localhost:8000/api/v1/auth/slack/connector/callback \ Then restart the services:
--name surfsense \
--restart unless-stopped \ ```bash
ghcr.io/modsetter/surfsense:latest docker compose up -d
``` ```