diff --git a/surfsense_web/content/docs/connectors/airtable.mdx b/surfsense_web/content/docs/connectors/airtable.mdx index db7fe3ac0..71148335c 100644 --- a/surfsense_web/content/docs/connectors/airtable.mdx +++ b/surfsense_web/content/docs/connectors/airtable.mdx @@ -88,16 +88,16 @@ After saving, you'll find your OAuth credentials on the integration page: ## 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 -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 +AIRTABLE_CLIENT_ID=your_airtable_client_id +AIRTABLE_CLIENT_SECRET=your_airtable_client_secret +AIRTABLE_REDIRECT_URI=http://localhost:8000/api/v1/auth/airtable/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ``` \ No newline at end of file diff --git a/surfsense_web/content/docs/connectors/clickup.mdx b/surfsense_web/content/docs/connectors/clickup.mdx index 960b88370..768bca859 100644 --- a/surfsense_web/content/docs/connectors/clickup.mdx +++ b/surfsense_web/content/docs/connectors/clickup.mdx @@ -44,16 +44,16 @@ After creating the app, you'll see your credentials: ## 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 -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 +CLICKUP_CLIENT_ID=your_clickup_client_id +CLICKUP_CLIENT_SECRET=your_clickup_client_secret +CLICKUP_REDIRECT_URI=http://localhost:8000/api/v1/auth/clickup/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ``` \ No newline at end of file diff --git a/surfsense_web/content/docs/connectors/confluence.mdx b/surfsense_web/content/docs/connectors/confluence.mdx index 57116cf29..3ee3394a4 100644 --- a/surfsense_web/content/docs/connectors/confluence.mdx +++ b/surfsense_web/content/docs/connectors/confluence.mdx @@ -97,16 +97,16 @@ Select the **"Granular scopes"** tab and enable: ## 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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Confluence Connector - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +ATLASSIAN_CLIENT_ID=your_atlassian_client_id +ATLASSIAN_CLIENT_SECRET=your_atlassian_client_secret +CONFLUENCE_REDIRECT_URI=http://localhost:8000/api/v1/auth/confluence/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ``` diff --git a/surfsense_web/content/docs/connectors/discord.mdx b/surfsense_web/content/docs/connectors/discord.mdx index a90bcfe87..05825e0ea 100644 --- a/surfsense_web/content/docs/connectors/discord.mdx +++ b/surfsense_web/content/docs/connectors/discord.mdx @@ -64,17 +64,17 @@ You'll also see your **Application ID** and **Public Key** on this page. ## 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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Discord Connector - -e DISCORD_CLIENT_ID=your_discord_client_id \ - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +DISCORD_CLIENT_ID=your_discord_client_id +DISCORD_CLIENT_SECRET=your_discord_client_secret +DISCORD_REDIRECT_URI=http://localhost:8000/api/v1/auth/discord/connector/callback +DISCORD_BOT_TOKEN=your_discord_bot_token +``` + +Then restart the services: + +```bash +docker compose up -d ``` diff --git a/surfsense_web/content/docs/connectors/gmail.mdx b/surfsense_web/content/docs/connectors/gmail.mdx index 2b514f89e..1b3f81efe 100644 --- a/surfsense_web/content/docs/connectors/gmail.mdx +++ b/surfsense_web/content/docs/connectors/gmail.mdx @@ -70,16 +70,16 @@ This guide walks you through setting up a Google OAuth 2.0 integration for SurfS ## 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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Gmail Connector - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +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 ``` diff --git a/surfsense_web/content/docs/connectors/google-calendar.mdx b/surfsense_web/content/docs/connectors/google-calendar.mdx index 7919d0361..481b05444 100644 --- a/surfsense_web/content/docs/connectors/google-calendar.mdx +++ b/surfsense_web/content/docs/connectors/google-calendar.mdx @@ -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 -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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Google Calendar Connector - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +GOOGLE_OAUTH_CLIENT_ID=your_google_client_id +GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret +GOOGLE_CALENDAR_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/calendar/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ``` diff --git a/surfsense_web/content/docs/connectors/google-drive.mdx b/surfsense_web/content/docs/connectors/google-drive.mdx index 402b25566..238100860 100644 --- a/surfsense_web/content/docs/connectors/google-drive.mdx +++ b/surfsense_web/content/docs/connectors/google-drive.mdx @@ -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 -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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Google Drive Connector - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +GOOGLE_OAUTH_CLIENT_ID=your_google_client_id +GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret +GOOGLE_DRIVE_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/drive/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ``` diff --git a/surfsense_web/content/docs/connectors/jira.mdx b/surfsense_web/content/docs/connectors/jira.mdx index c6b5a26e1..5bddbab8d 100644 --- a/surfsense_web/content/docs/connectors/jira.mdx +++ b/surfsense_web/content/docs/connectors/jira.mdx @@ -84,16 +84,16 @@ This guide walks you through setting up an Atlassian OAuth 2.0 (3LO) integration ## 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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Jira Connector - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +ATLASSIAN_CLIENT_ID=your_atlassian_client_id +ATLASSIAN_CLIENT_SECRET=your_atlassian_client_secret +JIRA_REDIRECT_URI=http://localhost:8000/api/v1/auth/jira/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ``` diff --git a/surfsense_web/content/docs/connectors/linear.mdx b/surfsense_web/content/docs/connectors/linear.mdx index 5fb7bc8c5..3fd82aba1 100644 --- a/surfsense_web/content/docs/connectors/linear.mdx +++ b/surfsense_web/content/docs/connectors/linear.mdx @@ -53,17 +53,17 @@ After creating the application, you'll see your OAuth credentials: ## 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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Linear Connector - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +LINEAR_CLIENT_ID=your_linear_client_id +LINEAR_CLIENT_SECRET=your_linear_client_secret +LINEAR_REDIRECT_URI=http://localhost:8000/api/v1/auth/linear/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ``` diff --git a/surfsense_web/content/docs/connectors/microsoft-teams.mdx b/surfsense_web/content/docs/connectors/microsoft-teams.mdx index 53f36c249..5a05be709 100644 --- a/surfsense_web/content/docs/connectors/microsoft-teams.mdx +++ b/surfsense_web/content/docs/connectors/microsoft-teams.mdx @@ -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 -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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Microsoft Teams Connector - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +TEAMS_CLIENT_ID=your_microsoft_client_id +TEAMS_CLIENT_SECRET=your_microsoft_client_secret +TEAMS_REDIRECT_URI=http://localhost:8000/api/v1/auth/teams/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ``` diff --git a/surfsense_web/content/docs/connectors/notion.mdx b/surfsense_web/content/docs/connectors/notion.mdx index 6fcda8dae..ca5856340 100644 --- a/surfsense_web/content/docs/connectors/notion.mdx +++ b/surfsense_web/content/docs/connectors/notion.mdx @@ -91,16 +91,16 @@ For additional information: ## 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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Notion Connector - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +NOTION_OAUTH_CLIENT_ID=your_notion_client_id +NOTION_OAUTH_CLIENT_SECRET=your_notion_client_secret +NOTION_REDIRECT_URI=http://localhost:8000/api/v1/auth/notion/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ``` diff --git a/surfsense_web/content/docs/connectors/slack.mdx b/surfsense_web/content/docs/connectors/slack.mdx index 072b83343..af38487cc 100644 --- a/surfsense_web/content/docs/connectors/slack.mdx +++ b/surfsense_web/content/docs/connectors/slack.mdx @@ -80,16 +80,16 @@ Click **"Add an OAuth Scope"** to add each scope. ## 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 -docker run -d -p 3000:3000 -p 8000:8000 \ - -v surfsense-data:/data \ - # Slack Connector - -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 \ - --name surfsense \ - --restart unless-stopped \ - ghcr.io/modsetter/surfsense:latest +SLACK_CLIENT_ID=your_slack_client_id +SLACK_CLIENT_SECRET=your_slack_client_secret +SLACK_REDIRECT_URI=http://localhost:8000/api/v1/auth/slack/connector/callback +``` + +Then restart the services: + +```bash +docker compose up -d ```