amutha06 commited on
Commit
16dcd25
Β·
verified Β·
1 Parent(s): 5fbc5a7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +42 -5
README.md CHANGED
@@ -1,10 +1,47 @@
1
  ---
2
  title: Flowise
3
- emoji: πŸ†
4
- colorFrom: indigo
5
- colorTo: gray
6
  sdk: docker
7
  pinned: false
8
  ---
9
-
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: Flowise
3
+ emoji: πŸš€
4
+ colorFrom: gray
5
+ colorTo: green
6
  sdk: docker
7
  pinned: false
8
  ---
9
+ ## πŸ’Ύ Flowise on Hugging Face Spaces (with Chroma Persistence)
10
+ This Space uses **Flowise with local Chroma DB and SQLite** to store your documents and
11
+ chat history.
12
+ > Once the container is running, access Flowise via the **App** tab above.
13
+ ### πŸ“ What gets saved?
14
+ - **Uploaded documents and embeddings** β†’ `/data/chroma`
15
+ - **Chat history and upsert logs** β†’ `/data/flowise.db`
16
+ - **Configuration file** β†’ `flowise.json`
17
+ These are stored in a special folder called `/data` which survives restarts but **not**
18
+ rebuilds.
19
+ ---
20
+ ## ⚠ Do Not Edit or Rebuild
21
+ - Any code or README change deletes all your data.
22
+ - Do **not** commit changes once you’ve started using the Space.
23
+ - If you accidentally rebuild, all documents and work are lost.
24
+ - Rebuilds may also occur if Hugging Face updates backend infrastructure. Back up your data
25
+ regularly.
26
+ ---
27
+ ## 🧱 How to Back Up Your Work
28
+ ### βœ… Recommended Method: Export from Flowise UI
29
+ 1. Open Flowise via the **App** tab.
30
+ 2. Click the purple gear icon (top right) in your flow.
31
+ 3. Choose **Export** to download the `.json` file to your device.
32
+ 4. Unfortunately, for full data backups, you need to use a paid Hugging Face plan and mount
33
+ external storage.
34
+ > Note: Runtime files (like `/data`) are not visible or downloadable from the Files tab in
35
+ free-tier Docker Spaces.
36
+ ---
37
+ ## πŸ’‘ Tip for Teams
38
+ - Back up your data **as soon as your bot is working**
39
+ - Re-upload documents only if necessary β€” rebuilding means starting over
40
+ ---
41
+ ## πŸ›  Version Info
42
+ - This setup uses **Flowise version 3.0.0**
43
+ - Compatibility may vary with later versions
44
+ ---
45
+ ## β„Ή Reference
46
+ Flowise Docs: https://docs.flowiseai.com/
47
+ Hugging Face Space Settings: https://huggingface.co/docs/hub/spaces