apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-05-09 15:52:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #72 from MODSetter/dev

Browse source 
chore: Updated Docs
This commit is contained in:
Rohan Verma 2025-05-06 00:14:36 -07:00 • committed by GitHub
commit d716347531
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -16,6 +16,9 @@ While tools like NotebookLM and Perplexity are impressive and highly effective f
https://github.com/user-attachments/assets/48142909-6391-4084-b7e8-81da388bb1fc https://github.com/user-attachments/assets/48142909-6391-4084-b7e8-81da388bb1fc
# Podcast's
https://github.com/user-attachments/assets/d516982f-de00-4c41-9e4c-632a7d942f41
@ -36,6 +39,11 @@ Get Cited answers just like Perplexity.
Works Flawlessly with Ollama local LLMs. Works Flawlessly with Ollama local LLMs.
#### 🏠 **Self Hostable** #### 🏠 **Self Hostable**
Open source and easy to deploy locally. Open source and easy to deploy locally.
#### 🎙️ Podcasts
- Blazingly fast podcast generation agent. (Creates a 3-minute podcast in under 20 seconds.)
- Convert your chat conversations into engaging audio content
- Support for multiple TTS providers (OpenAI, Azure, Google Vertex AI)
#### 📊 **Advanced RAG Techniques** #### 📊 **Advanced RAG Techniques**
- Supports 150+ LLM's - Supports 150+ LLM's
- Supports 6000+ Embedding Models. - Supports 6000+ Embedding Models.
@ -58,12 +66,6 @@ Open source and easy to deploy locally.
- Its main usecase is to save any webpages protected beyond authentication. - Its main usecase is to save any webpages protected beyond authentication.
### 2. Temporarily Deprecated
#### Podcasts
- The SurfSense Podcast feature is currently being reworked for better UI and stability. Expect it soon.
## FEATURE REQUESTS AND FUTURE ## FEATURE REQUESTS AND FUTURE
@ -104,6 +106,9 @@ Before installation, make sure to complete the [prerequisite setup steps](https:
![researcher](https://github.com/user-attachments/assets/fda3e61f-f936-4b66-b565-d84edde44a67) ![researcher](https://github.com/user-attachments/assets/fda3e61f-f936-4b66-b565-d84edde44a67)
**Podcast Agent**
![podcasts](https://github.com/user-attachments/assets/6cb82ffd-9e14-4172-bc79-67faf34c4c1c)
**Agent Chat** **Agent Chat**
@ -115,6 +120,7 @@ Before installation, make sure to complete the [prerequisite setup steps](https:
![ext2](https://github.com/user-attachments/assets/a9b9f1aa-2677-404d-b0a0-c1b2dddf24a7) ![ext2](https://github.com/user-attachments/assets/a9b9f1aa-2677-404d-b0a0-c1b2dddf24a7)
## Tech Stack ## Tech Stack

1
surfsense_web/content/docs/docker-installation.mdx
View file

@ -73,6 +73,7 @@ Before you begin, ensure you have:
| LONG_CONTEXT_LLM | LiteLLM routed LLM for longer context windows (e.g., `gemini/gemini-2.0-flash`, `ollama/deepseek-r1:8b`) | | LONG_CONTEXT_LLM | LiteLLM routed LLM for longer context windows (e.g., `gemini/gemini-2.0-flash`, `ollama/deepseek-r1:8b`) |
| UNSTRUCTURED_API_KEY | API key for Unstructured.io service for document parsing | | UNSTRUCTURED_API_KEY | API key for Unstructured.io service for document parsing |
| FIRECRAWL_API_KEY | API key for Firecrawl service for web crawling | | FIRECRAWL_API_KEY | API key for Firecrawl service for web crawling |
| TTS_SERVICE | Text-to-Speech API provider for Podcasts (e.g., `openai/tts-1`, `azure/neural`, `vertex_ai/`). See [supported providers](https://docs.litellm.ai/docs/text_to_speech#supported-providers) |
Include API keys for the LLM providers you're using. For example: Include API keys for the LLM providers you're using. For example:
- `OPENAI_API_KEY`: If using OpenAI models - `OPENAI_API_KEY`: If using OpenAI models

1
surfsense_web/content/docs/manual-installation.mdx
View file

@ -61,6 +61,7 @@ Edit the `.env` file and set the following variables:
| LONG_CONTEXT_LLM | LiteLLM routed long-context LLM (e.g., `gemini/gemini-2.0-flash`, `ollama/deepseek-r1:8b`) | | LONG_CONTEXT_LLM | LiteLLM routed long-context LLM (e.g., `gemini/gemini-2.0-flash`, `ollama/deepseek-r1:8b`) |
| UNSTRUCTURED_API_KEY | API key for Unstructured.io service | | UNSTRUCTURED_API_KEY | API key for Unstructured.io service |
| FIRECRAWL_API_KEY | API key for Firecrawl service (if using crawler) | | FIRECRAWL_API_KEY | API key for Firecrawl service (if using crawler) |
| TTS_SERVICE | Text-to-Speech API provider for Podcasts (e.g., `openai/tts-1`, `azure/neural`, `vertex_ai/`). See [supported providers](https://docs.litellm.ai/docs/text_to_speech#supported-providers) |
**Important**: Since LLM calls are routed through LiteLLM, include API keys for the LLM providers you're using: **Important**: Since LLM calls are routed through LiteLLM, include API keys for the LLM providers you're using:
- For OpenAI models: `OPENAI_API_KEY` - For OpenAI models: `OPENAI_API_KEY`