diff --git a/README.md b/README.md index 7b854ea0f..d1b7a2a65 100644 --- a/README.md +++ b/README.md @@ -138,9 +138,10 @@ * Running on http://x.x.x.x:9380 INFO:werkzeug:Press CTRL+C to quit ``` + > If you skip this confirmation step and directly log in to RAGFlow, your browser may prompt a `network anomaly` error because, at that moment, your RAGFlow may not be fully initialized. 5. In your web browser, enter the IP address of your server and log in to RAGFlow. - > In the given scenario, you only need to enter `http://IP_OF_YOUR_MACHINE` (**sans** port number) as the default HTTP serving port `80` can be omitted when using the default configurations. + > With default settings, you only need to enter `http://IP_OF_YOUR_MACHINE` (**sans** port number) as the default HTTP serving port `80` can be omitted when using the default configurations. 6. In [service_conf.yaml](./docker/service_conf.yaml), select the desired LLM factory in `user_default_llm` and update the `API_KEY` field with the corresponding API key. > See [./docs/llm_api_key_setup.md](./docs/llm_api_key_setup.md) for more information. diff --git a/README_ja.md b/README_ja.md index 0e91ea90d..4f654d2e8 100644 --- a/README_ja.md +++ b/README_ja.md @@ -138,6 +138,7 @@ * Running on http://x.x.x.x:9380 INFO:werkzeug:Press CTRL+C to quit ``` + > もし確認ステップをスキップして直接 RAGFlow にログインした場合、その時点で RAGFlow が完全に初期化されていない可能性があるため、ブラウザーがネットワーク異常エラーを表示するかもしれません。 5. ウェブブラウザで、プロンプトに従ってサーバーの IP アドレスを入力し、RAGFlow にログインします。 > デフォルトの設定を使用する場合、デフォルトの HTTP サービングポート `80` は省略できるので、与えられたシナリオでは、`http://IP_OF_YOUR_MACHINE`(ポート番号は省略)だけを入力すればよい。 diff --git a/README_zh.md b/README_zh.md index 6897af47e..700dd18c1 100644 --- a/README_zh.md +++ b/README_zh.md @@ -138,6 +138,7 @@ * Running on http://x.x.x.x:9380 INFO:werkzeug:Press CTRL+C to quit ``` + > 如果您跳过这一步系统确认步骤就登录 RAGFlow,你的浏览器有可能会提示 `network anomaly` 或 `网络异常`,因为 RAGFlow 可能并未完全启动成功。 5. 在你的浏览器中输入你的服务器对应的 IP 地址并登录 RAGFlow。 > 上面这个例子中,您只需输入 http://IP_OF_YOUR_MACHINE 即可:未改动过配置则无需输入端口(默认的 HTTP 服务端口 80)。 diff --git a/docs/faq.md b/docs/faq.md index affa9fd83..e7b13079c 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -68,24 +68,40 @@ $ docker compose up -d curl https://hf-mirror.com ``` -2. If your network works fine, the issue lies with the Docker network configuration. Adjust the Docker building accordingly: +2. If your network works fine, the issue lies with the Docker network configuration. Replace the Docker building command: +```bash +docker build -t infiniflow/ragflow:vX.Y.Z. ``` -# Original: -docker build -t infiniflow/ragflow:v0.3.0 . -# Current: -docker build -t infiniflow/ragflow:v0.3.0 . --network host + With this: +```bash +docker build -t infiniflow/ragflow:vX.Y.Z. --network host ``` -### 2. Issues with huggingface models. +### 2. Issues with huggingface models -#### 2.1 If https://huggingface.co can not be accessed - - If RAGflow is installed by docker, it will automatically download the OCR and embedding modules from Huggingface website (https://huggingface.co). - - If your computer can not access https://huggingface.co, such error will appear and PDF file parsing will fail - - FileNotFoundError: [Errno 2] No such file or directory: '/root/.cache/huggingface/hub/models--InfiniFlow--deepdoc/snapshots/be0c1e50eef6047b412d1800aa89aba4d275f997/ocr.res' - - if your computer can access https://hf-mirror.com - - cd ragflow-0.3.0/docker/; docker compose down - - replace https://huggingface.co with https://hf-mirror.com in the ragflow-0.3.0/docker/docker-compose.yml - - docker compose up -d +#### 2.1 Cannot access https://huggingface.co + +A *locally* deployed RAGflow downloads OCR and embedding modules from [Huggingface website](https://huggingface.co) by default. If your machine is unable to access this site, the following error occurs and PDF parsing fails: + +``` +FileNotFoundError: [Errno 2] No such file or directory: '/root/.cache/huggingface/hub/models--InfiniFlow--deepdoc/snapshots/be0c1e50eef6047b412d1800aa89aba4d275f997/ocr.res' +``` + To fix this issue, use https://hf-mirror.com instead: + + 1. Stop all containers and remove all related resources: + + ```bash + cd ragflow/docker/ + docker compose down + ``` + + 2. Replace `https://huggingface.co` with `https://hf-mirror.com` in **ragflow/docker/docker-compose.yml**. + + 3. Start up the server: + + ```bash + docker compose up -d + ``` #### 2.2. `MaxRetryError: HTTPSConnectionPool(host='hf-mirror.com', port=443)` @@ -152,7 +168,7 @@ You will not log in to RAGFlow unless the server is fully initialized. Run `dock #### 4.1 `dependency failed to start: container ragflow-mysql is unhealthy` -`dependency failed to start: container ragflow-mysql is unhealthy` means that your MySQL container failed to start. Try replacing `mysql:5.7.18` with `mariadb:10.5.8` in **docker-compose-base.yml** if mysql fails to start. +`dependency failed to start: container ragflow-mysql is unhealthy` means that your MySQL container failed to start. Try replacing `mysql:5.7.18` with `mariadb:10.5.8` in **docker-compose-base.yml**. #### 4.2 `Realtime synonym is disabled, since no redis connection` @@ -174,7 +190,7 @@ If your RAGFlow is deployed *locally*, try the following: ```bash docker logs -f ragflow-server ``` -2. Check if the **task_executor.py** process exist. +2. Check if the **task_executor.py** process exists. 3. Check if your RAGFlow server can access hf-mirror.com or huggingface.com.