vrr/SurfSense
2
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2025-09-02 10:39:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: updated docs

Browse source
This commit is contained in:
DESKTOP-RTLN3BA\$punk 2025-06-05 14:23:37 -07:00
parent 07536c883d
commit 051580d145
4 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

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

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

@ -25,8 +25,9 @@ Before you begin, ensure you have:
- [Git](https://git-scm.com/downloads) (to clone the repository) - [Git](https://git-scm.com/downloads) (to clone the repository)
- Completed all the [prerequisite setup steps](/docs) including: - Completed all the [prerequisite setup steps](/docs) including:
- PGVector setup - PGVector setup
- Google OAuth configuration - **File Processing ETL Service** (choose one):
- Unstructured.io API key - Unstructured.io API key (Supports 34+ formats)
- LlamaIndex API key (enhanced parsing, supports 50+ formats)
- Other required API keys - Other required API keys
## Installation Steps ## Installation Steps

2
surfsense_web/content/docs/index.mdx
View file

@ -85,7 +85,7 @@ Files are converted using [LlamaIndex](https://www.llamaindex.ai/) which offers
2. Sign up for a LlamaCloud account to access their parsing services 2. Sign up for a LlamaCloud account to access their parsing services
3. LlamaCloud provides enhanced parsing capabilities for complex documents 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. **Note**: You only need to set up one of these services.
--- ---

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

@ -12,11 +12,11 @@ This guide provides step-by-step instructions for setting up SurfSense without D
Before beginning the manual installation, ensure you have completed all the [prerequisite setup steps](/docs), including: Before beginning the manual installation, ensure you have completed all the [prerequisite setup steps](/docs), including:
- PGVector installation - PGVector setup
- Google OAuth setup - **File Processing ETL Service** (choose one):
- Unstructured.io API key - Unstructured.io API key (Supports 34+ formats)
- LLM observability (optional) - LlamaIndex API key (enhanced parsing, supports 50+ formats)
- Crawler setup (if needed) - Other required API keys
## Backend Setup ## Backend Setup