No connectors found
- You haven't added any connectors yet. Add one to enhance your
- search capabilities.
+ You haven't added any connectors yet. Add one to enhance your search capabilities.
-
-
+
diff --git a/surfsense_web/app/dashboard/[search_space_id]/connectors/[connector_id]/edit/page.tsx b/surfsense_web/app/dashboard/[search_space_id]/connectors/[connector_id]/edit/page.tsx
index bd8b61cd3..a535319a5 100644
--- a/surfsense_web/app/dashboard/[search_space_id]/connectors/[connector_id]/edit/page.tsx
+++ b/surfsense_web/app/dashboard/[search_space_id]/connectors/[connector_id]/edit/page.tsx
@@ -1,280 +1,269 @@
"use client";
-import React, { useEffect } from "react";
-import { useRouter, useParams } from "next/navigation";
import { motion } from "framer-motion";
+import { ArrowLeft, Check, Loader2 } from "lucide-react";
+import { useParams, useRouter } from "next/navigation";
+import { useEffect } from "react";
import { toast } from "sonner";
-import { ArrowLeft, Check, Loader2, Github } from "lucide-react";
-
-import { Form } from "@/components/ui/form";
-import { Button } from "@/components/ui/button";
-import {
- Card,
- CardContent,
- CardDescription,
- CardFooter,
- CardHeader,
- CardTitle,
-} from "@/components/ui/card";
-
-// Import Utils, Types, Hook, and Components
-import { getConnectorTypeDisplay } from "@/lib/connectors/utils";
-import { useConnectorEditPage } from "@/hooks/useConnectorEditPage";
+import { getConnectorIcon } from "@/components/chat";
import { EditConnectorLoadingSkeleton } from "@/components/editConnector/EditConnectorLoadingSkeleton";
import { EditConnectorNameForm } from "@/components/editConnector/EditConnectorNameForm";
import { EditGitHubConnectorConfig } from "@/components/editConnector/EditGitHubConnectorConfig";
import { EditSimpleTokenForm } from "@/components/editConnector/EditSimpleTokenForm";
-import { getConnectorIcon } from "@/components/chat";
+import { Button } from "@/components/ui/button";
+import {
+ Card,
+ CardContent,
+ CardDescription,
+ CardFooter,
+ CardHeader,
+ CardTitle,
+} from "@/components/ui/card";
+import { Form } from "@/components/ui/form";
+import { useConnectorEditPage } from "@/hooks/useConnectorEditPage";
+// Import Utils, Types, Hook, and Components
+import { getConnectorTypeDisplay } from "@/lib/connectors/utils";
export default function EditConnectorPage() {
- const router = useRouter();
- const params = useParams();
- const searchSpaceId = params.search_space_id as string;
- // Ensure connectorId is parsed safely
- const connectorIdParam = params.connector_id as string;
- const connectorId = connectorIdParam ? parseInt(connectorIdParam, 10) : NaN;
+ const router = useRouter();
+ const params = useParams();
+ const searchSpaceId = params.search_space_id as string;
+ // Ensure connectorId is parsed safely
+ const connectorIdParam = params.connector_id as string;
+ const connectorId = connectorIdParam ? parseInt(connectorIdParam, 10) : NaN;
- // Use the custom hook to manage state and logic
- const {
- connectorsLoading,
- connector,
- isSaving,
- editForm,
- patForm, // Needed for GitHub child component
- handleSaveChanges,
- // GitHub specific props for the child component
- editMode,
- setEditMode, // Pass down if needed by GitHub component
- originalPat,
- currentSelectedRepos,
- fetchedRepos,
- setFetchedRepos,
- newSelectedRepos,
- setNewSelectedRepos,
- isFetchingRepos,
- handleFetchRepositories,
- handleRepoSelectionChange,
- } = useConnectorEditPage(connectorId, searchSpaceId);
+ // Use the custom hook to manage state and logic
+ const {
+ connectorsLoading,
+ connector,
+ isSaving,
+ editForm,
+ patForm, // Needed for GitHub child component
+ handleSaveChanges,
+ // GitHub specific props for the child component
+ editMode,
+ setEditMode, // Pass down if needed by GitHub component
+ originalPat,
+ currentSelectedRepos,
+ fetchedRepos,
+ setFetchedRepos,
+ newSelectedRepos,
+ setNewSelectedRepos,
+ isFetchingRepos,
+ handleFetchRepositories,
+ handleRepoSelectionChange,
+ } = useConnectorEditPage(connectorId, searchSpaceId);
- // Redirect if connectorId is not a valid number after parsing
- useEffect(() => {
- if (isNaN(connectorId)) {
- toast.error("Invalid Connector ID.");
- router.push(`/dashboard/${searchSpaceId}/connectors`);
- }
- }, [connectorId, router, searchSpaceId]);
+ // Redirect if connectorId is not a valid number after parsing
+ useEffect(() => {
+ if (Number.isNaN(connectorId)) {
+ toast.error("Invalid Connector ID.");
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ }
+ }, [connectorId, router, searchSpaceId]);
- // Loading State
- if (connectorsLoading || !connector) {
- // Handle NaN case before showing skeleton
- if (isNaN(connectorId)) return null;
- return
;
- }
+ // Loading State
+ if (connectorsLoading || !connector) {
+ // Handle NaN case before showing skeleton
+ if (Number.isNaN(connectorId)) return null;
+ return
;
+ }
- // Main Render using data/handlers from the hook
- return (
-
-
+ // Main Render using data/handlers from the hook
+ return (
+
+
-
-
-
-
- {getConnectorIcon(connector.connector_type)}
- Edit {getConnectorTypeDisplay(connector.connector_type)} Connector
-
-
- Modify connector name and configuration.
-
-
+
+
+
+
+ {getConnectorIcon(connector.connector_type)}
+ Edit {getConnectorTypeDisplay(connector.connector_type)} Connector
+
+ Modify connector name and configuration.
+
-
-
-
-
- );
+ {/* == Discord == */}
+ {connector.connector_type === "DISCORD_CONNECTOR" && (
+
+ )}
+
+
+
+
+
+
+
+
+
+ );
}
diff --git a/surfsense_web/app/dashboard/[search_space_id]/connectors/[connector_id]/page.tsx b/surfsense_web/app/dashboard/[search_space_id]/connectors/[connector_id]/page.tsx
index 9ed3f94b9..e420b9edf 100644
--- a/surfsense_web/app/dashboard/[search_space_id]/connectors/[connector_id]/page.tsx
+++ b/surfsense_web/app/dashboard/[search_space_id]/connectors/[connector_id]/page.tsx
@@ -1,311 +1,286 @@
"use client";
-import { useState, useEffect } from "react";
-import { useRouter, useParams } from "next/navigation";
-import { motion } from "framer-motion";
import { zodResolver } from "@hookform/resolvers/zod";
-import { useForm } from "react-hook-form";
-import * as z from "zod";
-import { toast } from "sonner";
+import { motion } from "framer-motion";
import { ArrowLeft, Check, Info, Loader2 } from "lucide-react";
-
+import { useParams, useRouter } from "next/navigation";
+import { useEffect, useState } from "react";
+import { useForm } from "react-hook-form";
+import { toast } from "sonner";
+import * as z from "zod";
+import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
+import { Button } from "@/components/ui/button";
+import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card";
import {
- useSearchSourceConnectors,
- SearchSourceConnector,
-} from "@/hooks/useSearchSourceConnectors";
-import {
- Form,
- FormControl,
- FormDescription,
- FormField,
- FormItem,
- FormLabel,
- FormMessage,
+ Form,
+ FormControl,
+ FormDescription,
+ FormField,
+ FormItem,
+ FormLabel,
+ FormMessage,
} from "@/components/ui/form";
import { Input } from "@/components/ui/input";
-import { Button } from "@/components/ui/button";
import {
- Card,
- CardContent,
- CardDescription,
- CardHeader,
- CardTitle,
-} from "@/components/ui/card";
-import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
+ type SearchSourceConnector,
+ useSearchSourceConnectors,
+} from "@/hooks/useSearchSourceConnectors";
// Define the form schema with Zod
const apiConnectorFormSchema = z.object({
- name: z.string().min(3, {
- message: "Connector name must be at least 3 characters.",
- }),
- api_key: z.string().min(10, {
- message: "API key is required and must be valid.",
- }),
+ name: z.string().min(3, {
+ message: "Connector name must be at least 3 characters.",
+ }),
+ api_key: z.string().min(10, {
+ message: "API key is required and must be valid.",
+ }),
});
// Helper function to get connector type display name
const getConnectorTypeDisplay = (type: string): string => {
- const typeMap: Record
= {
- SERPER_API: "Serper API",
- TAVILY_API: "Tavily API",
- SLACK_CONNECTOR: "Slack Connector",
- NOTION_CONNECTOR: "Notion Connector",
- GITHUB_CONNECTOR: "GitHub Connector",
- LINEAR_CONNECTOR: "Linear Connector",
- JIRA_CONNECTOR: "Jira Connector",
- DISCORD_CONNECTOR: "Discord Connector",
- LINKUP_API: "Linkup",
- // Add other connector types here as needed
- };
- return typeMap[type] || type;
+ const typeMap: Record = {
+ SERPER_API: "Serper API",
+ TAVILY_API: "Tavily API",
+ SLACK_CONNECTOR: "Slack Connector",
+ NOTION_CONNECTOR: "Notion Connector",
+ GITHUB_CONNECTOR: "GitHub Connector",
+ LINEAR_CONNECTOR: "Linear Connector",
+ JIRA_CONNECTOR: "Jira Connector",
+ DISCORD_CONNECTOR: "Discord Connector",
+ LINKUP_API: "Linkup",
+ // Add other connector types here as needed
+ };
+ return typeMap[type] || type;
};
// Define the type for the form values
type ApiConnectorFormValues = z.infer;
+// Get API key field name based on connector type
+const getApiKeyFieldName = (connectorType: string): string => {
+ const fieldMap: Record = {
+ SERPER_API: "SERPER_API_KEY",
+ TAVILY_API: "TAVILY_API_KEY",
+ SLACK_CONNECTOR: "SLACK_BOT_TOKEN",
+ NOTION_CONNECTOR: "NOTION_INTEGRATION_TOKEN",
+ GITHUB_CONNECTOR: "GITHUB_PAT",
+ DISCORD_CONNECTOR: "DISCORD_BOT_TOKEN",
+ LINKUP_API: "LINKUP_API_KEY",
+ };
+ return fieldMap[connectorType] || "";
+};
+
export default function EditConnectorPage() {
- const router = useRouter();
- const params = useParams();
- const searchSpaceId = params.search_space_id as string;
- const connectorId = parseInt(params.connector_id as string, 10);
+ const router = useRouter();
+ const params = useParams();
+ const searchSpaceId = params.search_space_id as string;
+ const connectorId = parseInt(params.connector_id as string, 10);
- const { connectors, updateConnector } = useSearchSourceConnectors();
- const [connector, setConnector] = useState(
- null,
- );
- const [isLoading, setIsLoading] = useState(true);
- const [isSubmitting, setIsSubmitting] = useState(false);
- // console.log("connector", connector);
- // Initialize the form
- const form = useForm({
- resolver: zodResolver(apiConnectorFormSchema),
- defaultValues: {
- name: "",
- api_key: "",
- },
- });
+ const { connectors, updateConnector } = useSearchSourceConnectors();
+ const [connector, setConnector] = useState(null);
+ const [isLoading, setIsLoading] = useState(true);
+ const [isSubmitting, setIsSubmitting] = useState(false);
+ // console.log("connector", connector);
+ // Initialize the form
+ const form = useForm({
+ resolver: zodResolver(apiConnectorFormSchema),
+ defaultValues: {
+ name: "",
+ api_key: "",
+ },
+ });
- // Get API key field name based on connector type
- const getApiKeyFieldName = (connectorType: string): string => {
- const fieldMap: Record = {
- SERPER_API: "SERPER_API_KEY",
- TAVILY_API: "TAVILY_API_KEY",
- SLACK_CONNECTOR: "SLACK_BOT_TOKEN",
- NOTION_CONNECTOR: "NOTION_INTEGRATION_TOKEN",
- GITHUB_CONNECTOR: "GITHUB_PAT",
- DISCORD_CONNECTOR: "DISCORD_BOT_TOKEN",
- LINKUP_API: "LINKUP_API_KEY",
- };
- return fieldMap[connectorType] || "";
- };
+ // Find connector in the list
+ useEffect(() => {
+ const currentConnector = connectors.find((c) => c.id === connectorId);
- // Find connector in the list
- useEffect(() => {
- const currentConnector = connectors.find((c) => c.id === connectorId);
+ if (currentConnector) {
+ setConnector(currentConnector);
- if (currentConnector) {
- setConnector(currentConnector);
+ // Check if connector type is supported
+ const apiKeyField = getApiKeyFieldName(currentConnector.connector_type);
+ if (apiKeyField) {
+ form.reset({
+ name: currentConnector.name,
+ api_key: currentConnector.config[apiKeyField] || "",
+ });
+ } else {
+ // Redirect if not a supported connector type
+ toast.error("This connector type is not supported for editing");
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ }
- // Check if connector type is supported
- const apiKeyField = getApiKeyFieldName(currentConnector.connector_type);
- if (apiKeyField) {
- form.reset({
- name: currentConnector.name,
- api_key: currentConnector.config[apiKeyField] || "",
- });
- } else {
- // Redirect if not a supported connector type
- toast.error("This connector type is not supported for editing");
- router.push(`/dashboard/${searchSpaceId}/connectors`);
- }
+ setIsLoading(false);
+ } else if (!isLoading && connectors.length > 0) {
+ // If connectors are loaded but this one isn't found
+ toast.error("Connector not found");
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ }
+ }, [connectors, connectorId, form, router, searchSpaceId, isLoading]);
- setIsLoading(false);
- } else if (!isLoading && connectors.length > 0) {
- // If connectors are loaded but this one isn't found
- toast.error("Connector not found");
- router.push(`/dashboard/${searchSpaceId}/connectors`);
- }
- }, [connectors, connectorId, form, router, searchSpaceId, isLoading]);
+ // Handle form submission
+ const onSubmit = async (values: ApiConnectorFormValues) => {
+ if (!connector) return;
- // Handle form submission
- const onSubmit = async (values: ApiConnectorFormValues) => {
- if (!connector) return;
+ setIsSubmitting(true);
+ try {
+ const apiKeyField = getApiKeyFieldName(connector.connector_type);
- setIsSubmitting(true);
- try {
- const apiKeyField = getApiKeyFieldName(connector.connector_type);
+ // Only update the API key if a new one was provided
+ const updatedConfig = { ...connector.config };
+ if (values.api_key) {
+ updatedConfig[apiKeyField] = values.api_key;
+ }
- // Only update the API key if a new one was provided
- const updatedConfig = { ...connector.config };
- if (values.api_key) {
- updatedConfig[apiKeyField] = values.api_key;
- }
+ await updateConnector(connectorId, {
+ name: values.name,
+ connector_type: connector.connector_type,
+ config: updatedConfig,
+ is_indexable: connector.is_indexable,
+ last_indexed_at: connector.last_indexed_at,
+ });
- await updateConnector(connectorId, {
- name: values.name,
- connector_type: connector.connector_type,
- config: updatedConfig,
- is_indexable: connector.is_indexable,
- last_indexed_at: connector.last_indexed_at,
- });
+ toast.success("Connector updated successfully!");
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ } catch (error) {
+ console.error("Error updating connector:", error);
+ toast.error(error instanceof Error ? error.message : "Failed to update connector");
+ } finally {
+ setIsSubmitting(false);
+ }
+ };
- toast.success("Connector updated successfully!");
- router.push(`/dashboard/${searchSpaceId}/connectors`);
- } catch (error) {
- console.error("Error updating connector:", error);
- toast.error(
- error instanceof Error ? error.message : "Failed to update connector",
- );
- } finally {
- setIsSubmitting(false);
- }
- };
+ if (isLoading) {
+ return (
+
+ );
+ }
- if (isLoading) {
- return (
-
- );
- }
+ return (
+
+
- return (
-
-
+
+
+
+
+ Edit {connector ? getConnectorTypeDisplay(connector.connector_type) : ""} Connector
+
+ Update your connector settings.
+
+
+
+
+ API Key Security
+
+ Your API key is stored securely. For security reasons, we don't display your
+ existing API key. If you don't update the API key field, your existing key will be
+ preserved.
+
+
-
-
-
-
- Edit{" "}
- {connector
- ? getConnectorTypeDisplay(connector.connector_type)
- : ""}{" "}
- Connector
-
- Update your connector settings.
-
-
-
-
- API Key Security
-
- Your API key is stored securely. For security reasons, we don't
- display your existing API key. If you don't update the API key
- field, your existing key will be preserved.
-
-
+
-
-
-
-
- );
+
+
+
+
+
+
+
+
+
-
+ return (
+
+
-
-
-
- Connect
- Documentation
-
+
+
+
+ Connect
+ Documentation
+
-
-
-
- Connect to Confluence
-
- Connect your Confluence instance to index pages and comments from your spaces.
-
-
-
-
-
-
- You'll need to create an API token from your{" "}
-
- Atlassian Account Settings
-
-
-
+
+
+
+ Connect to Confluence
+
+ Connect your Confluence instance to index pages and comments from your spaces.
+
+
+
+
+
+
+ You'll need to create an API token from your{" "}
+
+ Atlassian Account Settings
+
+
+
-
-
-
-
+
+
+
+
+
+
+
+
-
-
-
- Confluence Integration Guide
-
- Learn how to set up and use the Confluence connector.
-
-
-
-
-
What gets indexed?
-
- - All pages from accessible spaces
- - Page content and metadata
- - Comments on pages (both footer and inline comments)
- - Page titles and descriptions
-
-
+
What gets indexed?
+
+ - All pages from accessible spaces
+ - Page content and metadata
+ - Comments on pages (both footer and inline comments)
+ - Page titles and descriptions
+
+
-
Setup Instructions
-
- - Go to your Atlassian Account Settings
- - Navigate to Security → API tokens
- - Create a new API token with appropriate permissions
- - Copy the token and paste it in the form above
- - Ensure your account has read access to the spaces you want to index
-
-
+
Setup Instructions
+
+ - Go to your Atlassian Account Settings
+ - Navigate to Security → API tokens
+ - Create a new API token with appropriate permissions
+ - Copy the token and paste it in the form above
+ - Ensure your account has read access to the spaces you want to index
+
+
-
Permissions Required
-
- - Read access to Confluence spaces
- - View pages and comments
- - Access to space metadata
-
-
+
Permissions Required
+
+ - Read access to Confluence spaces
+ - View pages and comments
+ - Access to space metadata
+
+
- );
+
+
+
+ The connector will only index content that your account has permission to view.
+ Make sure your API token has the necessary permissions for the spaces you want
+ to index.
+
+
+
+
+
+
+
+
-
+ return (
+
+
-
-
-
- Connect
- Documentation
-
-
-
-
-
- Connect Discord Server
-
- Integrate with Discord to search and retrieve information from your servers and channels. This connector can index your Discord messages for search.
-
-
-
-
-
- Bot Token Required
-
- You'll need a Discord Bot Token to use this connector. You can create a Discord bot and get the token from the{" "}
-
- Discord Developer Portal
- .
-
-
+
+
+
+ Connect
+ Documentation
+
-
-
-
- What you get with Discord integration:
-
- - Search through your Discord servers and channels
- - Access historical messages and shared files
- - Connect your team's knowledge directly to your search space
- - Keep your search results up-to-date with latest communications
- - Index your Discord messages for enhanced search capabilities
-
-
-
-
-
-
-
-
- Discord Connector Documentation
-
- Learn how to set up and use the Discord connector to index your server data.
-
-
-
-
-
How it works
-
- The Discord connector indexes all accessible channels for a given bot in your servers.
-
-
- - Upcoming: Support for private channels by granting the bot access.
-
-
- - Go to https://discord.com/developers/applications.
- - Create a new application and add a bot to it.
- - Copy the Bot Token from the Bot section.
- - Invite the bot to your server with the following OAuth2 scopes and permissions:
-
- - Scopes:
bot
- - Bot Permissions:
Read Messages/View Channels, Read Message History, Send Messages
-
-
- - Paste the Bot Token above to connect.
-
-
-
-
-
- Indexing
-
-
- - Navigate to the Connector Dashboard and select the Discord Connector.
- - Place the Bot Token under Step 1 Provide Credentials.
- - Click Connect to establish the connection.
-
+ (
+
+ Discord Bot Token
+
+
+
+
+ Your Discord Bot Token will be encrypted and stored securely. You can
+ find it in the Bot section of your application in the Discord Developer
+ Portal.
+
+
+
+ )}
+ />
-
-
- Important: Bot Channel Access
-
- After connecting, ensure the bot has access to all channels you want to index. You may need to adjust channel permissions in Discord.
-
-
+
+
+
+
+
+
+
+ What you get with Discord integration:
+
+ - Search through your Discord servers and channels
+ - Access historical messages and shared files
+ - Connect your team's knowledge directly to your search space
+ - Keep your search results up-to-date with latest communications
+ - Index your Discord messages for enhanced search capabilities
+
+
+
+
-
-
- First Indexing
-
- The first indexing pulls all accessible channels and may take longer than future updates. Only channels where the bot has access will be indexed.
-
-
-
-
-
Troubleshooting:
-
- -
- Missing messages: If you don't see messages from a channel, check the bot's permissions for that channel.
-
- -
- Bot not responding: Make sure the bot is online and the token is correct.
-
- -
- Private channels: The bot must be explicitly granted access to private channels.
-
-
-
-
- );
+
+
+
+
+ Discord Connector Documentation
+
+
+ Learn how to set up and use the Discord connector to index your server data.
+
+
+
+
+
How it works
+
+ The Discord connector indexes all accessible channels for a given bot in your
+ servers.
+
+
+ - Upcoming: Support for private channels by granting the bot access.
+
+
+ -
+ Go to{" "}
+
+ https://discord.com/developers/applications
+
+ .
+
+ - Create a new application and add a bot to it.
+ - Copy the Bot Token from the Bot section.
+ -
+ Invite the bot to your server with the following OAuth2 scopes and
+ permissions:
+
+ -
+ Scopes:
bot
+
+ -
+ Bot Permissions:
Read Messages/View Channels,{" "}
+ Read Message History, Send Messages
+
+
+
+ - Paste the Bot Token above to connect.
+
+
+
+
+
+ Indexing
+
+
+ -
+ Navigate to the Connector Dashboard and select the{" "}
+ Discord Connector.
+
+ -
+ Place the Bot Token under{" "}
+ Step 1 Provide Credentials.
+
+ -
+ Click Connect to establish the connection.
+
+
+
+
+
+ Important: Bot Channel Access
+
+ After connecting, ensure the bot has access to all channels you want to
+ index. You may need to adjust channel permissions in Discord.
+
+
+
+
+
+ First Indexing
+
+ The first indexing pulls all accessible channels and may take longer than
+ future updates. Only channels where the bot has access will be indexed.
+
+
+
+
+
Troubleshooting:
+
+ -
+ Missing messages: If you don't see messages from a
+ channel, check the bot's permissions for that channel.
+
+ -
+ Bot not responding: Make sure the bot is online and the
+ token is correct.
+
+ -
+ Private channels: The bot must be explicitly granted
+ access to private channels.
+
+
+
+
+
+
-
+ return (
+
+
-
-
-
- Connect GitHub
- Setup Guide
-
+
+
+
+ Connect GitHub
+ Setup Guide
+
-
-
-
-
- {step === 'enter_pat' ? : }
- {step === 'enter_pat' ? "Connect GitHub Account" : "Select Repositories to Index"}
-
-
- {step === 'enter_pat'
- ? "Provide a name and GitHub Personal Access Token (PAT) to fetch accessible repositories."
- : `Select which repositories you want SurfSense to index for search. Found ${repositories.length} repositories accessible via your PAT.`
- }
-
-
+
+
+
+
+ {step === "enter_pat" ? (
+
+ ) : (
+
+ )}
+ {step === "enter_pat" ? "Connect GitHub Account" : "Select Repositories to Index"}
+
+
+ {step === "enter_pat"
+ ? "Provide a name and GitHub Personal Access Token (PAT) to fetch accessible repositories."
+ : `Select which repositories you want SurfSense to index for search. Found ${repositories.length} repositories accessible via your PAT.`}
+
+
-
-
- What you get with GitHub integration:
-
- - Search through code and documentation in your selected repositories
- - Access READMEs, Markdown files, and common code files
- - Connect your project knowledge directly to your search space
- - Index your selected repositories for enhanced search capabilities
-
-
-
-
+
+ What you get with GitHub integration:
+
+ - Search through code and documentation in your selected repositories
+ - Access READMEs, Markdown files, and common code files
+ - Connect your project knowledge directly to your search space
+ - Index your selected repositories for enhanced search capabilities
+
+
+
+
-
-
-
- GitHub Connector Setup Guide
-
- Learn how to generate a Personal Access Token (PAT) and connect your GitHub account.
-
-
-
-
-
How it works
-
- The GitHub connector uses a Personal Access Token (PAT) to authenticate with the GitHub API. First, it fetches a list of repositories accessible to the token. You then select which repositories you want to index. The connector indexes relevant files (code, markdown, text) from only the selected repositories.
-
-
- - The connector indexes files based on common code and documentation extensions.
- - Large files (over 1MB) are skipped during indexing.
- - Only selected repositories are indexed.
- - Indexing runs periodically (check connector settings for frequency) to keep content up-to-date.
-
-
+
How it works
+
+ The GitHub connector uses a Personal Access Token (PAT) to authenticate with the
+ GitHub API. First, it fetches a list of repositories accessible to the token.
+ You then select which repositories you want to index. The connector indexes
+ relevant files (code, markdown, text) from only the selected repositories.
+
+
+ -
+ The connector indexes files based on common code and documentation extensions.
+
+ - Large files (over 1MB) are skipped during indexing.
+ - Only selected repositories are indexed.
+ -
+ Indexing runs periodically (check connector settings for frequency) to keep
+ content up-to-date.
+
+
+
-
-
Generating a Token:
-
- - Go to your GitHub Developer settings.
- - Click on Personal access tokens, then choose Tokens (classic) or Fine-grained tokens (recommended if available and suitable).
- - Click Generate new token (and choose the appropriate type).
- - Give your token a descriptive name (e.g., "SurfSense Connector").
- - Set an expiration date for the token (recommended for security).
- - Under Select scopes (for classic tokens) or Repository access (for fine-grained), grant the necessary permissions. At minimum, the `repo` scope (or equivalent read access to repositories for fine-grained tokens) is required to read repository content.
- - Click Generate token.
- - Important: Copy your new PAT immediately. You won't be able to see it again after leaving the page.
-
-
-
+
+
Generating a Token:
+
+ -
+ Go to your GitHub{" "}
+
+ Developer settings
+
+ .
+
+ -
+ Click on Personal access tokens, then choose{" "}
+ Tokens (classic) or{" "}
+ Fine-grained tokens (recommended if available and
+ suitable).
+
+ -
+ Click Generate new token (and choose the appropriate
+ type).
+
+ -
+ Give your token a descriptive name (e.g., "SurfSense Connector").
+
+ -
+ Set an expiration date for the token (recommended for security).
+
+ -
+ Under Select scopes (for classic tokens) or{" "}
+ Repository access (for fine-grained), grant the
+ necessary permissions. At minimum, the `repo` scope
+ (or equivalent read access to repositories for fine-grained tokens) is
+ required to read repository content.
+
+ -
+ Click Generate token.
+
+ -
+ Important: Copy your new PAT immediately. You won't
+ be able to see it again after leaving the page.
+
+
+
+
- - Navigate to the "Connect GitHub" tab.
- - Enter a name for your connector.
- - Paste the copied GitHub PAT into the "GitHub Personal Access Token (PAT)" field.
- - Click Fetch Repositories.
- - If the PAT is valid, you'll see a list of your accessible repositories.
- - Select the repositories you want SurfSense to index using the checkboxes.
- - Click the Create Connector button.
- - If the connection is successful, you will be redirected and can start indexing from the Connectors page.
-
-
-
-
-
-
-
-
-
-
- );
-}
+
+
+ Step 2: Connect in SurfSense
+
+
+
+ - Navigate to the "Connect GitHub" tab.
+ - Enter a name for your connector.
+ -
+ Paste the copied GitHub PAT into the "GitHub Personal Access Token (PAT)"
+ field.
+
+ -
+ Click Fetch Repositories.
+
+ -
+ If the PAT is valid, you'll see a list of your accessible repositories.
+
+ -
+ Select the repositories you want SurfSense to index using the checkboxes.
+
+ -
+ Click the Create Connector button.
+
+ -
+ If the connection is successful, you will be redirected and can start
+ indexing from the Connectors page.
+
+
+
+
+
+
+
+
+
+
+
-
+ return (
+
+
-
-
-
- Connect
- Documentation
-
+
+
+
+ Connect
+ Documentation
+
-
-
-
-
- Connect Jira Instance
-
-
- Integrate with Jira to search and retrieve information from
- your issues, tickets, and comments. This connector can index
- your Jira content for search.
-
-
-
-
-
- Jira Personal Access Token Required
-
- You'll need a Jira Personal Access Token to use this
- connector. You can create one from{" "}
-
- Atlassian Account Settings
-
-
-
+
+
+
+ Connect Jira Instance
+
+ Integrate with Jira to search and retrieve information from your issues, tickets,
+ and comments. This connector can index your Jira content for search.
+
+
+
+
+
+ Jira Personal Access Token Required
+
+ You'll need a Jira Personal Access Token to use this connector. You can create
+ one from{" "}
+
+ Atlassian Account Settings
+
+
+
-
-
-
-
- What you get with Jira integration:
-
-
- - Search through all your Jira issues and tickets
- -
- Access issue descriptions, comments, and full discussion
- threads
-
- -
- Connect your team's project management directly to your
- search space
-
- -
- Keep your search results up-to-date with latest Jira content
-
- -
- Index your Jira issues for enhanced search capabilities
-
- -
- Search by issue keys, status, priority, and assignee
- information
-
-
-
-
-
+
+
+
+
+
+
+
+ What you get with Jira integration:
+
+ - Search through all your Jira issues and tickets
+ - Access issue descriptions, comments, and full discussion threads
+ - Connect your team's project management directly to your search space
+ - Keep your search results up-to-date with latest Jira content
+ - Index your Jira issues for enhanced search capabilities
+ - Search by issue keys, status, priority, and assignee information
+
+
+
+
-
-
-
-
- Jira Connector Documentation
-
-
- Learn how to set up and use the Jira connector to index your
- project management data.
-
-
-
-
-
How it works
-
- The Jira connector uses the Jira REST API with Basic Authentication
- to fetch all issues and comments that your account has
- access to within your Jira instance.
-
-
- -
- For follow up indexing runs, the connector retrieves
- issues and comments that have been updated since the last
- indexing attempt.
-
- -
- Indexing is configured to run periodically, so updates
- should appear in your search results within minutes.
-
-
-
+
How it works
+
+ The Jira connector uses the Jira REST API with Basic Authentication to fetch all
+ issues and comments that your account has access to within your Jira instance.
+
+
+ -
+ For follow up indexing runs, the connector retrieves issues and comments that
+ have been updated since the last indexing attempt.
+
+ -
+ Indexing is configured to run periodically, so updates should appear in your
+ search results within minutes.
+
+
+
-
-
- Step 1: Create an API Token
-
-
- - Log in to your Atlassian account
- -
- Navigate to{" "}
-
- https://id.atlassian.com/manage-profile/security/api-tokens
-
-
- -
- Click Create API token
-
- -
- Enter a label for your token (like "SurfSense
- Connector")
-
- -
- Click Create
-
- -
- Copy the generated token as it will only be shown
- once
-
-
-
+
+
+
Step 1: Create an API Token
+
+ - Log in to your Atlassian account
+ -
+ Navigate to{" "}
+
+ https://id.atlassian.com/manage-profile/security/api-tokens
+
+
+ -
+ Click Create API token
+
+ - Enter a label for your token (like "SurfSense Connector")
+ -
+ Click Create
+
+ - Copy the generated token as it will only be shown once
+
+
-
-
- Step 2: Grant necessary access
-
-
- The API Token will have access to all projects and
- issues that your user account can see. Make sure your
- account has appropriate permissions for the projects
- you want to index.
-
-
-
- Data Privacy
-
- Only issues, comments, and basic metadata will be
- indexed. Jira attachments and linked files are not
- indexed by this connector.
-
-
-
-
-
-
+
+
Step 2: Grant necessary access
+
+ The API Token will have access to all projects and issues that your user
+ account can see. Make sure your account has appropriate permissions for
+ the projects you want to index.
+
+
+
+ Data Privacy
+
+ Only issues, comments, and basic metadata will be indexed. Jira
+ attachments and linked files are not indexed by this connector.
+
+
+
+
- -
- Navigate to the Connector Dashboard and select the{" "}
- Jira Connector.
-
- -
- Enter your Jira Instance URL (e.g.,
- https://yourcompany.atlassian.net)
-
- -
- Place your Personal Access Token in
- the form field.
-
- -
- Click Connect to establish the
- connection.
-
- -
- Once connected, your Jira issues will be indexed
- automatically.
-
-
+
+ Indexing
+
+
+ -
+ Navigate to the Connector Dashboard and select the Jira{" "}
+ Connector.
+
+ -
+ Enter your Jira Instance URL (e.g.,
+ https://yourcompany.atlassian.net)
+
+ -
+ Place your Personal Access Token in the form field.
+
+ -
+ Click Connect to establish the connection.
+
+ - Once connected, your Jira issues will be indexed automatically.
+
-
-
- What Gets Indexed
-
-
- The Jira connector indexes the following data:
-
-
- - Issue keys and summaries (e.g., PROJ-123)
- - Issue descriptions
- - Issue comments and discussion threads
- -
- Issue status, priority, and type information
-
- - Assignee and reporter information
- - Project information
-
-
-
-
-
-
-
-
-
-
-
-
- );
+
+
+ What Gets Indexed
+
+ The Jira connector indexes the following data:
+
+ - Issue keys and summaries (e.g., PROJ-123)
+ - Issue descriptions
+ - Issue comments and discussion threads
+ - Issue status, priority, and type information
+ - Assignee and reporter information
+ - Project information
+
+
+
+
+
+
+
+
+
+
+
+
-
+ // Navigate back to connectors page
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ } catch (error) {
+ console.error("Error creating connector:", error);
+ toast.error(error instanceof Error ? error.message : "Failed to create connector");
+ } finally {
+ setIsSubmitting(false);
+ }
+ };
-
-
-
- Connect
- Documentation
-
-
-
-
-
- Connect Linear Workspace
-
- Integrate with Linear to search and retrieve information from your issues and comments. This connector can index your Linear content for search.
-
-
-
-
-
- Linear API Key Required
-
- You'll need a Linear API Key to use this connector. You can create a Linear API key from{" "}
-
- Linear API Settings
-
-
-
+ return (
+
+
-
-
-
-
- What you get with Linear integration:
-
- - Search through all your Linear issues and comments
- - Access issue titles, descriptions, and full discussion threads
- - Connect your team's project management directly to your search space
- - Keep your search results up-to-date with latest Linear content
- - Index your Linear issues for enhanced search capabilities
-
-
-
-
-
-
-
-
- Linear Connector Documentation
-
- Learn how to set up and use the Linear connector to index your project management data.
-
-
-
-
-
How it works
-
- The Linear connector uses the Linear GraphQL API to fetch all issues and comments that the API key has access to within a workspace.
-
-
- - For follow up indexing runs, the connector retrieves issues and comments that have been updated since the last indexing attempt.
- - Indexing is configured to run periodically, so updates should appear in your search results within minutes.
-
-
-
-
Step 1: Create an API key
-
- - Log in to your Linear account
- - Navigate to https://linear.app/settings/api in your browser.
- - Alternatively, click on your profile picture → Settings → API
- - Click the + New API key button.
- - Enter a description for your key (like "Search Connector").
- - Select "Read-only" as the permission.
- - Click Create to generate the API key.
- - Copy the generated API key that starts with 'lin_api_' as it will only be shown once.
-
-
+
- - Navigate to the Connector Dashboard and select the Linear Connector.
- - Place the API Key in the form field.
- - Click Connect to establish the connection.
- - Once connected, your Linear issues will be indexed automatically.
-
-
-
-
- What Gets Indexed
-
- The Linear connector indexes the following data:
-
- - Issue titles and identifiers (e.g., PROJ-123)
- - Issue descriptions
- - Issue comments
- - Issue status and metadata
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+ What you get with Linear integration:
+
+ - Search through all your Linear issues and comments
+ - Access issue titles, descriptions, and full discussion threads
+ - Connect your team's project management directly to your search space
+ - Keep your search results up-to-date with latest Linear content
+ - Index your Linear issues for enhanced search capabilities
+
+
+
+
+
+
+
+
+ Linear Connector Documentation
+
+ Learn how to set up and use the Linear connector to index your project management
+ data.
+
+
+
+
+
How it works
+
+ The Linear connector uses the Linear GraphQL API to fetch all issues and
+ comments that the API key has access to within a workspace.
+
+
+ -
+ For follow up indexing runs, the connector retrieves issues and comments that
+ have been updated since the last indexing attempt.
+
+ -
+ Indexing is configured to run periodically, so updates should appear in your
+ search results within minutes.
+
+
+
+
+
Step 1: Create an API key
+
+ - Log in to your Linear account
+ -
+ Navigate to{" "}
+
+ https://linear.app/settings/api
+ {" "}
+ in your browser.
+
+ - Alternatively, click on your profile picture → Settings → API
+ -
+ Click the + New API key button.
+
+ - Enter a description for your key (like "Search Connector").
+ - Select "Read-only" as the permission.
+ -
+ Click Create to generate the API key.
+
+ -
+ Copy the generated API key that starts with 'lin_api_' as it will only
+ be shown once.
+
+
+
+
+
+
Step 2: Grant necessary access
+
+ The API key will have access to all issues and comments that your user
+ account can see. If you're creating the key as an admin, it will have
+ access to all issues in the workspace.
+
+
+
+ Data Privacy
+
+ Only issues and comments will be indexed. Linear attachments and
+ linked files are not indexed by this connector.
+
+
+
+
+ -
+ Navigate to the Connector Dashboard and select the Linear{" "}
+ Connector.
+
+ -
+ Place the API Key in the form field.
+
+ -
+ Click Connect to establish the connection.
+
+ - Once connected, your Linear issues will be indexed automatically.
+
+
+
+
+ What Gets Indexed
+
+ The Linear connector indexes the following data:
+
+ - Issue titles and identifiers (e.g., PROJ-123)
+ - Issue descriptions
+ - Issue comments
+ - Issue status and metadata
+
+
+
+
+
+
+
+
+
+
+
+
-
+ // Navigate back to connectors page
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ } catch (error) {
+ console.error("Error creating connector:", error);
+ toast.error(error instanceof Error ? error.message : "Failed to create connector");
+ } finally {
+ setIsSubmitting(false);
+ }
+ };
-
-
-
- Connect Linkup API
-
- Integrate with Linkup API to enhance your search capabilities with AI-powered search results.
-
-
-
-
-
- API Key Required
-
- You'll need a Linkup API key to use this connector. You can get one by signing up at{" "}
-
- linkup.so
-
-
-
+ return (
+
+
-
-
-
- What you get with Linkup API:
-
- - AI-powered search results tailored to your queries
- - Real-time information from the web
- - Enhanced search capabilities for your projects
-
-
-
-
-
+
+
+
+
+
+
+ What you get with Linkup API:
+
+ - AI-powered search results tailored to your queries
+ - Real-time information from the web
+ - Enhanced search capabilities for your projects
+
+
+
+
+
-
+ // Navigate back to connectors page
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ } catch (error) {
+ console.error("Error creating connector:", error);
+ toast.error(error instanceof Error ? error.message : "Failed to create connector");
+ } finally {
+ setIsSubmitting(false);
+ }
+ };
-
-
-
- Connect
- Documentation
-
-
-
-
-
- Connect Notion Workspace
-
- Integrate with Notion to search and retrieve information from your workspace pages and databases. This connector can index your Notion content for search.
-
-
-
-
-
- Notion Integration Token Required
-
- You'll need a Notion Integration Token to use this connector. You can create a Notion integration and get the token from{" "}
-
- Notion Integrations Dashboard
-
-
-
+ return (
+
+
-
-
-
-
- What you get with Notion integration:
-
- - Search through your Notion pages and databases
- - Access documents, wikis, and knowledge bases
- - Connect your team's knowledge directly to your search space
- - Keep your search results up-to-date with latest Notion content
- - Index your Notion documents for enhanced search capabilities
-
-
-
-
-
-
-
-
- Notion Connector Documentation
-
- Learn how to set up and use the Notion connector to index your workspace data.
-
-
-
-
-
How it works
-
- The Notion connector uses the Notion search API to fetch all pages that the connector has access to within a workspace.
-
-
- - For follow up indexing runs, the connector only retrieves pages that have been updated since the last indexing attempt.
- - Indexing is configured to run every 10 minutes, so page updates should appear within 10 minutes.
-
-
-
-
Step 1: Create an integration
-
- - Visit https://www.notion.com/my-integrations in your browser.
- - Click the + New integration button.
- - Name the integration (something like "Search Connector" could work).
- - Select "Read content" as the only capability required.
- - Click Submit to create the integration.
- - On the next page, you'll find your Notion integration token. Make a copy of it as you'll need it to configure the connector.
-
-
+
- - Navigate to the Connector Dashboard and select the Notion Connector.
- - Place the Integration Token under Step 1 Provide Credentials.
- - Click Connect to establish the connection.
-
-
-
-
- Indexing Behavior
-
- The Notion connector currently indexes everything it has access to. If you want to limit specific content being indexed, simply unshare the database from Notion with the integration.
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+ What you get with Notion integration:
+
+ - Search through your Notion pages and databases
+ - Access documents, wikis, and knowledge bases
+ - Connect your team's knowledge directly to your search space
+ - Keep your search results up-to-date with latest Notion content
+ - Index your Notion documents for enhanced search capabilities
+
+
+
+
+
+
+
+
+ Notion Connector Documentation
+
+ Learn how to set up and use the Notion connector to index your workspace data.
+
+
+
+
+
How it works
+
+ The Notion connector uses the Notion search API to fetch all pages that the
+ connector has access to within a workspace.
+
+
+ -
+ For follow up indexing runs, the connector only retrieves pages that have been
+ updated since the last indexing attempt.
+
+ -
+ Indexing is configured to run every 10 minutes, so page
+ updates should appear within 10 minutes.
+
+
+
+
+
Step 1: Create an integration
+
+ -
+ Visit{" "}
+
+ https://www.notion.com/my-integrations
+ {" "}
+ in your browser.
+
+ -
+ Click the + New integration button.
+
+ -
+ Name the integration (something like "Search Connector" could work).
+
+ - Select "Read content" as the only capability required.
+ -
+ Click Submit to create the integration.
+
+ -
+ On the next page, you'll find your Notion integration token. Make a
+ copy of it as you'll need it to configure the connector.
+
+
+
+
+
+
+ Step 2: Share pages/databases with your integration
+
+
+ To keep your information secure, integrations don't have access to any
+ pages or databases in the workspace at first. You must share specific
+ pages with an integration in order for the connector to access those
+ pages.
+
+
+ - Go to the page/database in your workspace.
+ -
+ Click the
••• on the top right corner of the page.
+
+ -
+ Scroll to the bottom of the pop-up and click{" "}
+ Add connections.
+
+ -
+ Search for and select the new integration in the{" "}
+
Search for connections... menu.
+
+ -
+ Important:
+
+ -
+ If you've added a page, all child pages also become accessible.
+
+ -
+ If you've added a database, all rows (and their children) become
+ accessible.
+
+
+
+
+
+
+ -
+ Navigate to the Connector Dashboard and select the Notion{" "}
+ Connector.
+
+ -
+ Place the Integration Token under{" "}
+ Step 1 Provide Credentials.
+
+ -
+ Click Connect to establish the connection.
+
+
+
+
+
+ Indexing Behavior
+
+ The Notion connector currently indexes everything it has access to. If you
+ want to limit specific content being indexed, simply unshare the database
+ from Notion with the integration.
+
+
+
+
+
+
+
+
+
+
+
-
-
- Connect Your Tools
-
-
- Integrate with your favorite services to enhance your research
- capabilities.
-
-
+ return (
+
+
+
+ Connect Your Tools
+
+
+ Integrate with your favorite services to enhance your research capabilities.
+
+
-
- {connectorCategories.map((category) => (
-
- toggleCategory(category.id)}
- className="w-full"
- >
-
-
{category.title}
-
-
-
-
+
+ {connectorCategories.map((category) => (
+
+ toggleCategory(category.id)}
+ className="w-full"
+ >
+
+
{category.title}
+
+
+
+
-
-
-
- {category.connectors.map((connector) => (
-
-
-
-
-
- {connector.icon}
-
-
-
-
-
- {connector.title}
-
- {connector.status === "coming-soon" && (
-
- Coming soon
-
- )}
- {connector.status === "connected" && (
-
- Connected
-
- )}
-
-
+
+ {connector.icon}
+
+
+
+
+
{connector.title}
+ {connector.status === "coming-soon" && (
+
+ Coming soon
+
+ )}
+ {connector.status === "connected" && (
+
+ Connected
+
+ )}
+
+
- {connector.description}
-
-
+
+ {connector.description}
+
-
- {connector.status === "available" && (
-
-
-
- )}
- {connector.status === "coming-soon" && (
-
- )}
- {connector.status === "connected" && (
-
- )}
-
-
-
- ))}
-
-
-
-
-
- ))}
-
-
- );
+
+ {connector.status === "available" && (
+
+
+
+ )}
+ {connector.status === "coming-soon" && (
+
+ )}
+ {connector.status === "connected" && (
+
+ )}
+
+
+
+ ))}
+
+
+
+
+
+ ))}
+
+
-
+ // Navigate back to connectors page
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ } catch (error) {
+ console.error("Error creating connector:", error);
+ toast.error(error instanceof Error ? error.message : "Failed to create connector");
+ } finally {
+ setIsSubmitting(false);
+ }
+ };
-
-
-
- Connect Serper API
-
- Integrate with Serper API to enhance your search capabilities with Google search results.
-
-
-
-
-
- API Key Required
-
- You'll need a Serper API key to use this connector. You can get one by signing up at{" "}
-
- serper.dev
-
-
-
+ return (
+
+
-
-
-
- What you get with Serper API:
-
- - Access to Google search results directly in your research
- - Real-time information from the web
- - Enhanced search capabilities for your projects
-
-
-
-
-
+
+
+
+
+
+
+ What you get with Serper API:
+
+ - Access to Google search results directly in your research
+ - Real-time information from the web
+ - Enhanced search capabilities for your projects
+
+
+
+
+
-
+ // Navigate back to connectors page
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ } catch (error) {
+ console.error("Error creating connector:", error);
+ toast.error(error instanceof Error ? error.message : "Failed to create connector");
+ } finally {
+ setIsSubmitting(false);
+ }
+ };
-
-
-
- Connect
- Documentation
-
-
-
-
-
- Connect Slack Workspace
-
- Integrate with Slack to search and retrieve information from your workspace channels and conversations. This connector can index your Slack messages for search.
-
-
-
-
-
- Bot User OAuth Token Required
-
- You'll need a Slack Bot User OAuth Token to use this connector. You can create a Slack app and get the token from{" "}
-
- Slack API Dashboard
-
-
-
+ return (
+
+
-
-
-
-
- What you get with Slack integration:
-
- - Search through your Slack channels and conversations
- - Access historical messages and shared files
- - Connect your team's knowledge directly to your search space
- - Keep your search results up-to-date with latest communications
- - Index your Slack messages for enhanced search capabilities
-
-
-
-
-
-
-
-
- Slack Connector Documentation
-
- Learn how to set up and use the Slack connector to index your workspace data.
-
-
-
-
-
How it works
-
- The Slack connector indexes all public channels for a given workspace.
-
-
- - Upcoming: Support for private channels by tagging/adding the Slack Bot to private channels.
-
-
- - Navigate and sign in to https://api.slack.com/apps.
- -
- Create a new Slack app:
-
- - Click the Create New App button in the top right.
- - Select From an app manifest option.
- - Select the relevant workspace from the dropdown and click Next.
-
-
- -
- Select the "YAML" tab, paste the following manifest into the text box, and click Next:
-
-
-{`display_information:
+
+
+
+
+ What you get with Slack integration:
+
+ - Search through your Slack channels and conversations
+ - Access historical messages and shared files
+ - Connect your team's knowledge directly to your search space
+ - Keep your search results up-to-date with latest communications
+ - Index your Slack messages for enhanced search capabilities
+
+
+
+
+
+
+
+
+ Slack Connector Documentation
+
+ Learn how to set up and use the Slack connector to index your workspace data.
+
+
+
+
+
How it works
+
+ The Slack connector indexes all public channels for a given workspace.
+
+
+ -
+ Upcoming: Support for private channels by tagging/adding the Slack Bot to
+ private channels.
+
+
+
+ -
+ Navigate and sign in to{" "}
+
+ https://api.slack.com/apps
+
+ .
+
+ -
+ Create a new Slack app:
+
+ -
+ Click the Create New App button in the top right.
+
+ -
+ Select From an app manifest option.
+
+ -
+ Select the relevant workspace from the dropdown and click{" "}
+ Next.
+
+
+
+ -
+ Select the "YAML" tab, paste the following manifest into the text box, and
+ click Next:
+
+
+ {`display_information:
name: SlackConnector
description: ReadOnly Connector for indexing
features:
@@ -287,65 +302,94 @@ settings:
org_deploy_enabled: false
socket_mode_enabled: false
token_rotation_enabled: false`}
-
-
- - Click the Create button.
- - In the app page, navigate to the OAuth & Permissions tab under the Features header.
- - Copy the Bot User OAuth Token, this will be used to access Slack.
-
-
-
-
-
- Indexing
-
-
- - Navigate to the Connector Dashboard and select the Slack Connector.
- - Place the Bot User OAuth Token under Step 1 Provide Credentials.
- - Click Connect to establish the connection.
-
-
-
-
- Important: Invite Bot to Channels
-
- After connecting, you must invite the bot to each channel you want to index. In each Slack channel, type:
- /invite @YourBotName
- Without this step, you'll get a "not_in_channel" error when the connector tries to access channel messages.
-
-
-
-
-
- First Indexing
-
- The first indexing pulls all of the public channels and takes longer than future updates. Only channels where the bot has been invited will be fully indexed.
-
-
-
-
-
Troubleshooting:
-
- -
- not_in_channel error: If you see this error in logs, it means the bot hasn't been invited to a channel it's trying to access. Use the
/invite @YourBotName command in that channel.
-
- -
- Alternative approach: You can add the
chat:write.public scope to your Slack app to allow it to access public channels without an explicit invitation.
-
- -
- For private channels: The bot must always be invited using the
/invite command.
-
-
-
-
-
-
+ -
+ Navigate to the Connector Dashboard and select the Slack{" "}
+ Connector.
+
+ -
+ Place the Bot User OAuth Token under{" "}
+ Step 1 Provide Credentials.
+
+ -
+ Click Connect to establish the connection.
+
+
+
+
+
+ Important: Invite Bot to Channels
+
+ After connecting, you must invite the bot to each channel you want to
+ index. In each Slack channel, type:
+
+ /invite @YourBotName
+
+
+ Without this step, you'll get a "not_in_channel" error when the
+ connector tries to access channel messages.
+
+
+
+
+
+
+ First Indexing
+
+ The first indexing pulls all of the public channels and takes longer than
+ future updates. Only channels where the bot has been invited will be fully
+ indexed.
+
+
+
+
+
Troubleshooting:
+
+ -
+ not_in_channel error: If you see this error in logs, it
+ means the bot hasn't been invited to a channel it's trying to access.
+ Use the
/invite @YourBotName command in that channel.
+
+ -
+ Alternative approach: You can add the{" "}
+
chat:write.public scope to your Slack app to allow it to
+ access public channels without an explicit invitation.
+
+ -
+ For private channels: The bot must always be invited
+ using the
/invite command.
+
+
+
+
-
+ // Navigate back to connectors page
+ router.push(`/dashboard/${searchSpaceId}/connectors`);
+ } catch (error) {
+ console.error("Error creating connector:", error);
+ toast.error(error instanceof Error ? error.message : "Failed to create connector");
+ } finally {
+ setIsSubmitting(false);
+ }
+ };
-
-
-
- Connect Tavily API
-
- Integrate with Tavily API to enhance your search capabilities with AI-powered search results.
-
-
-
-
-
- API Key Required
-
- You'll need a Tavily API key to use this connector. You can get one by signing up at{" "}
-
- tavily.com
-
-
-
+ return (
+
+
-
-
-
- What you get with Tavily API:
-
- - AI-powered search results tailored to your queries
- - Real-time information from the web
- - Enhanced search capabilities for your projects
-
-
-
-
-
+
+
+
+
+
+
+ What you get with Tavily API:
+
+ - AI-powered search results tailored to your queries
+ - Real-time information from the web
+ - Enhanced search capabilities for your projects
+
+
+
+
+
-
-
-
-
- {type
- .split("_")
- .map((word) => word.charAt(0) + word.slice(1).toLowerCase())
- .join(" ")}
-
-
{title}
+
+
+
+ );
+ },
+ size: 250,
+ },
+ {
+ header: "Type",
+ accessorKey: "document_type",
+ cell: ({ row }) => {
+ const type = row.getValue("document_type") as keyof typeof documentTypeIcons;
+ const Icon = documentTypeIcons[type];
+ return (
+
+
+
+
+
+ {type
+ .split("_")
+ .map((word) => word.charAt(0) + word.slice(1).toLowerCase())
+ .join(" ")}
+
+
-
-
(
-
- ),
- a: ({ node, ...props }) => (
-
- ),
- ul: ({ node, ...props }) => (
-
- ),
- ol: ({ node, ...props }) => (
-
- ),
- code: ({ node, className, children, ...props }: any) => {
- const match = /language-(\w+)/.exec(className || "");
- const isInline = !match;
- return isInline ? (
-
- {children}
-
- ) : (
-
- {children}
-
- );
- },
- }}
- >
- {previewContent}
-
-
-
- View Full Content
-
- }
- />
-
+
+
,
+ a: ({ node, ...props }) => (
+
+ ),
+ ul: ({ node, ...props }) => ,
+ ol: ({ node, ...props }) =>
,
+ code: ({ node, className, children, ...props }: any) => {
+ const match = /language-(\w+)/.exec(className || "");
+ const isInline = !match;
+ return isInline ? (
+
+ {children}
+
+ ) : (
+
+ {children}
+
+ );
+ },
+ }}
+ >
+ {previewContent}
+
+
+
+ View Full Content
+
+ }
+ />
+
- {/* Filter by name or email */}
-
-
- table.getColumn("title")?.setFilterValue(e.target.value)
- }
- placeholder="Filter by title..."
- type="text"
- aria-label="Filter by title"
- />
-
-
-
- {Boolean(table.getColumn("title")?.getFilterValue()) && (
- {
- table.getColumn("title")?.setFilterValue("");
- if (inputRef.current) {
- inputRef.current.focus();
- }
- }}
- initial={{ opacity: 0, rotate: -90 }}
- animate={{ opacity: 1, rotate: 0 }}
- exit={{ opacity: 0, rotate: 90 }}
- whileHover={{ scale: 1.1 }}
- whileTap={{ scale: 0.9 }}
- >
-
-
- )}
-
- {/* Filter by status */}
-
-
-
-
-
-
-
-
-
-
- Filters
-
-
-
- {uniqueStatusValues.map((value, i) => (
-
-
- handleStatusChange(checked, value)
- }
- />
-
-
- ))}
-
-
-
- {/* Toggle columns visibility */}
-
-
-
-
-
-
-
-
- Toggle columns
- {table
- .getAllColumns()
- .filter((column) => column.getCanHide())
- .map((column) => {
- return (
-
- column.toggleVisibility(!!value)
- }
- onSelect={(event) => event.preventDefault()}
- >
- {column.id}
-
- );
- })}
-
-
-
-
- {/* Delete button */}
- {table.getSelectedRowModel().rows.length > 0 && (
-
-
-
-
-
-
-
-
-
-
-
- Are you absolutely sure?
-
-
- This action cannot be undone. This will permanently
- delete {table.getSelectedRowModel().rows.length}{" "}
- selected{" "}
- {table.getSelectedRowModel().rows.length === 1
- ? "row"
- : "rows"}
- .
-
-
-
- )}
- {/* Add user button */}
- {/*
-
-
-
- Loading documents...
-
-
-
-
-
-
- Error loading documents
-
-
-
-
-
-
-
- No documents found
-
-
-
-
- {table.getHeaderGroups().map((headerGroup) => (
-
- {headerGroup.headers.map((header) => {
- return (
-
- {header.isPlaceholder ? null : header.column.getCanSort() ? (
- {
- // Enhanced keyboard handling for sorting
- if (
- header.column.getCanSort() &&
- (e.key === "Enter" || e.key === " ")
- ) {
- e.preventDefault();
- header.column.getToggleSortingHandler()?.(e);
- }
- }}
- tabIndex={
- header.column.getCanSort() ? 0 : undefined
- }
- >
- {flexRender(
- header.column.columnDef.header,
- header.getContext(),
- )}
- {{
- asc: (
-
- ),
- desc: (
-
- ),
- }[header.column.getIsSorted() as string] ?? null}
-
- ) : (
- flexRender(
- header.column.columnDef.header,
- header.getContext(),
- )
- )}
-
- );
- })}
-
- ))}
-
-
-
- {table.getRowModel().rows?.length ? (
- table.getRowModel().rows.map((row, index) => (
-
- {row.getVisibleCells().map((cell) => (
-
- {flexRender(
- cell.column.columnDef.cell,
- cell.getContext(),
- )}
-
- ))}
-
- ))
- ) : (
-
-
- No documents found.
-
-
- )}
-
-
-
- )}
-
+ {/* Table */}
+
+ {loading ? (
+
+
+
+
Loading documents...
+
+
+
+
+
Error loading documents
+
+
+
+
+ {table.getHeaderGroups().map((headerGroup) => (
+
+ {headerGroup.headers.map((header) => {
+ return (
+
+ {header.isPlaceholder ? null : header.column.getCanSort() ? (
+
+ ) : (
+ flexRender(header.column.columnDef.header, header.getContext())
+ )}
+
+ );
+ })}
+
+ ))}
+
+
+
+ {table.getRowModel().rows?.length ? (
+ table.getRowModel().rows.map((row, index) => (
+
+ {row.getVisibleCells().map((cell) => (
+
+ {flexRender(cell.column.columnDef.cell, cell.getContext())}
+
+ ))}
+
+ ))
+ ) : (
+
+
+ No documents found.
+
+
+ )}
+
+
+
+ )}
+
- {/* Pagination */}
-
- {/* Results per page */}
-
-
-
-
- {/* Page number information */}
-
-
-
- {table.getState().pagination.pageIndex *
- table.getState().pagination.pageSize +
- 1}
- -
- {Math.min(
- Math.max(
- table.getState().pagination.pageIndex *
- table.getState().pagination.pageSize +
- table.getState().pagination.pageSize,
- 0,
- ),
- table.getRowCount(),
- )}
- {" "}
- of{" "}
-
- {table.getRowCount().toString()}
-
-
-
+ {/* Pagination */}
+
+ {/* Results per page */}
+
+
+
+
+ {/* Page number information */}
+
+
+
+ {table.getState().pagination.pageIndex * table.getState().pagination.pageSize + 1}-
+ {Math.min(
+ Math.max(
+ table.getState().pagination.pageIndex * table.getState().pagination.pageSize +
+ table.getState().pagination.pageSize,
+ 0
+ ),
+ table.getRowCount()
+ )}
+ {" "}
+ of {table.getRowCount().toString()}
+
+
- {/* Pagination buttons */}
-
-
-
- {/* First page button */}
-
-
-
-
-
- {/* Previous page button */}
-
-
-
-
-
- {/* Next page button */}
-
-
-
-
-
- {/* Last page button */}
-
-
-
-
-
-
-
-
-
-
-
- );
+ {/* Pagination buttons */}
+
+
+
+ {/* First page button */}
+
+
+
+
+
+ {/* Previous page button */}
+
+
+
+
+
+ {/* Next page button */}
+
+
+
+
+
+ {/* Last page button */}
+
+
+
+
+
+
+
+
+
-
-
-
-
-
- e.preventDefault()}>
- View Metadata
-
- }
- />
-
-
-
- {
- e.preventDefault();
- setIsOpen(true);
- }}
- >
- Delete
-
-
-
-
- Are you sure?
-
- This action cannot be undone. This will permanently delete the
- document.
-
-
-
- Cancel
- {
- e.preventDefault();
- handleDelete();
- }}
- disabled={isDeleting}
- >
- {isDeleting ? "Deleting..." : "Delete"}
-
-
-
-
-
-
-
+
+
+
+
+
+ e.preventDefault()}>
+ View Metadata
+
+ }
+ />
+
+
+
+ {
+ e.preventDefault();
+ setIsOpen(true);
+ }}
+ >
+ Delete
+
+
+
+
+ Are you sure?
+
+ This action cannot be undone. This will permanently delete the document.
+
+
+
+ Cancel
+ {
+ e.preventDefault();
+ handleDelete();
+ }}
+ disabled={isDeleting}
+ >
+ {isDeleting ? "Deleting..." : "Delete"}
+
+
+
+
+
+
+
- {Array.from({ length: rows }).map((_, row) =>
- Array.from({ length: columns }).map((_, col) => {
- const index = row * columns + col;
- return (
-
- );
- })
- )}
-
+ {Array.from({ length: rows }).map((_, row) =>
+ Array.from({ length: columns }).map((_, col) => {
+ const index = row * columns + col;
+ return (
+
+ );
+ })
+ )}
+
-
+ const fileItemVariants = {
+ hidden: { opacity: 0, x: -20 },
+ visible: { opacity: 1, x: 0, transition: { duration: 0.3 } },
+ exit: { opacity: 0, x: 20, transition: { duration: 0.2 } },
+ };
-
-
- {/* Grid background pattern */}
-
-
-
+ return (
+
+
+
+
+ {/* Grid background pattern */}
+
+
+
-
- {/* Dropzone area */}
-
-
+
+ {/* Dropzone area */}
+
+
-
- Upload files
-
-
- Drag or drop your files here or click to upload
-
+
+ Upload files
+
+
+ Drag or drop your files here or click to upload
+
-
- {!files.length && (
-
- {isDragActive ? (
-
- Drop it
-
-
- ) : (
-
- )}
-
- )}
+
+ {!files.length && (
+
+ {isDragActive ? (
+
+ Drop it
+
+
+ ) : (
+
+ )}
+
+ )}
- {!files.length && (
-
- )}
-
-
-
-
+ {!files.length && (
+
+ )}
+
+
+
-
Selected Files ({files.length})
-
+
-
- {files.map((file, index) => (
-
-
-
- {file.name}
-
-
-
- {formatFileSize(file.size)}
-
-
-
-
+
+ {files.map((file, index) => (
+
+
+
+ {file.name}
+
+
+
+ {formatFileSize(file.size)}
+
+
+
+
-
-
- {file.type || 'Unknown type'}
-
+
+
+
+ {file.type || "Unknown type"}
+
-
-
- modified {new Date(file.lastModified).toLocaleDateString()}
-
-
-
- ))}
-
-
+
-
-
-
Supported file types:
-
-
- {supportedExtensions.map((ext) => (
-
- {ext}
-
- ))}
-
-
-
+ {/* File type information */}
+
+
+
+
+
Supported file types:
+
+
+ {supportedExtensions.map((ext) => (
+
+ {ext}
+
+ ))}
+
+
+
+
-
-
-
-
-
-
- Add Webpages for Crawling
-
-
- Enter URLs to crawl and add to your document collection
-
-
-
-
-
-
-
-
- Add multiple URLs by pressing Enter after each one
-
-
+ setUrlTags([...urlTags, newTag]);
+ };
- {error && (
-
- {error}
-
- )}
+ return (
+
+
+
+
+
+ Add Webpages for Crawling
+
+ Enter URLs to crawl and add to your document collection
+
+
+
+
+
+
+
+ Add multiple URLs by pressing Enter after each one
+
+
-
-
Tips for URL crawling:
-
- - Enter complete URLs including http:// or https://
- - Make sure the websites allow crawling
- - Public webpages work best
- - Crawling may take some time depending on the website size
-
-
-
-
- );
-}
\ No newline at end of file
+ {error &&
{error}
}
+
+
+
Tips for URL crawling:
+
+ - Enter complete URLs including http:// or https://
+ - Make sure the websites allow crawling
+ - Public webpages work best
+ - Crawling may take some time depending on the website size
+
+
+
+
-
-
-
-
-
-
- Add YouTube Videos
-
-
- Enter YouTube video URLs to add to your document collection
-
-
-
-
-
-
-
-
-
-
-
- Add multiple YouTube URLs by pressing Enter after each one
-
-
+ // Animation variants
+ const containerVariants: Variants = {
+ hidden: { opacity: 0 },
+ visible: {
+ opacity: 1,
+ transition: {
+ staggerChildren: 0.1,
+ },
+ },
+ };
- {error && (
-
- {error}
-
- )}
+ const itemVariants: Variants = {
+ hidden: { y: 20, opacity: 0 },
+ visible: {
+ y: 0,
+ opacity: 1,
+ transition: {
+ type: "spring",
+ stiffness: 300,
+ damping: 24,
+ },
+ },
+ };
-
- Tips for adding YouTube videos:
-
- - Use standard YouTube URLs (youtube.com/watch?v= or youtu.be/)
- - Make sure videos are publicly accessible
- - Supported formats: youtube.com/watch?v=VIDEO_ID or youtu.be/VIDEO_ID
- - Processing may take some time depending on video length
-
-
+ return (
+
+
+
+
+
+
+
+ Add YouTube Videos
+
+
+ Enter YouTube video URLs to add to your document collection
+
+
+
- {videoTags.length > 0 && (
-
- Preview:
-
- {videoTags.map((tag, index) => {
- const videoId = extractVideoId(tag.text);
- return videoId ? (
-
-
-
- ) : null;
- })}
-
-
- )}
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+ Add multiple YouTube URLs by pressing Enter after each one
+
+
+
+ {error && (
+
+ {error}
+
+ )}
+
+
+ Tips for adding YouTube videos:
+
+ - Use standard YouTube URLs (youtube.com/watch?v= or youtu.be/)
+ - Make sure videos are publicly accessible
+ - Supported formats: youtube.com/watch?v=VIDEO_ID or youtu.be/VIDEO_ID
+ - Processing may take some time depending on video length
+
+
+
+ {videoTags.length > 0 && (
+
+ Preview:
+
+ {videoTags.map((tag, index) => {
+ const videoId = extractVideoId(tag.text);
+ return videoId ? (
+
+
+
+ ) : null;
+ })}
+
+
+ )}
+
+
-
-
-
- {level}
-
-
- );
- },
- size: 120,
- },
- {
- header: "Status",
- accessorKey: "status",
- cell: ({ row }) => {
- const status = row.getValue("status") as LogStatus;
- const config = logStatusConfig[status];
- const Icon = config.icon;
- return (
-
-
-
-
-
- {status.replace('_', ' ')}
-
-
- );
- },
- size: 140,
- },
- {
- header: "Source",
- accessorKey: "source",
- cell: ({ row }) => {
- const source = row.getValue("source") as string;
- return (
-
-
- {source || "System"}
-
- );
- },
- size: 150,
- },
- {
- header: "Message",
- accessorKey: "message",
- cell: ({ row }) => {
- const message = row.getValue("message") as string;
- const taskName = row.original.log_metadata?.task_name;
-
- return (
-
- {taskName && (
-
- {taskName}
-
- )}
-
- {message.length > 100 ? `${message.substring(0, 100)}...` : message}
-
-
-
{date.toLocaleDateString()}
-
{date.toLocaleTimeString()}
-
+
+
+ {level}
+
+ );
+ },
+ size: 120,
+ },
+ {
+ header: "Status",
+ accessorKey: "status",
+ cell: ({ row }) => {
+ const status = row.getValue("status") as LogStatus;
+ const config = logStatusConfig[status];
+ const Icon = config.icon;
+ return (
+
+
+
+
+
+ {status.replace("_", " ")}
+
+
+ );
+ },
+ size: 140,
+ },
+ {
+ header: "Source",
+ accessorKey: "source",
+ cell: ({ row }) => {
+ const source = row.getValue("source") as string;
+ return (
+
+
+ {source || "System"}
+
+ );
+ },
+ size: 150,
+ },
+ {
+ header: "Message",
+ accessorKey: "message",
+ cell: ({ row }) => {
+ const message = row.getValue("message") as string;
+ const taskName = row.original.log_metadata?.task_name;
+
+ return (
+
+ {taskName && (
+
+ {taskName}
+
+ )}
+
+ {message.length > 100 ? `${message.substring(0, 100)}...` : message}
+
+
+
{date.toLocaleDateString()}
+
{date.toLocaleTimeString()}
+
- 
- {noOfWebPages}
-