mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-06-08 20:25:19 +02:00
Merge pull request #877 from AnishSarkar22/fix/ui-tests-ci
feat: add new index sections for docs & update content for installation section
This commit is contained in:
Rohan Verma
GitHub
commit
2587d027ba
6 changed files with 179 additions and 15 deletions
101
surfsense_web/content/docs/connectors/index.mdx
Normal file
101
surfsense_web/content/docs/connectors/index.mdx
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
---
|
||||
title: Connectors
|
||||
description: Integrate with third-party services
|
||||
---
|
||||
|
||||
import { Card, Cards } from 'fumadocs-ui/components/card';
|
||||
|
||||
Connect SurfSense to your favorite tools and services. Browse the available integrations below to sync data from productivity apps, communication platforms, knowledge bases, and more.
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title="Google Drive"
|
||||
description="Connect your Google Drive to SurfSense"
|
||||
href="/docs/connectors/google-drive"
|
||||
/>
|
||||
<Card
|
||||
title="Gmail"
|
||||
description="Connect your Gmail to SurfSense"
|
||||
href="/docs/connectors/gmail"
|
||||
/>
|
||||
<Card
|
||||
title="Google Calendar"
|
||||
description="Connect your Google Calendar to SurfSense"
|
||||
href="/docs/connectors/google-calendar"
|
||||
/>
|
||||
<Card
|
||||
title="Notion"
|
||||
description="Connect your Notion workspaces to SurfSense"
|
||||
href="/docs/connectors/notion"
|
||||
/>
|
||||
<Card
|
||||
title="Slack"
|
||||
description="Connect your Slack workspace to SurfSense"
|
||||
href="/docs/connectors/slack"
|
||||
/>
|
||||
<Card
|
||||
title="Discord"
|
||||
description="Connect your Discord servers to SurfSense"
|
||||
href="/docs/connectors/discord"
|
||||
/>
|
||||
<Card
|
||||
title="Jira"
|
||||
description="Connect your Jira projects to SurfSense"
|
||||
href="/docs/connectors/jira"
|
||||
/>
|
||||
<Card
|
||||
title="Linear"
|
||||
description="Connect your Linear workspace to SurfSense"
|
||||
href="/docs/connectors/linear"
|
||||
/>
|
||||
<Card
|
||||
title="Microsoft Teams"
|
||||
description="Connect your Microsoft Teams to SurfSense"
|
||||
href="/docs/connectors/microsoft-teams"
|
||||
/>
|
||||
<Card
|
||||
title="Confluence"
|
||||
description="Connect your Confluence spaces to SurfSense"
|
||||
href="/docs/connectors/confluence"
|
||||
/>
|
||||
<Card
|
||||
title="Airtable"
|
||||
description="Connect your Airtable bases to SurfSense"
|
||||
href="/docs/connectors/airtable"
|
||||
/>
|
||||
<Card
|
||||
title="ClickUp"
|
||||
description="Connect your ClickUp workspace to SurfSense"
|
||||
href="/docs/connectors/clickup"
|
||||
/>
|
||||
<Card
|
||||
title="GitHub"
|
||||
description="Connect your GitHub repositories to SurfSense"
|
||||
href="/docs/connectors/github"
|
||||
/>
|
||||
<Card
|
||||
title="Luma"
|
||||
description="Connect your Luma events to SurfSense"
|
||||
href="/docs/connectors/luma"
|
||||
/>
|
||||
<Card
|
||||
title="Circleback"
|
||||
description="Connect your Circleback meetings to SurfSense"
|
||||
href="/docs/connectors/circleback"
|
||||
/>
|
||||
<Card
|
||||
title="Elasticsearch"
|
||||
description="Connect your Elasticsearch cluster to SurfSense"
|
||||
href="/docs/connectors/elasticsearch"
|
||||
/>
|
||||
<Card
|
||||
title="Bookstack"
|
||||
description="Connect your Bookstack instance to SurfSense"
|
||||
href="/docs/connectors/bookstack"
|
||||
/>
|
||||
<Card
|
||||
title="Obsidian"
|
||||
description="Connect your Obsidian vault to SurfSense"
|
||||
href="/docs/connectors/obsidian"
|
||||
/>
|
||||
</Cards>
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"title": "Connectors",
|
||||
"icon": "Cable",
|
||||
"icon": "Unplug",
|
||||
"pages": [
|
||||
"google-drive",
|
||||
"gmail",
|
||||
|
|
|
|||
36
surfsense_web/content/docs/docker-installation/index.mdx
Normal file
36
surfsense_web/content/docs/docker-installation/index.mdx
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
title: Docker Installation
|
||||
description: Deploy SurfSense using Docker
|
||||
---
|
||||
|
||||
import { Card, Cards } from 'fumadocs-ui/components/card';
|
||||
|
||||
Choose your preferred Docker deployment method below.
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title="One-Line Install Script"
|
||||
description="One-command installation of SurfSense using Docker"
|
||||
href="/docs/docker-installation/install-script"
|
||||
/>
|
||||
<Card
|
||||
title="Docker Compose"
|
||||
description="Manual Docker Compose setup for SurfSense"
|
||||
href="/docs/docker-installation/docker-compose"
|
||||
/>
|
||||
<Card
|
||||
title="Updating"
|
||||
description="How to update your SurfSense Docker deployment"
|
||||
href="/docs/docker-installation/updating"
|
||||
/>
|
||||
<Card
|
||||
title="Docker Compose Development"
|
||||
description="Building SurfSense from source using docker-compose.dev.yml"
|
||||
href="/docs/docker-installation/dev-compose"
|
||||
/>
|
||||
<Card
|
||||
title="Migrate from the All-in-One Container"
|
||||
description="Migrate your data from the legacy all-in-one Docker image"
|
||||
href="/docs/docker-installation/migrate-from-allinone"
|
||||
/>
|
||||
</Cards>
|
||||
21
surfsense_web/content/docs/how-to/index.mdx
Normal file
21
surfsense_web/content/docs/how-to/index.mdx
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
title: How-To Guides
|
||||
description: Step-by-step guides for common tasks
|
||||
---
|
||||
|
||||
import { Card, Cards } from 'fumadocs-ui/components/card';
|
||||
|
||||
Practical guides to help you get the most out of SurfSense.
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title="Electric SQL"
|
||||
description="Setting up Electric SQL for real-time data synchronization"
|
||||
href="/docs/how-to/electric-sql"
|
||||
/>
|
||||
<Card
|
||||
title="Realtime Collaboration"
|
||||
description="Invite teammates, share chats, and collaborate in realtime"
|
||||
href="/docs/how-to/realtime-collaboration"
|
||||
/>
|
||||
</Cards>
|
||||
|
|
@ -1,21 +1,27 @@
|
|||
---
|
||||
title: Installation
|
||||
description: Current ways to use SurfSense
|
||||
description: How to install SurfSense - Docker or from source
|
||||
icon: Download
|
||||
---
|
||||
|
||||
# Installing SurfSense
|
||||
import { Card, Cards } from 'fumadocs-ui/components/card';
|
||||
import { Container, Wrench } from 'lucide-react';
|
||||
|
||||
There are two ways to install SurfSense, but both require the repository to be cloned first. Clone [SurfSense](https://github.com/MODSetter/SurfSense) and then:
|
||||
SurfSense runs as a Python backend + Next.js frontend. You can either spin it up with Docker or set everything up yourself.
|
||||
|
||||
## Docker Installation
|
||||
**Not sure which to pick?** Docker gets you up and running fastest. Go manual if you want to build SurfSense with us or need full control over the stack.
|
||||
|
||||
This method provides a containerized environment with all dependencies pre-configured. Less Customization.
|
||||
|
||||
[Learn more about Docker installation](/docs/docker-installation/install-script)
|
||||
|
||||
## Manual Installation (Preferred)
|
||||
|
||||
For users who prefer more control over the installation process or need to customize their setup, we also provide manual installation instructions.
|
||||
|
||||
[Learn more about Manual installation](/docs/manual-installation)
|
||||
<Cards>
|
||||
<Card
|
||||
icon={<Container />}
|
||||
title="Docker Installation"
|
||||
description="All dependencies pre-configured, up and running in minutes"
|
||||
href="/docs/docker-installation"
|
||||
/>
|
||||
<Card
|
||||
icon={<Wrench />}
|
||||
title="Manual Installation"
|
||||
description="Set up each component yourself for full control"
|
||||
href="/docs/manual-installation"
|
||||
/>
|
||||
</Cards>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Manual Installation
|
||||
description: Setting up SurfSense manually for customized deployments (Preferred)
|
||||
description: Setting up SurfSense manually for customized deployments
|
||||
icon: Wrench
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue