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

Update README.md

Browse source
This commit is contained in:
Rohan Verma 2024-10-24 22:54:37 -07:00 • committed by GitHub
parent 3fd9ae8e37
commit 309d28c3d9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -33,6 +33,11 @@ https://github.com/user-attachments/assets/cc6a0c51-7de0-45cd-982d-21768dc2dd38
## How to get started? ## How to get started?
--- ---
**UPDATE 24 OCTOBER 2024:**
- SurfSense now uses custom gpt-researcher agent to format responses.
- Added better markdown rendering to UI.
**UPDATE 8 OCTOBER 2024:** **UPDATE 8 OCTOBER 2024:**
- SurfSense now lets you upload your own files such as pdfs, docx, images etc into your SurfSense Knowledge Base. - SurfSense now lets you upload your own files such as pdfs, docx, images etc into your SurfSense Knowledge Base.
- SurfSense uses [Unstructured-IO](https://github.com/Unstructured-IO/unstructured) to support files. - SurfSense uses [Unstructured-IO](https://github.com/Unstructured-IO/unstructured) to support files.
@ -76,7 +81,6 @@ Now lets setup the SurfSense BackEnd
|ENV VARIABLE|Description | |ENV VARIABLE|Description |
|--|--| |--|--|
| IS_LOCAL_SETUP | 'true' for Ollama mistral-nemo or 'false' from OpenAI gpt-4o-mini|
| UNSTRUCTURED_API_KEY | Your Unstructured IO API Key. Use any value if running a local instance or file upload support isn't needed.| | UNSTRUCTURED_API_KEY | Your Unstructured IO API Key. Use any value if running a local instance or file upload support isn't needed.|
| POSTGRES_DATABASE_URL | postgresql+psycopg2://user:pass@host:5432/database| | POSTGRES_DATABASE_URL | postgresql+psycopg2://user:pass@host:5432/database|
| API_SECRET_KEY | Can be any Random String value. Make Sure to remember it for as you need to send it in user registration request to Backend for security purposes.| | API_SECRET_KEY | Can be any Random String value. Make Sure to remember it for as you need to send it in user registration request to Backend for security purposes.|