writinwaters commited on
Commit
3a0bf13
·
1 Parent(s): 7e1a9f0

Added FAQs (#395)

Browse files

### What problem does this PR solve?

### Type of change

- [x] Documentation Update

Files changed (1) hide show
  1. docs/faq.md +34 -5
docs/faq.md CHANGED
@@ -76,11 +76,15 @@ You can use Ollama to deploy local LLM. See [here](https://github.com/infiniflow
76
 
77
  ## Debugging
78
 
79
- ### How to handle `WARNING: can't find /raglof/rag/res/borker.tm`?
80
 
81
  Ignore this warning and continue. All system warnings can be ignored.
82
 
83
- ### How to handle `Realtime synonym is disabled, since no redis connection`?
 
 
 
 
84
 
85
  Ignore this warning and continue. All system warnings can be ignored.
86
 
@@ -101,7 +105,7 @@ docker logs -f ragflow-server
101
  2. Check if the **tast_executor.py** process exist.
102
  3. Check if your RAGFlow server can access hf-mirror.com or huggingface.com.
103
 
104
- ### How to handle `Index failure`?
105
 
106
  An index failure usually indicates an unavailable Elasticsearch service.
107
 
@@ -125,7 +129,7 @@ d8c86f06c56b mysql:5.7.18 "docker-entrypoint.s…" 7 days ago Up
125
  cd29bcb254bc quay.io/minio/minio:RELEASE.2023-12-20T01-00-02Z "/usr/bin/docker-ent…" 2 weeks ago Up 11 hours 0.0.0.0:9001->9001/tcp, :::9001->9001/tcp, 0.0.0.0:9000->9000/tcp, :::9000->9000/tcp ragflow-minio
126
  ```
127
 
128
- ### How to handle `Exception: Can't connect to ES cluster`?
129
 
130
  1. Check the status of your Elasticsearch component:
131
 
@@ -153,12 +157,37 @@ $ docker ps
153
  ```
154
 
155
 
156
- ### How to handle `{"data":null,"retcode":100,"retmsg":"<NotFound '404: Not Found'>"}`?
157
 
158
  Your IP address or port number may be incorrect. If you are using the default configurations, enter http://<IP_OF_YOUR_MACHINE> (**NOT `localhost`, NOT 9380, AND NO PORT NUMBER REQUIRED!**) in your browser. This should work.
159
 
 
 
 
 
 
 
 
 
160
 
 
161
 
 
162
 
 
163
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
164
 
 
76
 
77
  ## Debugging
78
 
79
+ ### `WARNING: can't find /raglof/rag/res/borker.tm`
80
 
81
  Ignore this warning and continue. All system warnings can be ignored.
82
 
83
+ ### `dependency failed to start: container ragflow-mysql is unhealthy`
84
+
85
+ `dependency failed to start: container ragflow-mysql is unhealthy` means that your MySQL container failed to start. If you are using a Mac with an M1/M2 chip, replace `mysql:5.7.18` with `mariadb:10.5.8` in **docker-compose-base.yml**.
86
+
87
+ ### `Realtime synonym is disabled, since no redis connection`
88
 
89
  Ignore this warning and continue. All system warnings can be ignored.
90
 
 
105
  2. Check if the **tast_executor.py** process exist.
106
  3. Check if your RAGFlow server can access hf-mirror.com or huggingface.com.
107
 
108
+ ### `Index failure`
109
 
110
  An index failure usually indicates an unavailable Elasticsearch service.
111
 
 
129
  cd29bcb254bc quay.io/minio/minio:RELEASE.2023-12-20T01-00-02Z "/usr/bin/docker-ent…" 2 weeks ago Up 11 hours 0.0.0.0:9001->9001/tcp, :::9001->9001/tcp, 0.0.0.0:9000->9000/tcp, :::9000->9000/tcp ragflow-minio
130
  ```
131
 
132
+ ### `Exception: Can't connect to ES cluster`
133
 
134
  1. Check the status of your Elasticsearch component:
135
 
 
157
  ```
158
 
159
 
160
+ ### `{"data":null,"retcode":100,"retmsg":"<NotFound '404: Not Found'>"}`
161
 
162
  Your IP address or port number may be incorrect. If you are using the default configurations, enter http://<IP_OF_YOUR_MACHINE> (**NOT `localhost`, NOT 9380, AND NO PORT NUMBER REQUIRED!**) in your browser. This should work.
163
 
164
+ ### `Ollama - Mistral instance running at 127.0.0.1:11434 but cannot add Ollama as model in RagFlow`
165
+
166
+ A correct Ollama IP address and port is crucial to adding models to Ollama:
167
+
168
+ - If you are on demo.ragflow.io, ensure that the server hosting Ollama has a publicly accessible IP address. 127.0.0.1 is not an accessible IP address.
169
+ - If you deploy RAGFlow locally, ensure that Ollama and RAGFlow are in the same LAN and can comunicate with each other.
170
+
171
+ ### Do you offer examples of using deepdoc to parse PDF or other files?
172
 
173
+ Yes, we do. See the Python files under the **rag/app** folder.
174
 
175
+ ### Why did I fail to upload a 10MB+ file to my locally deployed RAGFlow?
176
 
177
+ You probably forgot to update the **MAX_CONTENT_LENGTH** environment variable:
178
 
179
+ 1. Add environment variable `MAX_CONTENT_LENGTH` to **ragflow/docker/.env**:
180
+ ```
181
+ MAX_CONTENT_LENGTH=100000000
182
+ ```
183
+ 2. Update **docker-compose.yml**:
184
+ ```
185
+ environment:
186
+ - MAX_CONTENT_LENGTH=${MAX_CONTENT_LENGTH}
187
+ ```
188
+ 3. Restart the RAGFlow server:
189
+ ```
190
+ docker compose up ragflow -d
191
+ ```
192
+ *Now you should be able to upload files of sizes less than 100MB.*
193