SurfSense/README.md
DESKTOP-RTLN3BA\$punk 9e359a79b9 feat: update README files to include usage instructions
- Added a new section on how to use SurfSense across all language-specific README files.
- Included visual elements such as images and badges for better user engagement and clarity.
- Enhanced the structure of the documentation to improve readability and accessibility for users.
2026-02-16 05:05:30 -08:00

7.1 KiB

readme_banner

MODSetter%2FSurfSense | Trendshift

SurfSense

Connect any LLM to your internal knowledge sources and chat with it in real time alongside your team. OSS alternative to NotebookLM, Perplexity, and Glean.

SurfSense is a highly customizable AI research agent, connected to external sources such as Search Engines (SearxNG, Tavily, LinkUp), Google Drive, Slack, Microsoft Teams, Linear, Jira, ClickUp, Confluence, BookStack, Gmail, Notion, YouTube, GitHub, Discord, Airtable, Google Calendar, Luma, Circleback, Elasticsearch, Obsidian and more to come.

Video

https://github.com/user-attachments/assets/cc0c84d3-1f2f-4f7a-b519-2ecce22310b1

Podcast Sample

https://github.com/user-attachments/assets/a0a16566-6967-4374-ac51-9b3e07fbecd7

How to Use SurfSense

Cloud

  1. Go to surfsense.com and login.

Login

  1. Connect your connectors and sync. Enable periodic syncing to keep connectors synced.

Connectors

  1. Till connectors data index, upload Documents.

Upload Documents

  1. Once everything is indexed, Ask Away (Use Cases):

    • Basic search and citation

    Search and Citation

    • Document Mention QNA

    Document Mention QNA

    • Report Generations and Exports (PDF, DOCX for now)

    Report Generation

    • Podcast Generations

    Podcast Generation

    • Image Generations

    Image Generation

Self Hosted

Run SurfSense on your own infrastructure for full data control and privacy.

Quick Start (Docker one-liner):

docker run -d -p 3000:3000 -p 8000:8000 -p 5133:5133 \
  -v surfsense-data:/data \
  --name surfsense \
  --restart unless-stopped \
  ghcr.io/modsetter/surfsense:latest

After starting, open http://localhost:3000 in your browser.

For Docker Compose, manual installation, and other deployment options, check the docs.

Key Features

Feature Description
OSS Alternative Drop in replacement for NotebookLM, Perplexity, and Glean with real time team collaboration
50+ File Formats Upload documents, images, videos via LlamaCloud, Unstructured, or Docling (local)
Hybrid Search Semantic + Full Text Search with Hierarchical Indices and Reciprocal Rank Fusion
Cited Answers Chat with your knowledge base and get Perplexity style cited responses
Deep Agent Architecture Powered by LangChain Deep Agents planning, subagents, and file system access
Universal LLM Support 100+ LLMs, 6000+ embedding models, all major rerankers via OpenAI spec & LiteLLM
Privacy First Full local LLM support (vLLM, Ollama) your data stays yours
Team Collaboration RBAC with Owner / Admin / Editor / Viewer roles, real time chat & comment threads
Podcast Generation 3 min podcast in under 20 seconds; multiple TTS providers (OpenAI, Azure, Kokoro)
Browser Extension Cross browser extension to save any webpage, including auth protected pages
25+ Connectors Search Engines, Google Drive, Slack, Teams, Jira, Notion, GitHub, Discord & more
Self Hostable Open source, Docker one liner or full Docker Compose for production
Full list of External Sources

Search Engines (Tavily, LinkUp) · SearxNG · Google Drive · Slack · Microsoft Teams · Linear · Jira · ClickUp · Confluence · BookStack · Notion · Gmail · YouTube Videos · GitHub · Discord · Airtable · Google Calendar · Luma · Circleback · Elasticsearch · Obsidian, and more to come.

FEATURE REQUESTS AND FUTURE

SurfSense is actively being developed. While it's not yet production-ready, you can help us speed up the process.

Join the SurfSense Discord and help shape the future of SurfSense!

Roadmap

Stay up to date with our development progress and upcoming features!
Check out our public roadmap and contribute your ideas or feedback:

Roadmap Discussion: SurfSense 2026 Roadmap

Kanban Board: SurfSense Project Board

Contribute

Contributions are very welcome! A contribution can be as small as a star or even finding and creating issues. Fine-tuning the Backend is always desired.

For detailed contribution guidelines, please see our CONTRIBUTING.md file.

Contributors

Star History

Star History Chart

Catalyst Project