KoalaFlow commited on
Commit
8660274
·
verified ·
1 Parent(s): 365400e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +39 -15
README.md CHANGED
@@ -7,25 +7,49 @@ sdk: docker
7
  pinned: false
8
  ---
9
 
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
11
 
12
- ## 📦 Data Persistence Notice
13
 
14
- This Space uses **Flowise with local Chroma DB and SQLite** for storing upserted documents and chat history.
 
 
15
 
16
- ### 🔒 Data will persist **only if saved to `/data`**
17
- - This Space is configured to store vector data in `/data/chroma`
18
- - Upsert records are saved in `/data/flowise.db`
19
- - These will persist across **restarts**
20
 
21
- ### ⚠️ However, all data will be lost if the Space is rebuilt
22
- This happens when:
23
- - Any file (like the Dockerfile) is changed and pushed
24
- - The Space is restarted manually after a code change
 
 
 
 
 
 
 
 
 
25
 
26
- ### Best Practice for Students
27
- - Wait until the bot is working before uploading documents
28
- - Do **not** push new code or commit changes once content is uploaded
29
- - If your data disappears, it’s likely because the Space was rebuilt
 
 
 
 
 
 
 
 
 
 
 
 
 
30
 
 
31
 
 
 
 
7
  pinned: false
8
  ---
9
 
10
+ ## 💾 Flowise on Hugging Face Spaces (with Chroma Persistence)
11
 
12
+ This Space uses **Flowise with local Chroma DB and SQLite** to store your documents and chat history.
13
 
14
+ ### 📍 What gets saved?
15
+ - **Uploaded documents and embeddings** → `/data/chroma`
16
+ - **Chat history and upsert logs** → `/data/flowise.db`
17
 
18
+ These are stored in a special folder called `/data` which survives restarts but **not** rebuilds.
 
 
 
19
 
20
+ ---
21
+
22
+ ## ⚠️ Do Not Edit or Rebuild
23
+
24
+ - Any code or README change deletes all your data.
25
+ - Do **not** commit changes once you’ve started using the Space.
26
+ - If you accidentally rebuild, all documents and work are lost.
27
+
28
+ ---
29
+
30
+ ## 🧱 How to Save Your Work to Your Own Laptop
31
+
32
+ ### ✅ Reliable Method: Use the Hugging Face “Files and versions” tab
33
 
34
+ 1. At the top of this Space page, click **“Files and versions”**
35
+ 2. Look for:
36
+ - `/data/chroma/` (folder with document embeddings)
37
+ - `/data/flowise.db` (your chatbot's memory and logs)
38
+ 3. Click the filename or folder to download it.
39
+ 4. Save these files to your own laptop or Google Drive.
40
+
41
+ > These files are your backup. You can restore them later if needed.
42
+
43
+ ---
44
+
45
+ ## 💡 Tip for Teams
46
+
47
+ - Back up your data **as soon as your bot is working**
48
+ - Re-upload documents only if necessary — rebuilding means starting over
49
+
50
+ ---
51
 
52
+ ## ℹ️ Reference
53
 
54
+ Flowise Docs: https://docs.flowiseai.com/
55
+ Hugging Face Space Settings: https://huggingface.co/docs/hub/spaces