You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/configurations.md
+43-39Lines changed: 43 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,9 +29,9 @@ docker compose -f docker/docker-compose.yml up -d
29
29
30
30
## Docker Compose
31
31
32
-
-**docker-compose.yml**
32
+
-**docker-compose.yml**
33
33
Sets up environment for RAGFlow and its dependencies.
34
-
-**docker-compose-base.yml**
34
+
-**docker-compose-base.yml**
35
35
Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
36
36
37
37
:::danger IMPORTANT
@@ -44,97 +44,97 @@ The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file con
44
44
45
45
### Elasticsearch
46
46
47
-
-`STACK_VERSION`
47
+
-`STACK_VERSION`
48
48
The version of Elasticsearch. Defaults to `8.11.3`
49
-
-`ES_PORT`
49
+
-`ES_PORT`
50
50
The port used to expose the Elasticsearch service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `1200`.
51
-
-`ELASTIC_PASSWORD`
51
+
-`ELASTIC_PASSWORD`
52
52
The password for Elasticsearch.
53
53
54
54
### Kibana
55
55
56
-
-`KIBANA_PORT`
56
+
-`KIBANA_PORT`
57
57
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`.
58
-
-`KIBANA_USER`
58
+
-`KIBANA_USER`
59
59
The username for Kibana. Defaults to `rag_flow`.
60
-
-`KIBANA_PASSWORD`
60
+
-`KIBANA_PASSWORD`
61
61
The password for Kibana. Defaults to `infini_rag_flow`.
62
62
63
63
### Resource management
64
64
65
-
-`MEM_LIMIT`
65
+
-`MEM_LIMIT`
66
66
The maximum amount of the memory, in bytes, that *a specific* Docker container can use while running. Defaults to `8073741824`.
67
67
68
68
### MySQL
69
69
70
-
-`MYSQL_PASSWORD`
70
+
-`MYSQL_PASSWORD`
71
71
The password for MySQL.
72
-
-`MYSQL_PORT`
72
+
-`MYSQL_PORT`
73
73
The port used to expose the MySQL service to the host machine, allowing **external** access to the MySQL database running inside the Docker container. Defaults to `5455`.
74
74
75
75
### MinIO
76
76
77
77
RAGFlow utilizes MinIO as its object storage solution, leveraging its scalability to store and manage all uploaded files.
78
78
79
-
-`MINIO_CONSOLE_PORT`
79
+
-`MINIO_CONSOLE_PORT`
80
80
The port used to expose the MinIO console interface to the host machine, allowing **external** access to the web-based console running inside the Docker container. Defaults to `9001`
81
-
-`MINIO_PORT`
81
+
-`MINIO_PORT`
82
82
The port used to expose the MinIO API service to the host machine, allowing **external** access to the MinIO object storage service running inside the Docker container. Defaults to `9000`.
83
-
-`MINIO_USER`
83
+
-`MINIO_USER`
84
84
The username for MinIO.
85
-
-`MINIO_PASSWORD`
85
+
-`MINIO_PASSWORD`
86
86
The password for MinIO.
87
87
88
88
### Redis
89
89
90
-
-`REDIS_PORT`
90
+
-`REDIS_PORT`
91
91
The port used to expose the Redis service to the host machine, allowing **external** access to the Redis service running inside the Docker container. Defaults to `6379`.
92
-
-`REDIS_PASSWORD`
92
+
-`REDIS_PASSWORD`
93
93
The password for Redis.
94
94
95
95
### RAGFlow
96
96
97
-
-`SVR_HTTP_PORT`
97
+
-`SVR_HTTP_PORT`
98
98
The port used to expose RAGFlow's HTTP API service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `9380`.
99
-
-`RAGFLOW-IMAGE`
100
-
The Docker image edition. Available editions:
101
-
102
-
-`infiniflow/ragflow:v0.21.1-slim` (default): The RAGFlow Docker image without embedding models.
99
+
-`RAGFLOW-IMAGE`
100
+
The Docker image edition. Available editions:
101
+
102
+
-`infiniflow/ragflow:v0.21.1-slim` (default): The RAGFlow Docker image without embedding models.
103
103
-`infiniflow/ragflow:v0.21.1`: The RAGFlow Docker image with embedding models including:
104
104
- Built-in embedding models:
105
-
-`BAAI/bge-large-zh-v1.5`
105
+
-`BAAI/bge-large-zh-v1.5`
106
106
-`maidalun1020/bce-embedding-base_v1`
107
107
108
108
109
-
:::tip NOTE
110
-
If you cannot download the RAGFlow Docker image, try the following mirrors.
109
+
:::tip NOTE
110
+
If you cannot download the RAGFlow Docker image, try the following mirrors.
The embedding model which text-embeddings-inference serves. Allowed values are one of `Qwen/Qwen3-Embedding-0.6B`(default), `BAAI/bge-m3`, and `BAAI/bge-small-en-v1.5`.
121
121
122
-
-`TEI_PORT`
122
+
-`TEI_PORT`
123
123
The port used to expose the text-embeddings-inference service to the host machine, allowing **external** access to the text-embeddings-inference service running inside the Docker container. Defaults to `6380`.
124
124
125
125
### Timezone
126
126
127
-
-`TZ`
127
+
-`TZ`
128
128
The local time zone. Defaults to `Asia/Shanghai`.
129
129
130
130
### Hugging Face mirror site
131
131
132
-
-`HF_ENDPOINT`
132
+
-`HF_ENDPOINT`
133
133
The mirror site for huggingface.co. It is disabled by default. You can uncomment this line if you have limited access to the primary Hugging Face domain.
134
134
135
135
### MacOS
136
136
137
-
-`MACOS`
137
+
-`MACOS`
138
138
Optimizations for macOS. It is disabled by default. You can uncomment this line if your OS is macOS.
139
139
140
140
### User registration
@@ -153,7 +153,7 @@ If you cannot download the RAGFlow Docker image, try the following mirrors.
153
153
-`port`: The API server's serving port inside the Docker container. Defaults to `9380`.
154
154
155
155
### `mysql`
156
-
156
+
157
157
-`name`: The MySQL database name. Defaults to `rag_flow`.
158
158
-`user`: The username for MySQL.
159
159
-`password`: The password for MySQL.
@@ -162,12 +162,12 @@ If you cannot download the RAGFlow Docker image, try the following mirrors.
162
162
-`stale_timeout`: Timeout in seconds.
163
163
164
164
### `minio`
165
-
165
+
166
166
-`user`: The username for MinIO.
167
167
-`password`: The password for MinIO.
168
168
-`host`: The MinIO serving IP *and* port inside the Docker container. Defaults to `minio:9000`.
169
169
170
-
### `oauth`
170
+
### `oauth`
171
171
172
172
The OAuth configuration for signing up or signing in to RAGFlow using a third-party account.
173
173
@@ -184,7 +184,7 @@ The OAuth configuration for signing up or signing in to RAGFlow using a third-pa
184
184
-`scope`: Requested permission scope, a space-separated string. For example, `openid profile email`.
185
185
-`redirect_uri`: Required, URI to which the authorization server redirects during the authentication flow to return results. Must match the callback URI registered with the authentication server. Format: `https://your-app.com/v1/user/oauth/callback/<channel>`. For local configuration, you can directly use `http://127.0.0.1:80/v1/user/oauth/callback/<channel>`.
186
186
187
-
:::tip NOTE
187
+
:::tip NOTE
188
188
The following are best practices for configuring various third-party authentication methods. You can configure one or multiple third-party authentication methods for Ragflow:
189
189
```yaml
190
190
oauth:
@@ -216,9 +216,9 @@ oauth:
216
216
```
217
217
:::
218
218
219
-
### `user_default_llm`
219
+
### `user_default_llm`
220
220
221
-
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.template**.
221
+
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.template**.
222
222
223
223
- `factory`: The LLM supplier. Available options:
224
224
- `"OpenAI"`
@@ -228,7 +228,11 @@ The default LLM to use for a new RAGFlow user. It is disabled by default. To ena
228
228
- `"VolcEngine"`
229
229
- `"ZHIPU-AI"`
230
230
- `api_key`: The API key for the specified LLM. You will need to apply for your model API key online.
231
+
- `allowed_factories`: If this is set, the users will be allowed to add only the factories in this list.
232
+
- `"OpenAI"`
233
+
- `"DeepSeek"`
234
+
- `"Moonshot"`
231
235
232
-
:::tip NOTE
236
+
:::tip NOTE
233
237
If you do not set the default LLM here, configure the default LLM on the **Settings** page in the RAGFlow UI.
0 commit comments