writinwaters commited on
Commit
d102a8b
Β·
1 Parent(s): ff43695

Updated Docker README (#3272)

Browse files

### What problem does this PR solve?


### Type of change

- [x] Documentation Update

Files changed (1) hide show
  1. docker/README.md +20 -19
docker/README.md CHANGED
@@ -1,7 +1,7 @@
1
  # README
2
 
3
  <details open>
4
- <summary></b>πŸ“• Table of Contents</b></summary>
5
 
6
  - 🐳 [Docker Compose](#-docker-compose)
7
  - 🐬 [Docker environment variables](#-docker-environment-variables)
@@ -30,7 +30,7 @@ The [.env](./.env) file contains important environment variables for Docker.
30
  ### Kibana
31
 
32
  - `KIBANA_PORT`
33
- The port used to expose the Kibana service to the host machine. Defaults to `6601`.
34
  - `KIBANA_USER`
35
  The username for Kibana. Defaults to `rag_flow`.
36
  - `KIBANA_PASSWORD`
@@ -39,7 +39,7 @@ The [.env](./.env) file contains important environment variables for Docker.
39
  ### Resource management
40
 
41
  - `MEM_LIMIT`
42
- The maximum amount of the memory that *a specific* Docker container can use while running. Defaults to `8073741824`.
43
 
44
  ### MySQL
45
 
@@ -90,15 +90,16 @@ The [.env](./.env) file contains important environment variables for Docker.
90
  - `nomic-ai/nomic-embed-text-v1.5`
91
  - `sentence-transformers/all-MiniLM-L6-v2`
92
 
93
- > [!TIP]
94
- >
95
- > If you cannot download the RAGFlow Docker image, try the following mirrors.
96
- > - For `dev-slim`:
97
- > - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or,
98
- > - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`.
99
- > - For `dev`:
100
- > - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or,
101
- > - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`.
 
102
 
103
  ### Miscellaneous
104
 
@@ -126,12 +127,12 @@ The [.env](./.env) file contains important environment variables for Docker.
126
  - `password`: The password for MinIO. When updated, you must revise the `MINIO_PASSWORD` variable in [.env](./.env) accordingly.
127
  - `host`: The MinIO serving IP *and* port **inside** the Docker container. Defaults to `minio:9000`.
128
 
 
 
 
 
129
  - `user_default_llm`
130
  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**.
131
-
132
- > [!TIP]
133
- >
134
- > If you do not set the default LLM here, configure the default LLM on the **Settings** page in the RAGFlow UI.
135
  - `factory`: The LLM supplier. Available options:
136
  - `"OpenAI"`
137
  - `"DeepSeek"`
@@ -140,6 +141,6 @@ The [.env](./.env) file contains important environment variables for Docker.
140
  - `"VolcEngine"`
141
  - `"ZHIPU-AI"`
142
  - `api_key`: The API key for the specified LLM. You will need to apply for your model API key online.
143
- - `oauth`
144
- 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**.
145
- - `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.
 
1
  # README
2
 
3
  <details open>
4
+ <summary></b>πŸ“— Table of Contents</b></summary>
5
 
6
  - 🐳 [Docker Compose](#-docker-compose)
7
  - 🐬 [Docker environment variables](#-docker-environment-variables)
 
30
  ### Kibana
31
 
32
  - `KIBANA_PORT`
33
+ 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`.
34
  - `KIBANA_USER`
35
  The username for Kibana. Defaults to `rag_flow`.
36
  - `KIBANA_PASSWORD`
 
39
  ### Resource management
40
 
41
  - `MEM_LIMIT`
42
+ The maximum amount of the memory, in bytes, that *a specific* Docker container can use while running. Defaults to `8073741824`.
43
 
44
  ### MySQL
45
 
 
90
  - `nomic-ai/nomic-embed-text-v1.5`
91
  - `sentence-transformers/all-MiniLM-L6-v2`
92
 
93
+ > [!TIP]
94
+ > If you cannot download the RAGFlow Docker image, try the following mirrors.
95
+ > For `dev-slim`:
96
+ >
97
+ > - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or,
98
+ > - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`.
99
+ > For `dev`:
100
+ >
101
+ > - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or,
102
+ > - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`.
103
 
104
  ### Miscellaneous
105
 
 
127
  - `password`: The password for MinIO. When updated, you must revise the `MINIO_PASSWORD` variable in [.env](./.env) accordingly.
128
  - `host`: The MinIO serving IP *and* port **inside** the Docker container. Defaults to `minio:9000`.
129
 
130
+ - `oauth`
131
+ 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**.
132
+ - `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.
133
+
134
  - `user_default_llm`
135
  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**.
 
 
 
 
136
  - `factory`: The LLM supplier. Available options:
137
  - `"OpenAI"`
138
  - `"DeepSeek"`
 
141
  - `"VolcEngine"`
142
  - `"ZHIPU-AI"`
143
  - `api_key`: The API key for the specified LLM. You will need to apply for your model API key online.
144
+
145
+ > [!TIP]
146
+ > If you do not set the default LLM here, configure the default LLM on the **Settings** page in the RAGFlow UI.