Skip to content

Commit 00b9ce1

Browse files
infinityCuratorRAGFlow Curator
andauthored
Synchronize documentation. (#436)
Co-authored-by: RAGFlow Curator <infinitydocs.curator@users.noreply.github.com>
1 parent 2e8da10 commit 00b9ce1

File tree

1 file changed

+43
-39
lines changed

1 file changed

+43
-39
lines changed

website/docs/configurations.md

Lines changed: 43 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ docker compose -f docker/docker-compose.yml up -d
2929

3030
## Docker Compose
3131

32-
- **docker-compose.yml**
32+
- **docker-compose.yml**
3333
Sets up environment for RAGFlow and its dependencies.
34-
- **docker-compose-base.yml**
34+
- **docker-compose-base.yml**
3535
Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
3636

3737
:::danger IMPORTANT
@@ -44,97 +44,97 @@ The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file con
4444

4545
### Elasticsearch
4646

47-
- `STACK_VERSION`
47+
- `STACK_VERSION`
4848
The version of Elasticsearch. Defaults to `8.11.3`
49-
- `ES_PORT`
49+
- `ES_PORT`
5050
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`
5252
The password for Elasticsearch.
5353

5454
### Kibana
5555

56-
- `KIBANA_PORT`
56+
- `KIBANA_PORT`
5757
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`
5959
The username for Kibana. Defaults to `rag_flow`.
60-
- `KIBANA_PASSWORD`
60+
- `KIBANA_PASSWORD`
6161
The password for Kibana. Defaults to `infini_rag_flow`.
6262

6363
### Resource management
6464

65-
- `MEM_LIMIT`
65+
- `MEM_LIMIT`
6666
The maximum amount of the memory, in bytes, that *a specific* Docker container can use while running. Defaults to `8073741824`.
6767

6868
### MySQL
6969

70-
- `MYSQL_PASSWORD`
70+
- `MYSQL_PASSWORD`
7171
The password for MySQL.
72-
- `MYSQL_PORT`
72+
- `MYSQL_PORT`
7373
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`.
7474

7575
### MinIO
7676

7777
RAGFlow utilizes MinIO as its object storage solution, leveraging its scalability to store and manage all uploaded files.
7878

79-
- `MINIO_CONSOLE_PORT`
79+
- `MINIO_CONSOLE_PORT`
8080
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`
8282
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`
8484
The username for MinIO.
85-
- `MINIO_PASSWORD`
85+
- `MINIO_PASSWORD`
8686
The password for MinIO.
8787

8888
### Redis
8989

90-
- `REDIS_PORT`
90+
- `REDIS_PORT`
9191
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`
9393
The password for Redis.
9494

9595
### RAGFlow
9696

97-
- `SVR_HTTP_PORT`
97+
- `SVR_HTTP_PORT`
9898
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.
103103
- `infiniflow/ragflow:v0.21.1`: The RAGFlow Docker image with embedding models including:
104104
- Built-in embedding models:
105-
- `BAAI/bge-large-zh-v1.5`
105+
- `BAAI/bge-large-zh-v1.5`
106106
- `maidalun1020/bce-embedding-base_v1`
107107

108108

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.
111111

112-
- For the `nightly` edition:
112+
- For the `nightly` edition:
113113
- `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:nightly` or,
114114
- `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:nightly`.
115115
:::
116116

117117
### Embedding service
118118

119-
- `TEI_MODEL`
119+
- `TEI_MODEL`
120120
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`.
121121

122-
- `TEI_PORT`
122+
- `TEI_PORT`
123123
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`.
124124

125125
### Timezone
126126

127-
- `TZ`
127+
- `TZ`
128128
The local time zone. Defaults to `Asia/Shanghai`.
129129

130130
### Hugging Face mirror site
131131

132-
- `HF_ENDPOINT`
132+
- `HF_ENDPOINT`
133133
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.
134134

135135
### MacOS
136136

137-
- `MACOS`
137+
- `MACOS`
138138
Optimizations for macOS. It is disabled by default. You can uncomment this line if your OS is macOS.
139139

140140
### User registration
@@ -153,7 +153,7 @@ If you cannot download the RAGFlow Docker image, try the following mirrors.
153153
- `port`: The API server's serving port inside the Docker container. Defaults to `9380`.
154154

155155
### `mysql`
156-
156+
157157
- `name`: The MySQL database name. Defaults to `rag_flow`.
158158
- `user`: The username for MySQL.
159159
- `password`: The password for MySQL.
@@ -162,12 +162,12 @@ If you cannot download the RAGFlow Docker image, try the following mirrors.
162162
- `stale_timeout`: Timeout in seconds.
163163

164164
### `minio`
165-
165+
166166
- `user`: The username for MinIO.
167167
- `password`: The password for MinIO.
168168
- `host`: The MinIO serving IP *and* port inside the Docker container. Defaults to `minio:9000`.
169169

170-
### `oauth`
170+
### `oauth`
171171

172172
The OAuth configuration for signing up or signing in to RAGFlow using a third-party account.
173173

@@ -184,7 +184,7 @@ The OAuth configuration for signing up or signing in to RAGFlow using a third-pa
184184
- `scope`: Requested permission scope, a space-separated string. For example, `openid profile email`.
185185
- `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>`.
186186

187-
:::tip NOTE
187+
:::tip NOTE
188188
The following are best practices for configuring various third-party authentication methods. You can configure one or multiple third-party authentication methods for Ragflow:
189189
```yaml
190190
oauth:
@@ -216,9 +216,9 @@ oauth:
216216
```
217217
:::
218218
219-
### `user_default_llm`
219+
### `user_default_llm`
220220

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**.
222222

223223
- `factory`: The LLM supplier. Available options:
224224
- `"OpenAI"`
@@ -228,7 +228,11 @@ The default LLM to use for a new RAGFlow user. It is disabled by default. To ena
228228
- `"VolcEngine"`
229229
- `"ZHIPU-AI"`
230230
- `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"`
231235

232-
:::tip NOTE
236+
:::tip NOTE
233237
If you do not set the default LLM here, configure the default LLM on the **Settings** page in the RAGFlow UI.
234-
:::
238+
:::

0 commit comments

Comments
 (0)