({
queryKey: isDocsChunk
? cacheKeys.documents.byChunk(`doc-${chunkId}`)
: cacheKeys.documents.byChunk(chunkId.toString()),
- queryFn: () =>
- isDocsChunk
- ? documentsApiService.getSurfsenseDocByChunk(chunkId)
- : documentsApiService.getDocumentByChunk({ chunk_id: chunkId }),
+ queryFn: async () => {
+ if (isDocsChunk) {
+ return documentsApiService.getSurfsenseDocByChunk(chunkId);
+ }
+ return documentsApiService.getDocumentByChunk({ chunk_id: chunkId });
+ },
enabled: !!chunkId && open,
staleTime: 5 * 60 * 1000,
});
@@ -332,7 +340,7 @@ export function SourceDetailPanel({
{documentData?.title || title || "Source Document"}
- {documentData
+ {documentData && "document_type" in documentData
? formatDocumentType(documentData.document_type)
: sourceType && formatDocumentType(sourceType)}
{documentData?.chunks && (
@@ -498,7 +506,8 @@ export function SourceDetailPanel({
{/* Document Metadata */}
- {documentData.document_metadata &&
+ {"document_metadata" in documentData &&
+ documentData.document_metadata &&
Object.keys(documentData.document_metadata).length > 0 && (
;
export type DeleteDocumentRequest = z.infer;
export type DeleteDocumentResponse = z.infer;
export type DocumentTypeEnum = z.infer;
+export type SurfsenseDocsChunk = z.infer;
+export type SurfsenseDocsDocument = z.infer;
+export type SurfsenseDocsDocumentWithChunks = z.infer;
+export type GetSurfsenseDocsByChunkRequest = z.infer;
+export type GetSurfsenseDocsByChunkResponse = z.infer;
diff --git a/surfsense_web/lib/apis/documents-api.service.ts b/surfsense_web/lib/apis/documents-api.service.ts
index 372baee4d..2e7d18e44 100644
--- a/surfsense_web/lib/apis/documents-api.service.ts
+++ b/surfsense_web/lib/apis/documents-api.service.ts
@@ -17,6 +17,7 @@ import {
getDocumentsResponse,
getDocumentTypeCountsRequest,
getDocumentTypeCountsResponse,
+ getSurfsenseDocsByChunkResponse,
type SearchDocumentsRequest,
searchDocumentsRequest,
searchDocumentsResponse,
@@ -214,10 +215,9 @@ class DocumentsApiService {
* Used for resolving [citation:doc-XXX] citations
*/
getSurfsenseDocByChunk = async (chunkId: number) => {
- // Response shape matches getDocumentByChunkResponse structure
return baseApiService.get(
`/api/v1/surfsense-docs/by-chunk/${chunkId}`,
- getDocumentByChunkResponse
+ getSurfsenseDocsByChunkResponse
);
};
From f6621f9a9a2235972f11b9f4f671459e4f650e5e Mon Sep 17 00:00:00 2001
From: CREDO23
Date: Mon, 12 Jan 2026 18:28:38 +0200
Subject: [PATCH 38/49] fix: copy docs content to Docker image for Surfsense
docs indexer
---
Dockerfile.allinone | 3 +++
1 file changed, 3 insertions(+)
diff --git a/Dockerfile.allinone b/Dockerfile.allinone
index 1c04ffb99..33ae32023 100644
--- a/Dockerfile.allinone
+++ b/Dockerfile.allinone
@@ -165,6 +165,9 @@ COPY --from=frontend-builder /app/.next/standalone ./
COPY --from=frontend-builder /app/.next/static ./.next/static
COPY --from=frontend-builder /app/public ./public
+# Copy docs content for Surfsense docs indexer (used at runtime for seeding)
+COPY surfsense_web/content/docs /app/surfsense_web/content/docs
+
# ====================
# Setup Backend
# ====================
From 96545056cdf2a88d608e983cfe5e1c63e195e6f5 Mon Sep 17 00:00:00 2001
From: CREDO23
Date: Mon, 12 Jan 2026 20:15:11 +0200
Subject: [PATCH 39/49] refactor: async docs seeding in FastAPI lifespan
---
scripts/docker/entrypoint-allinone.sh | 25 +----------
surfsense_backend/app/app.py | 3 ++
.../app/tasks/surfsense_docs_indexer.py | 45 +++++++++++++++----
.../scripts/seed_surfsense_docs.py | 41 +++++++----------
4 files changed, 58 insertions(+), 56 deletions(-)
diff --git a/scripts/docker/entrypoint-allinone.sh b/scripts/docker/entrypoint-allinone.sh
index 0888facf1..ef0ef28ed 100644
--- a/scripts/docker/entrypoint-allinone.sh
+++ b/scripts/docker/entrypoint-allinone.sh
@@ -145,36 +145,13 @@ run_migrations() {
echo "✅ Database migrations complete"
}
-# ================================================
-# Seed Surfsense documentation
-# ================================================
-seed_surfsense_docs() {
- echo "📚 Seeding Surfsense documentation..."
-
- # Start PostgreSQL temporarily for seeding
- su - postgres -c "/usr/lib/postgresql/14/bin/pg_ctl -D /data/postgres -l /tmp/postgres_seed.log start"
- sleep 5
-
- cd /app/backend
- python scripts/seed_surfsense_docs.py || echo "⚠️ Docs seeding may have already been done"
-
- # Stop PostgreSQL
- su - postgres -c "/usr/lib/postgresql/14/bin/pg_ctl -D /data/postgres stop"
-
- echo "✅ Surfsense documentation seeded"
-}
-
# Run migrations on first start or when explicitly requested
if [ ! -f /data/.migrations_run ] || [ "${FORCE_MIGRATIONS:-false}" = "true" ]; then
run_migrations
touch /data/.migrations_run
fi
-# Seed docs on first start or when explicitly requested
-if [ ! -f /data/.docs_seeded ] || [ "${FORCE_SEED_DOCS:-false}" = "true" ]; then
- seed_surfsense_docs
- touch /data/.docs_seeded
-fi
+# Note: Surfsense docs seeding is now handled by FastAPI startup (app.py lifespan)
# ================================================
# Environment Variables Info
diff --git a/surfsense_backend/app/app.py b/surfsense_backend/app/app.py
index 993961148..3ad9d89bc 100644
--- a/surfsense_backend/app/app.py
+++ b/surfsense_backend/app/app.py
@@ -13,6 +13,7 @@ from app.config import config
from app.db import User, create_db_and_tables, get_async_session
from app.routes import router as crud_router
from app.schemas import UserCreate, UserRead, UserUpdate
+from app.tasks.surfsense_docs_indexer import seed_surfsense_docs
from app.users import SECRET, auth_backend, current_active_user, fastapi_users
@@ -22,6 +23,8 @@ async def lifespan(app: FastAPI):
await create_db_and_tables()
# Setup LangGraph checkpointer tables for conversation persistence
await setup_checkpointer_tables()
+ # Seed Surfsense documentation
+ await seed_surfsense_docs()
yield
# Cleanup: close checkpointer connection on shutdown
await close_checkpointer()
diff --git a/surfsense_backend/app/tasks/surfsense_docs_indexer.py b/surfsense_backend/app/tasks/surfsense_docs_indexer.py
index 51a1c0938..f2c1e69ba 100644
--- a/surfsense_backend/app/tasks/surfsense_docs_indexer.py
+++ b/surfsense_backend/app/tasks/surfsense_docs_indexer.py
@@ -1,6 +1,6 @@
"""
Surfsense documentation indexer.
-Indexes MDX documentation files at migration time.
+Indexes MDX documentation files at startup.
"""
import hashlib
@@ -10,10 +10,11 @@ from datetime import UTC, datetime
from pathlib import Path
from sqlalchemy import select
-from sqlalchemy.orm import Session, selectinload
+from sqlalchemy.ext.asyncio import AsyncSession
+from sqlalchemy.orm import selectinload
from app.config import config
-from app.db import SurfsenseDocsChunk, SurfsenseDocsDocument
+from app.db import SurfsenseDocsChunk, SurfsenseDocsDocument, async_session_maker
logger = logging.getLogger(__name__)
@@ -89,12 +90,12 @@ def create_surfsense_docs_chunks(content: str) -> list[SurfsenseDocsChunk]:
]
-def index_surfsense_docs(session: Session) -> tuple[int, int, int, int]:
+async def index_surfsense_docs(session: AsyncSession) -> tuple[int, int, int, int]:
"""
Index all Surfsense documentation files.
Args:
- session: SQLAlchemy sync session
+ session: SQLAlchemy async session
Returns:
Tuple of (created, updated, skipped, deleted) counts
@@ -105,7 +106,7 @@ def index_surfsense_docs(session: Session) -> tuple[int, int, int, int]:
deleted = 0
# Get all existing docs from database
- existing_docs_result = session.execute(
+ existing_docs_result = await session.execute(
select(SurfsenseDocsDocument).options(selectinload(SurfsenseDocsDocument.chunks))
)
existing_docs = {doc.source: doc for doc in existing_docs_result.scalars().all()}
@@ -178,11 +179,11 @@ def index_surfsense_docs(session: Session) -> tuple[int, int, int, int]:
for source, doc in existing_docs.items():
if source not in processed_sources:
logger.info(f"Deleting removed document: {source}")
- session.delete(doc)
+ await session.delete(doc)
deleted += 1
# Commit all changes
- session.commit()
+ await session.commit()
logger.info(
f"Indexing complete: {created} created, {updated} updated, "
@@ -191,3 +192,31 @@ def index_surfsense_docs(session: Session) -> tuple[int, int, int, int]:
return created, updated, skipped, deleted
+
+async def seed_surfsense_docs() -> tuple[int, int, int, int]:
+ """
+ Seed Surfsense documentation into the database.
+
+ This function indexes all MDX files from the docs directory.
+ It handles creating, updating, and deleting docs based on content changes.
+
+ Returns:
+ Tuple of (created, updated, skipped, deleted) counts
+ Returns (0, 0, 0, 0) if an error occurs
+ """
+ logger.info("Starting Surfsense docs indexing...")
+
+ try:
+ async with async_session_maker() as session:
+ created, updated, skipped, deleted = await index_surfsense_docs(session)
+
+ logger.info(
+ f"Surfsense docs indexing complete: "
+ f"created={created}, updated={updated}, skipped={skipped}, deleted={deleted}"
+ )
+
+ return created, updated, skipped, deleted
+
+ except Exception as e:
+ logger.error(f"Failed to seed Surfsense docs: {e}", exc_info=True)
+ return 0, 0, 0, 0
diff --git a/surfsense_backend/scripts/seed_surfsense_docs.py b/surfsense_backend/scripts/seed_surfsense_docs.py
index 2e9eee649..d9536bf91 100644
--- a/surfsense_backend/scripts/seed_surfsense_docs.py
+++ b/surfsense_backend/scripts/seed_surfsense_docs.py
@@ -1,47 +1,40 @@
#!/usr/bin/env python
"""
Seed Surfsense documentation into the database.
-Run this script after migrations to index MDX documentation files.
+
+CLI wrapper for the seed_surfsense_docs function.
+Can be run manually for debugging or re-indexing.
Usage:
python scripts/seed_surfsense_docs.py
"""
+import asyncio
import sys
from pathlib import Path
# Add the parent directory to the path so we can import app modules
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
-from sqlalchemy import create_engine
-from sqlalchemy.orm import Session
-
-from app.config import config
-from app.tasks.surfsense_docs_indexer import index_surfsense_docs
+from app.tasks.surfsense_docs_indexer import seed_surfsense_docs
def main():
- """Main entry point for seeding Surfsense docs."""
- print("Starting Surfsense docs seeding...")
+ """CLI entry point for seeding Surfsense docs."""
+ print("=" * 50)
+ print(" Surfsense Documentation Seeding")
+ print("=" * 50)
- # Create sync engine from database URL
- # Convert async URL to sync if needed
- database_url = config.DATABASE_URL
- if database_url.startswith("postgresql+asyncpg://"):
- database_url = database_url.replace("postgresql+asyncpg://", "postgresql://")
+ created, updated, skipped, deleted = asyncio.run(seed_surfsense_docs())
- engine = create_engine(database_url)
-
- with Session(engine) as session:
- created, updated, skipped, deleted = index_surfsense_docs(session)
-
- print(f"\nSurfsense docs seeding complete:")
- print(f" Created: {created}")
- print(f" Updated: {updated}")
- print(f" Skipped: {skipped}")
- print(f" Deleted: {deleted}")
+ print()
+ print("Results:")
+ print(f" Created: {created}")
+ print(f" Updated: {updated}")
+ print(f" Skipped: {skipped}")
+ print(f" Deleted: {deleted}")
+ print("=" * 50)
if __name__ == "__main__":
main()
-
From 19ef32539d33a2c30f757c062576b267abd426a6 Mon Sep 17 00:00:00 2001
From: CREDO23
Date: Mon, 12 Jan 2026 20:20:48 +0200
Subject: [PATCH 40/49] cleanup: remove obsolete comments
---
Dockerfile.allinone | 1 -
scripts/docker/entrypoint-allinone.sh | 2 --
2 files changed, 3 deletions(-)
diff --git a/Dockerfile.allinone b/Dockerfile.allinone
index 33ae32023..95893c0b5 100644
--- a/Dockerfile.allinone
+++ b/Dockerfile.allinone
@@ -165,7 +165,6 @@ COPY --from=frontend-builder /app/.next/standalone ./
COPY --from=frontend-builder /app/.next/static ./.next/static
COPY --from=frontend-builder /app/public ./public
-# Copy docs content for Surfsense docs indexer (used at runtime for seeding)
COPY surfsense_web/content/docs /app/surfsense_web/content/docs
# ====================
diff --git a/scripts/docker/entrypoint-allinone.sh b/scripts/docker/entrypoint-allinone.sh
index ef0ef28ed..8248968ab 100644
--- a/scripts/docker/entrypoint-allinone.sh
+++ b/scripts/docker/entrypoint-allinone.sh
@@ -151,8 +151,6 @@ if [ ! -f /data/.migrations_run ] || [ "${FORCE_MIGRATIONS:-false}" = "true" ];
touch /data/.migrations_run
fi
-# Note: Surfsense docs seeding is now handled by FastAPI startup (app.py lifespan)
-
# ================================================
# Environment Variables Info
# ================================================
From 842004e6170410c50021ad3d3286c669b8926781 Mon Sep 17 00:00:00 2001
From: CREDO23
Date: Mon, 12 Jan 2026 20:54:00 +0200
Subject: [PATCH 41/49] docs: add tool examples to system prompt
---
.../app/agents/new_chat/system_prompt.py | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/surfsense_backend/app/agents/new_chat/system_prompt.py b/surfsense_backend/app/agents/new_chat/system_prompt.py
index f9dfdb025..169363fe9 100644
--- a/surfsense_backend/app/agents/new_chat/system_prompt.py
+++ b/surfsense_backend/app/agents/new_chat/system_prompt.py
@@ -26,6 +26,13 @@ SURFSENSE_TOOLS_INSTRUCTIONS = """
You have access to the following tools:
+0. search_surfsense_docs: Search the official SurfSense documentation.
+ - Use this tool when the user asks anything about SurfSense itself (the application they are using).
+ - Args:
+ - query: The search query about SurfSense
+ - top_k: Number of documentation chunks to retrieve (default: 10)
+ - Returns: Documentation content with chunk IDs for citations (prefixed with 'doc-', e.g., [citation:doc-123])
+
1. search_knowledge_base: Search the user's personal knowledge base for relevant information.
- Args:
- query: The search query - be specific and include key terms
@@ -152,6 +159,18 @@ You have access to the following tools:
- Airtable/Notion: Check field values, apply mapping above
+- User: "How do I install SurfSense?"
+ - Call: `search_surfsense_docs(query="installation setup")`
+
+- User: "What connectors does SurfSense support?"
+ - Call: `search_surfsense_docs(query="available connectors integrations")`
+
+- User: "How do I set up the Notion connector?"
+ - Call: `search_surfsense_docs(query="Notion connector setup configuration")`
+
+- User: "How do I use Docker to run SurfSense?"
+ - Call: `search_surfsense_docs(query="Docker installation setup")`
+
- User: "Fetch all my notes and what's in them?"
- Call: `search_knowledge_base(query="*", top_k=50, connectors_to_search=["NOTE"])`
From c0b97fcc68cae577d6273a8570ff7717d364d814 Mon Sep 17 00:00:00 2001
From: CREDO23
Date: Mon, 12 Jan 2026 21:00:06 +0200
Subject: [PATCH 42/49] fix: add doc- prefix examples to citation instructions
---
surfsense_backend/app/agents/new_chat/system_prompt.py | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/surfsense_backend/app/agents/new_chat/system_prompt.py b/surfsense_backend/app/agents/new_chat/system_prompt.py
index 169363fe9..15fc17022 100644
--- a/surfsense_backend/app/agents/new_chat/system_prompt.py
+++ b/surfsense_backend/app/agents/new_chat/system_prompt.py
@@ -327,7 +327,7 @@ The documents you receive are structured like this:
-IMPORTANT: You MUST cite using the chunk ids (e.g. 123, 124). Do NOT cite document_id.
+IMPORTANT: You MUST cite using the chunk ids (e.g. 123, 124, doc-45). Do NOT cite document_id.
@@ -338,11 +338,13 @@ IMPORTANT: You MUST cite using the chunk ids (e.g. 123, 124). Do NOT cite docume
- NEVER create your own citation format - use the exact chunk_id values from the documents in the [citation:chunk_id] format
- NEVER format citations as clickable links or as markdown links like "([citation:5](https://example.com))". Always use plain square brackets only
- NEVER make up chunk IDs if you are unsure about the chunk_id. It is better to omit the citation than to guess
+- Copy the EXACT chunk id from the XML - if it says ``, use [citation:doc-123]
CORRECT citation formats:
- [citation:5]
+- [citation:doc-123] (for Surfsense documentation chunks)
- [citation:chunk_id1], [citation:chunk_id2], [citation:chunk_id3]
INCORRECT citation formats (DO NOT use):
From abd4b1bd05dd3e25f479ec362075fe531abee530 Mon Sep 17 00:00:00 2001
From: CREDO23
Date: Mon, 12 Jan 2026 21:34:21 +0200
Subject: [PATCH 43/49] Remove unused WorkspaceAvatar.tsx
---
.../layout/ui/icon-rail/WorkspaceAvatar.tsx | 72 -------------------
1 file changed, 72 deletions(-)
delete mode 100644 surfsense_web/components/layout/ui/icon-rail/WorkspaceAvatar.tsx
diff --git a/surfsense_web/components/layout/ui/icon-rail/WorkspaceAvatar.tsx b/surfsense_web/components/layout/ui/icon-rail/WorkspaceAvatar.tsx
deleted file mode 100644
index 397076cb6..000000000
--- a/surfsense_web/components/layout/ui/icon-rail/WorkspaceAvatar.tsx
+++ /dev/null
@@ -1,72 +0,0 @@
-"use client";
-
-import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
-import { cn } from "@/lib/utils";
-
-interface SearchSpaceAvatarProps {
- name: string;
- isActive?: boolean;
- onClick?: () => void;
- size?: "sm" | "md";
-}
-
-/**
- * Generates a consistent color based on search space name
- */
-function stringToColor(str: string): string {
- let hash = 0;
- for (let i = 0; i < str.length; i++) {
- hash = str.charCodeAt(i) + ((hash << 5) - hash);
- }
- const colors = [
- "#6366f1", // indigo
- "#22c55e", // green
- "#f59e0b", // amber
- "#ef4444", // red
- "#8b5cf6", // violet
- "#06b6d4", // cyan
- "#ec4899", // pink
- "#14b8a6", // teal
- ];
- return colors[Math.abs(hash) % colors.length];
-}
-
-/**
- * Gets initials from search space name (max 2 chars)
- */
-function getInitials(name: string): string {
- const words = name.trim().split(/\s+/);
- if (words.length >= 2) {
- return (words[0][0] + words[1][0]).toUpperCase();
- }
- return name.slice(0, 2).toUpperCase();
-}
-
-export function SearchSpaceAvatar({ name, isActive, onClick, size = "md" }: SearchSpaceAvatarProps) {
- const bgColor = stringToColor(name);
- const initials = getInitials(name);
- const sizeClasses = size === "sm" ? "h-8 w-8 text-xs" : "h-10 w-10 text-sm";
-
- return (
-
-
-
-
-
- {name}
-
-
- );
-}
From 4c72b882c8ce0fadee4bfcc7ff9e363a699f687a Mon Sep 17 00:00:00 2001
From: CREDO23
Date: Mon, 12 Jan 2026 21:45:22 +0200
Subject: [PATCH 44/49] Remove outdated clickup-connect-form.tsx
---
.../components/clickup-connect-form.tsx | 385 ------------------
1 file changed, 385 deletions(-)
delete mode 100644 surfsense_web/components/assistant-ui/connector-popup/connect-forms/components/clickup-connect-form.tsx
diff --git a/surfsense_web/components/assistant-ui/connector-popup/connect-forms/components/clickup-connect-form.tsx b/surfsense_web/components/assistant-ui/connector-popup/connect-forms/components/clickup-connect-form.tsx
deleted file mode 100644
index 9f33c6ed9..000000000
--- a/surfsense_web/components/assistant-ui/connector-popup/connect-forms/components/clickup-connect-form.tsx
+++ /dev/null
@@ -1,385 +0,0 @@
-"use client";
-
-import { zodResolver } from "@hookform/resolvers/zod";
-import { Info } from "lucide-react";
-import type { FC } from "react";
-import { useRef, useState } from "react";
-import { useForm } from "react-hook-form";
-import * as z from "zod";
-import {
- Accordion,
- AccordionContent,
- AccordionItem,
- AccordionTrigger,
-} from "@/components/ui/accordion";
-import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
-import {
- Form,
- FormControl,
- FormDescription,
- FormField,
- FormItem,
- FormLabel,
- FormMessage,
-} from "@/components/ui/form";
-import { Input } from "@/components/ui/input";
-import { Label } from "@/components/ui/label";
-import {
- Select,
- SelectContent,
- SelectItem,
- SelectTrigger,
- SelectValue,
-} from "@/components/ui/select";
-import { Switch } from "@/components/ui/switch";
-import { EnumConnectorName } from "@/contracts/enums/connector";
-import { DateRangeSelector } from "../../components/date-range-selector";
-import { getConnectorBenefits } from "../connector-benefits";
-import type { ConnectFormProps } from "../index";
-
-const clickupConnectorFormSchema = z.object({
- name: z.string().min(3, {
- message: "Connector name must be at least 3 characters.",
- }),
- api_token: z.string().min(10, {
- message: "ClickUp API Token is required and must be valid.",
- }),
-});
-
-type ClickUpConnectorFormValues = z.infer;
-
-export const ClickUpConnectForm: FC = ({ onSubmit, isSubmitting }) => {
- const isSubmittingRef = useRef(false);
- const [startDate, setStartDate] = useState(undefined);
- const [endDate, setEndDate] = useState(undefined);
- const [periodicEnabled, setPeriodicEnabled] = useState(false);
- const [frequencyMinutes, setFrequencyMinutes] = useState("1440");
- const form = useForm({
- resolver: zodResolver(clickupConnectorFormSchema),
- defaultValues: {
- name: "ClickUp Connector",
- api_token: "",
- },
- });
-
- const handleSubmit = async (values: ClickUpConnectorFormValues) => {
- // Prevent multiple submissions
- if (isSubmittingRef.current || isSubmitting) {
- return;
- }
-
- isSubmittingRef.current = true;
- try {
- await onSubmit({
- name: values.name,
- connector_type: EnumConnectorName.CLICKUP_CONNECTOR,
- config: {
- CLICKUP_API_TOKEN: values.api_token,
- },
- is_indexable: true,
- last_indexed_at: null,
- periodic_indexing_enabled: periodicEnabled,
- indexing_frequency_minutes: periodicEnabled ? parseInt(frequencyMinutes, 10) : null,
- next_scheduled_at: null,
- startDate,
- endDate,
- periodicEnabled,
- frequencyMinutes,
- });
- } finally {
- isSubmittingRef.current = false;
- }
- };
-
- return (
-
-
-
-
-
API Token Required
-
- You'll need a ClickUp API Token to use this connector. You can create one from{" "}
-
- ClickUp Settings
-
-
-
-
-
-
- {/* What you get section */}
- {getConnectorBenefits(EnumConnectorName.CLICKUP_CONNECTOR) && (
-
-
What you get with ClickUp integration:
-
- {getConnectorBenefits(EnumConnectorName.CLICKUP_CONNECTOR)?.map((benefit) => (
- - {benefit}
- ))}
-
-
- )}
-
- {/* Documentation Section */}
-
-
-
- Documentation
-
-
-
-
How it works
-
- The ClickUp connector uses the ClickUp API to fetch all tasks and projects that your
- API token has access to within your workspace.
-
-
- -
- For follow up indexing runs, the connector retrieves tasks 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.
-
-
-
-
-
Authorization
-
-
- API Token Required
-
- You need a ClickUp personal API token to use this connector. The token will be
- used to read your ClickUp data.
-
-
-
-
-
-
- Step 1: Get Your API Token
-
-
- - Log in to your ClickUp account
- - Click your avatar in the upper-right corner and select "Settings"
- - In the sidebar, click "Apps"
- -
- Under "API Token", click Generate or{" "}
- Regenerate
-
- - Copy the generated token (it typically starts with "pk_")
- -
- Paste it in the form above. You can also visit{" "}
-
- ClickUp API Settings
- {" "}
- directly.
-
-
-
-
-
-
- Step 2: Grant necessary access
-
-
- The API Token will have access to all tasks and projects that your user
- account can see. Make sure your account has appropriate permissions for the
- workspaces you want to index.
-
-
-
- Data Privacy
-
- Only tasks, comments, and basic metadata will be indexed. ClickUp
- attachments and linked files are not indexed by this connector.
-
-
-
-
-
-
-
-
Indexing
-
- -
- Navigate to the Connector Dashboard and select the ClickUp{" "}
- Connector.
-
- -
- Place your API Token in the form field.
-
- -
- Click Connect to establish the connection.
-
- - Once connected, your ClickUp tasks will be indexed automatically.
-
-
-
-
- What Gets Indexed
-
- The ClickUp connector indexes the following data:
-
- - Task names and descriptions
- - Task comments and discussion threads
- - Task status, priority, and assignee information
- - Project and workspace information
-
-
-
-
-
-
{t("welcome_title")}
-
- {t("welcome_description")}
-
+
{t("welcome_description")}
-
- {copied ? t("copied") : t("copy")}
-
+ {copied ? t("copied") : t("copy")}