Skip to content

fix: docs #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MODSetter merged 2 commits into from
Jun 3, 2025
Merged

fix: docs #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aebe85c
lol: Forgotten Docs update so unstructured sales teams can relax xD
MODSetter Jun 3, 2025
4d3655f
relax claude
MODSetter Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,9 @@ Both installation guides include detailed OS-specific instructions for Windows,

Before installation, make sure to complete the [prerequisite setup steps](https://www.surfsense.net/docs/) including:
- PGVector setup
- Unstructured.io API key
- **File Processing ETL Service** (choose one):
- Unstructured.io API key (free tier available, supports 34+ formats)
- LlamaIndex API key (enhanced parsing, supports 50+ formats)
- Other required API keys

## Screenshots
Expand Down
16 changes: 15 additions & 1 deletion surfsense_web/content/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,26 @@ To set up Google OAuth:

## File Upload's

Files are converted to LLM friendly formats using [Unstructured](https://github.com/Unstructured-IO/unstructured)
SurfSense supports two ETL (Extract, Transform, Load) services for converting files to LLM-friendly formats:

### Option 1: Unstructured

Files are converted using [Unstructured](https://github.com/Unstructured-IO/unstructured)

1. Get an Unstructured.io API key from [Unstructured Platform](https://platform.unstructured.io/)
2. You should be able to generate API keys once registered
![Unstructured Dashboard](/docs/unstructured.png)

### Option 2: LlamaIndex (LlamaCloud)

Files are converted using [LlamaIndex](https://www.llamaindex.ai/) which offers 50+ file format support.

1. Get a LlamaIndex API key from [LlamaCloud](https://cloud.llamaindex.ai/)
2. Sign up for a LlamaCloud account to access their parsing services
3. LlamaCloud provides enhanced parsing capabilities for complex documents

**Note**: You only need to set up one of these services. LlamaIndex offers broader file format support, while Unstructured provides a generous free tier.

---

## LLM Observability (Optional)
Expand Down