From 6dd7c0a44bc17e3a546f7fffeaef8d32979aa3c8 Mon Sep 17 00:00:00 2001 From: writinwaters Date: Thu, 7 Nov 2024 19:54:31 +0800 Subject: [PATCH 1/5] Updated Docker README --- docker/README.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/docker/README.md b/docker/README.md index b3735a1c2a8..2f5d0cf4b1f 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,7 +1,7 @@ # README
-📕 Table of Contents +📗 Table of Contents - 🐳 [Docker Compose](#-docker-compose) - 🐬 [Docker environment variables](#-docker-environment-variables) @@ -90,15 +90,14 @@ The [.env](./.env) file contains important environment variables for Docker. - `nomic-ai/nomic-embed-text-v1.5` - `sentence-transformers/all-MiniLM-L6-v2` - > [!TIP] - > - > If you cannot download the RAGFlow Docker image, try the following mirrors. - > - For `dev-slim`: - > - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or, - > - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`. - > - For `dev`: - > - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or, - > - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`. +> [!TIP] +> If you cannot download the RAGFlow Docker image, try the following mirrors. +> - For `dev-slim`: +> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or, +> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`. +> - For `dev`: +> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or, +> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`. ### Miscellaneous @@ -126,12 +125,12 @@ The [.env](./.env) file contains important environment variables for Docker. - `password`: The password for MinIO. When updated, you must revise the `MINIO_PASSWORD` variable in [.env](./.env) accordingly. - `host`: The MinIO serving IP *and* port **inside** the Docker container. Defaults to `minio:9000`. +- `oauth` + The OAuth configuration for signing up or signing in to RAGFlow using a third-party account. It is disabled by default. To enable this feature, uncomment the corresponding lines in **service_conf.yaml**. + - `github`: The GitHub authentication settings for your application. Visit the [Github Developer Settings page](https://github.com/settings/developers) to obtain your client_id and secret_key. + - `user_default_llm` The default LLM to use for a new RAGFlow user. It is disabled by default. To enable this feature, uncomment the corresponding lines in **service_conf.yaml**. - - > [!TIP] - > - > If you do not set the default LLM here, configure the default LLM on the **Settings** page in the RAGFlow UI. - `factory`: The LLM supplier. Available options: - `"OpenAI"` - `"DeepSeek"` @@ -140,6 +139,6 @@ The [.env](./.env) file contains important environment variables for Docker. - `"VolcEngine"` - `"ZHIPU-AI"` - `api_key`: The API key for the specified LLM. You will need to apply for your model API key online. -- `oauth` - The OAuth configuration for signing up or signing in to RAGFlow using a third-party account. It is disabled by default. To enable this feature, uncomment the corresponding lines in **service_conf.yaml**. - - `github`: The GitHub authentication settings for your application. Visit the [Github Developer Settings page](https://github.com/settings/developers) to obtain your client_id and secret_key. + +> [!TIP] +> If you do not set the default LLM here, configure the default LLM on the **Settings** page in the RAGFlow UI. From bbe1962aa05c6234905c6e3e540ab36d2c5aea64 Mon Sep 17 00:00:00 2001 From: writinwaters Date: Thu, 7 Nov 2024 19:56:07 +0800 Subject: [PATCH 2/5] minor --- docker/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docker/README.md b/docker/README.md index 2f5d0cf4b1f..1f29ba80f25 100644 --- a/docker/README.md +++ b/docker/README.md @@ -93,11 +93,11 @@ The [.env](./.env) file contains important environment variables for Docker. > [!TIP] > If you cannot download the RAGFlow Docker image, try the following mirrors. > - For `dev-slim`: -> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or, -> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`. +> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or, +> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`. > - For `dev`: -> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or, -> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`. +> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or, +> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`. ### Miscellaneous From 55bab50025a58c1283dc86be23ba2cf7f24bc595 Mon Sep 17 00:00:00 2001 From: writinwaters Date: Thu, 7 Nov 2024 19:57:09 +0800 Subject: [PATCH 3/5] minor --- docker/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docker/README.md b/docker/README.md index 1f29ba80f25..1beb96779d2 100644 --- a/docker/README.md +++ b/docker/README.md @@ -92,10 +92,10 @@ The [.env](./.env) file contains important environment variables for Docker. > [!TIP] > If you cannot download the RAGFlow Docker image, try the following mirrors. -> - For `dev-slim`: +> For `dev-slim`: > - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or, > - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`. -> - For `dev`: +> For `dev`: > - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or, > - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`. From 6795421c64db1853bc59887a0f2f049b223269a4 Mon Sep 17 00:00:00 2001 From: writinwaters Date: Thu, 7 Nov 2024 19:58:28 +0800 Subject: [PATCH 4/5] minor --- docker/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docker/README.md b/docker/README.md index 1beb96779d2..09ccc339649 100644 --- a/docker/README.md +++ b/docker/README.md @@ -93,11 +93,13 @@ The [.env](./.env) file contains important environment variables for Docker. > [!TIP] > If you cannot download the RAGFlow Docker image, try the following mirrors. > For `dev-slim`: -> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or, -> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`. +> +> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or, +> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`. > For `dev`: -> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or, -> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`. +> +> - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or, +> - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`. ### Miscellaneous From b382368f827457a5a2fc42e63784c38446449327 Mon Sep 17 00:00:00 2001 From: writinwaters Date: Thu, 7 Nov 2024 20:05:20 +0800 Subject: [PATCH 5/5] minor --- docker/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docker/README.md b/docker/README.md index 09ccc339649..057e7b7f1c1 100644 --- a/docker/README.md +++ b/docker/README.md @@ -30,7 +30,7 @@ The [.env](./.env) file contains important environment variables for Docker. ### Kibana - `KIBANA_PORT` - The port used to expose the Kibana service to the host machine. Defaults to `6601`. + The port used to expose the Kibana service to the host machine, allowing external access to the service running **inside** the Docker container. Defaults to `6601`. - `KIBANA_USER` The username for Kibana. Defaults to `rag_flow`. - `KIBANA_PASSWORD` @@ -39,7 +39,7 @@ The [.env](./.env) file contains important environment variables for Docker. ### Resource management - `MEM_LIMIT` - The maximum amount of the memory that *a specific* Docker container can use while running. Defaults to `8073741824`. + The maximum amount of the memory, in bytes, that *a specific* Docker container can use while running. Defaults to `8073741824`. ### MySQL @@ -93,7 +93,7 @@ The [.env](./.env) file contains important environment variables for Docker. > [!TIP] > If you cannot download the RAGFlow Docker image, try the following mirrors. > For `dev-slim`: -> +> > - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or, > - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`. > For `dev`: