mirror of
https://github.com/MODSetter/SurfSense.git
synced 2025-09-01 18:19:08 +00:00
Update README.md
This commit is contained in:
parent
a8a29d5af7
commit
4d29fb214c
1 changed files with 13 additions and 9 deletions
22
README.md
22
README.md
|
@ -35,18 +35,10 @@ https://github.com/user-attachments/assets/f9c49698-f868-4a66-9601-16d375eaad64
|
|||
- 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.
|
||||
|
||||
---
|
||||
|
||||
**UPDATE 25 SEPTEMBER 2024:**
|
||||
- Thanks [@hnico21](https://github.com/hnico21) for adding Docker Support
|
||||
|
||||
### Docker Setup
|
||||
|
||||
1. Setup `SurfSense-Frontend/.env` and `backend/.env`
|
||||
2. Run `docker-compose build --no-cache`.
|
||||
3. After building image run `docker-compose up -d`
|
||||
4. Now connect the extension with docker live backend url by updating `ss-cross-browser-extension/.env` and building it.
|
||||
|
||||
---
|
||||
|
||||
**UPDATE 20 SEPTEMBER 2024:**
|
||||
|
||||
|
@ -56,11 +48,23 @@ https://github.com/user-attachments/assets/f9c49698-f868-4a66-9601-16d375eaad64
|
|||
|
||||
Until I find a good host for my backend you need to setup SurfSense locally for now.
|
||||
|
||||
---
|
||||
|
||||
### Docker Setup
|
||||
|
||||
1. Setup `SurfSense-Frontend/.env` and `backend/.env`
|
||||
2. Run `docker-compose build --no-cache`.
|
||||
3. After building image run `docker-compose up -d`
|
||||
4. Now connect the extension with docker live backend url by updating `ss-cross-browser-extension/.env` and building it.
|
||||
|
||||
|
||||
---
|
||||
### Backend
|
||||
|
||||
For authentication purposes, you’ll also need a PostgreSQL instance running on your machine.
|
||||
|
||||
**UPDATE** : SurfSense now supports uploading various file types. To enable this feature, please set up the Unstructured.io library. You can follow the setup guide here: https://github.com/Unstructured-IO/unstructured?tab=readme-ov-file#installing-the-library
|
||||
|
||||
Now lets setup the SurfSense BackEnd
|
||||
1. Clone this repo.
|
||||
2. Go to ./backend subdirectory.
|
||||
|
|
Loading…
Add table
Reference in a new issue