apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-04-25 08:46:22 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
An open source, privacy focused alternative to NotebookLM for teams with no data limit's. Join our Discord: https://discord.gg/ejRNvftDp9 https://www.surfsense.com
3505 commits 3 branches 209 tags 381 MiB
Find a file
Anish Sarkar 3e4db20bcb fix: update baseline logic in useDocuments and useInbox hooks to accurately track new items and unread counts, addressing timing issues with Electric updates
2026-03-06 20:21:28 +05:30
.cursor/skills/tdd rename test_index.py to test_index_document.py 2026-02-25 01:43:21 +02:00
.github chore: update GitHub Actions workflow to include 'dev' branch and change installation script to use 'dev' repository URL 2026-03-03 03:35:29 +05:30
.rules Recurse rules 2025-08-04 14:02:13 +01:00
.vscode feat: add new FastAPI debug configurations and enhance web crawling capabilities with real-time web query support 2026-02-20 17:28:20 -08:00
docker fix: correct dump content retrieval in migrate-database.ps1 to ensure proper handling of PostgreSQL dump files 2026-03-03 13:13:25 -08:00
docs feat: add Chinese LLM providers support with auto-fill API Base URL 2025-10-12 19:10:46 +08:00
surfsense_backend feat: enhance notifications system by introducing category-based filtering for comments and status, improving user experience in the inbox and API interactions 2026-03-06 19:35:35 +05:30
surfsense_browser_extension feat: bumped version to 0.0.13 2026-02-09 17:59:07 -08:00
surfsense_web fix: update baseline logic in useDocuments and useInbox hooks to accurately track new items and unread counts, addressing timing issues with Electric updates 2026-03-06 20:21:28 +05:30
.dockerignore fix: logs now showing in docker builds 2025-12-28 00:37:26 +05:30
.gitattributes fix: backend container fails with missing entrypoint when built locally 2025-12-06 21:31:32 -08:00
.gitignore chore: update installation script to improve error handling and suppress output in Docker commands 2026-03-03 19:33:21 +05:30
.pre-commit-config.yaml fix: add input validation, retry limit, code formatting, and exclude i18n from secret detection 2025-12-05 09:58:49 +08:00
.recurseml.yaml Recurse rules 2025-08-04 14:02:13 +01:00
.secrets.baseline chore: add pre-commit 2025-07-21 22:46:12 +05:45
biome.json Biome: Pre-commit fix 2025-07-27 12:20:35 -07:00
CODE_OF_CONDUCT.md fix: celery_app path and gmail indexing 2025-10-21 21:11:41 -07:00
CONTRIBUTING.md chore: update links in documentation and metadata to use the correct domain 2025-12-09 01:27:13 -08:00
LICENSE Create LICENSE 2024-08-13 01:26:07 -07:00
README.es.md docs: update installation instructions in multiple language READMEs to specify Docker Desktop and provide separate commands for Windows users 2026-03-04 01:07:25 +05:30
README.hi.md docs: update installation instructions in multiple language READMEs to specify Docker Desktop and provide separate commands for Windows users 2026-03-04 01:07:25 +05:30
README.md docs: update installation instructions in multiple language READMEs to specify Docker Desktop and provide separate commands for Windows users 2026-03-04 01:07:25 +05:30
README.pt-BR.md docs: update installation instructions in multiple language READMEs to specify Docker Desktop and provide separate commands for Windows users 2026-03-04 01:07:25 +05:30
README.zh-CN.md docs: update installation instructions in multiple language READMEs to specify Docker Desktop and provide separate commands for Windows users 2026-03-04 01:07:25 +05:30

README.md

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

    • And more coming soon.

Self Hosted

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

Prerequisites: Docker Desktop must be installed and running.

For Linux/MacOS users:

curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash

For Windows users:

irm https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.ps1 | iex

The install script sets up Watchtower automatically for daily auto-updates. To skip it, add the --no-watchtower flag.

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

How to Realtime Collaborate (Beta)

  1. Go to Manage Members page and create an invite.

    Invite Members

  2. Teammate joins and that SearchSpace becomes shared.

    Invite Join Flow

  3. Make chat shared.

    Make Chat Shared

  4. Your team can now chat in realtime.

    Realtime Chat

  5. Add comment to tag teammates.

    Realtime Comments

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

All contributions welcome, from stars and bug reports to backend improvements. See CONTRIBUTING.md to get started.

Thanks to all our Surfers:

Star History

Star History Chart

Catalyst Project