---
title: Documentation
description: Welcome to SurfSense's documentation
icon: BookOpen
---

import { Card, Cards } from 'fumadocs-ui/components/card';
import { Download, Container, Wrench, Cable, BookOpen, FlaskConical, Heart, MessageCircle, Cpu } from 'lucide-react';

Welcome to **SurfSense's Documentation!** Here, you'll find everything you need to get the most out of SurfSense.

## Getting Started

The fastest way to run SurfSense is the [Docker installation](/docs/docker-installation), one command and you're up. If you want full control over each component (or want to contribute), use the [manual installation](/docs/manual-installation).

<Cards>
  <Card
    icon={<Container />}
    title="Docker Installation"
    description="One command, all dependencies pre-configured (recommended)"
    href="/docs/docker-installation"
  />
  <Card
    icon={<Wrench />}
    title="Manual Installation"
    description="Set up SurfSense from source, component by component"
    href="/docs/manual-installation"
  />
  <Card
    icon={<Cable />}
    title="Connectors"
    description="Built-in scraper APIs plus Notion, Slack, Google, Jira, and more"
    href="/docs/connectors"
  />
  <Card
    icon={<Cpu />}
    title="Local Models"
    description="Connect local model servers like Ollama and LM Studio"
    href="/docs/local-models"
  />
  <Card
    icon={<MessageCircle />}
    title="Messaging Channels"
    description="Chat with SurfSense from Telegram, WhatsApp, Slack, and Discord"
    href="/docs/messaging-channels"
  />
  <Card
    icon={<BookOpen />}
    title="How-To Guides"
    description="Step-by-step guides for common tasks"
    href="/docs/how-to"
  />
  <Card
    icon={<FlaskConical />}
    title="Testing"
    description="Running and writing tests for SurfSense"
    href="/docs/testing"
  />
  <Card
    icon={<Heart />}
    title="Code of Conduct"
    description="Community guidelines and expectations"
    href="/docs/code-of-conduct"
  />
</Cards>