Skip to content

Commit f5f31a7

Browse files
author
Riskey
committed
changes after review
1 parent 2805cfd commit f5f31a7

7 files changed

Lines changed: 195 additions & 192 deletions

File tree

en/self-host/configuration/environments.mdx

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -116,20 +116,18 @@ Only effective when starting with docker image or docker-compose.
116116
- GUNICORN_TIMEOUT: Request handling timeout. Default is 200. Recommended value is 360 to support longer SSE (Server-Sent Events) connection times.
117117
- CELERY_WORKER_CLASS: Similar to `SERVER_WORKER_CLASS`. Default is gevent. If using windows, it can be switched to sync or solo.
118118
- CELERY_WORKER_AMOUNT: The number of Celery workers. The default is 1, and can be set as needed.
119-
- HTTP_PROXY: HTTP proxy address, used to solve the problem of accessing OpenAI and HuggingFace in China. Note that if the proxy is deployed on the host machine (e.g. `http://127.0.0.1:7890`), the proxy address should be the same as when connecting to a local model, using the host machine address inside the Docker container (e.g. `http://192.168.1.100:7890` or `http://172.17.0.1:7890`).
120-
- HTTPS_PROXY: HTTPS proxy address, used to solve the problem of accessing OpenAI and HuggingFace in China. Same as above.
121-
- COMPOSE_PROFILES: Selectively start service groups. The default value is `${VECTOR_STORE:-weaviate},${DB_TYPE:-postgresql}`, which will be automatically assigned by `VECTOR_STORE` and `DB_TYPE`. Generally, no adjustment is needed, only when the metadata selection is oceanbase or seekdb, or the vector database selection is seekdb, manual adjustment is required.
119+
- COMPOSE_PROFILES: Selectively start service groups. The default value is `${VECTOR_STORE:-weaviate},${DB_TYPE:-postgresql}`, which is automatically derived from `VECTOR_STORE` and `DB_TYPE`.
122120

123121
### Database Configuration
124122

125123
The database uses PostgreSQL. Please use the public schema.
126124

127-
- DB_TYPE: Database type. Default is postgresql.
125+
- DB_TYPE: Database type.
128126

129-
**Available enumeration types include:**
127+
Available values include:
130128

131-
- `postgresql`
132-
- `mysql` (other mysql-compatible databases can also use this value. Example: OceanBase, seekdb, etc.)
129+
- `postgresql`(default)
130+
- `mysql` (MySQL-compatible databases like OceanBase and seekdb can also use this value)
133131

134132
- DB_USERNAME: username
135133
- DB_PASSWORD: password
@@ -252,18 +250,18 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi
252250

253251
- VECTOR_STORE
254252

255-
**Available enumeration types include:**
253+
Available values include:
256254

257255
- `weaviate`
258-
- `oceanbase`
259-
- `seekdb` (share the same configuration as `oceanbase`)
260256
- `qdrant`
261257
- `milvus`
262258
- `zilliz` (share the same configuration as `milvus`)
263259
- `myscale`
264260
- `pinecone` (not yet open)
265261
- `analyticdb`
266262
- `couchbase`
263+
- `oceanbase`
264+
- `seekdb` (share the same configuration as `oceanbase`)
267265
- `tablestore`
268266
- `lindorm`
269267
- `tencent`
@@ -287,38 +285,6 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi
287285

288286
Whether to use the gRPC method to interact with Weaviate, performance will greatly increase when enabled, may not be usable locally, default is true.
289287

290-
- OCEANBASE_VECTOR_HOST
291-
292-
The hostname or IP address of OceanBase vector database.
293-
294-
- OCEANBASE_VECTOR_PORT
295-
296-
The port of OceanBase vector database.
297-
298-
- OCEANBASE_VECTOR_USER
299-
300-
The username of OceanBase vector database.
301-
302-
- OCEANBASE_VECTOR_PASSWORD
303-
304-
The password of OceanBase vector database user.
305-
306-
- OCEANBASE_VECTOR_DATABASE
307-
308-
The database name of OceanBase vector database.
309-
310-
- OCEANBASE_CLUSTER_NAME
311-
312-
The cluster name of OceanBase vector database, only available for Docker deployment.
313-
314-
- OCEANBASE_MEMORY_LIMIT
315-
316-
The memory limit of OceanBase vector database, only available for Docker deployment.
317-
318-
- SEEKDB_MEMORY_LIMIT
319-
320-
The memory limit of Seekdb, only available for Docker deployment.
321-
322288
- QDRANT_URL
323289

324290
Qdrant endpoint address, such as: `https://your-qdrant-cluster-url.qdrant.tech/`
@@ -427,6 +393,38 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi
427393

428394
The name of the scope to use.
429395

396+
- OCEANBASE_VECTOR_HOST
397+
398+
The hostname or IP address of OceanBase vector database.
399+
400+
- OCEANBASE_VECTOR_PORT
401+
402+
The port of OceanBase vector database.
403+
404+
- OCEANBASE_VECTOR_USER
405+
406+
The username of OceanBase vector database.
407+
408+
- OCEANBASE_VECTOR_PASSWORD
409+
410+
The password of OceanBase vector database user.
411+
412+
- OCEANBASE_VECTOR_DATABASE
413+
414+
The database name of OceanBase vector database.
415+
416+
- OCEANBASE_CLUSTER_NAME
417+
418+
The cluster name of OceanBase vector database, only available for Docker deployment.
419+
420+
- OCEANBASE_MEMORY_LIMIT
421+
422+
The memory limit of OceanBase vector database, only available for Docker deployment.
423+
424+
- SEEKDB_MEMORY_LIMIT
425+
426+
The memory limit of seekdb, only available for Docker deployment.
427+
430428
- TABLESTORE_ENDPOINT
431429

432430
The endpoint address of the TableStore server (e.g. 'https://instance-name.cn-hangzhou.ots.aliyuncs.com')
@@ -545,7 +543,7 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi
545543
- UPLOAD_FILE_BATCH_LIMIT: The maximum number of files that can be uploaded at a time, default 5.
546544
- ETL_TYPE
547545

548-
**Available enumeration types include:**
546+
Available values include
549547

550548
- dify: Dify's proprietary file extraction scheme
551549
- Unstructured: Unstructured.io file extraction scheme

en/self-host/quick-start/docker-compose.mdx

Lines changed: 50 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ title: Docker Compose
4040
</tbody>
4141
</table>
4242

43-
### Clone Dify
43+
## Clone Dify
4444

4545
Clone the Dify source code to your local machine:
4646

4747
```bash
4848
git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git
4949
```
5050

51-
### Starting Dify
51+
## Start Dify
5252

5353
1. Navigate to the Docker directory in the Dify source code
5454

@@ -81,51 +81,51 @@ git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/relea
8181
docker-compose up -d
8282
```
8383

84-
After executing the command, you should see output similar to the following, showing the status and port mappings of all containers:
84+
After executing the command, you should see output similar to the following, showing the status and start time of all containers:
8585

86-
```bash
87-
[+] Running 13/13
88-
✔ Network docker_ssrf_proxy_network Created 10.0s
89-
✔ Network docker_default Created 0.1s
90-
✔ Container docker-sandbox-1 Started 0.3s
91-
✔ Container docker-db_postgres-1 Healthy 2.8s
92-
✔ Container docker-web-1 Started 0.3s
93-
✔ Container docker-redis-1 Started 0.3s
94-
✔ Container docker-ssrf_proxy-1 Started 0.4s
95-
✔ Container docker-weaviate-1 Started 0.3s
96-
✔ Container docker-worker_beat-1 Started 3.2s
97-
✔ Container docker-api-1 Started 3.2s
98-
✔ Container docker-worker-1 Started 3.2s
99-
✔ Container docker-plugin_daemon-1 Started 3.2s
100-
✔ Container docker-nginx-1 Started 3.4s
101-
```
86+
```bash
87+
[+] Running 13/13
88+
✔ Network docker_ssrf_proxy_network Created 10.0s
89+
✔ Network docker_default Created 0.1s
90+
✔ Container docker-sandbox-1 Started 0.3s
91+
✔ Container docker-db_postgres-1 Healthy 2.8s
92+
✔ Container docker-web-1 Started 0.3s
93+
✔ Container docker-redis-1 Started 0.3s
94+
✔ Container docker-ssrf_proxy-1 Started 0.4s
95+
✔ Container docker-weaviate-1 Started 0.3s
96+
✔ Container docker-worker_beat-1 Started 3.2s
97+
✔ Container docker-api-1 Started 3.2s
98+
✔ Container docker-worker-1 Started 3.2s
99+
✔ Container docker-plugin_daemon-1 Started 3.2s
100+
✔ Container docker-nginx-1 Started 3.4s
101+
```
102102

103-
Finally, check if all containers are running successfully:
103+
5. Check if all containers are running successfully
104104

105-
```bash
106-
docker compose ps
107-
```
105+
```bash
106+
docker compose ps
107+
```
108108

109-
This includes 5 core services: `api / worker / worker_beat / web / plugin_daemon`, and 6 dependent components: `weaviate / db_postgres / redis / nginx / ssrf_proxy / sandbox` .
109+
This includes 5 core services: `api / worker / worker_beat / web / plugin_daemon`, and 6 dependent components: `weaviate / db_postgres / redis / nginx / ssrf_proxy / sandbox` .
110110

111-
```bash
112-
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
113-
docker-api-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" api 26 seconds ago Up 22 seconds 5001/tcp
114-
docker-db_postgres-1 postgres:15-alpine "docker-entrypoint.s…" db_postgres 26 seconds ago Up 25 seconds (healthy) 5432/tcp
115-
docker-nginx-1 nginx:latest "sh -c 'cp /docker-e…" nginx 26 seconds ago Up 22 seconds 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp
116-
docker-plugin_daemon-1 langgenius/dify-plugin-daemon:0.4.1-local "/bin/bash -c /app/e…" plugin_daemon 26 seconds ago Up 22 seconds 0.0.0.0:5003->5003/tcp, :::5003->5003/tcp
117-
docker-redis-1 redis:6-alpine "docker-entrypoint.s…" redis 26 seconds ago Up 25 seconds (health: starting) 6379/tcp
118-
docker-sandbox-1 langgenius/dify-sandbox:0.2.12 "/main" sandbox 26 seconds ago Up 25 seconds (health: starting)
119-
docker-ssrf_proxy-1 ubuntu/squid:latest "sh -c 'cp /docker-e…" ssrf_proxy 26 seconds ago Up 25 seconds 3128/tcp
120-
docker-weaviate-1 semitechnologies/weaviate:1.27.0 "/bin/weaviate --hos…" weaviate 26 seconds ago Up 25 seconds
121-
docker-web-1 langgenius/dify-web:1.10.1 "/bin/sh ./entrypoin…" web 26 seconds ago Up 25 seconds 3000/tcp
122-
docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp
123-
docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp
124-
```
111+
```bash
112+
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
113+
docker-api-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" api 26 seconds ago Up 22 seconds 5001/tcp
114+
docker-db_postgres-1 postgres:15-alpine "docker-entrypoint.s…" db_postgres 26 seconds ago Up 25 seconds (healthy) 5432/tcp
115+
docker-nginx-1 nginx:latest "sh -c 'cp /docker-e…" nginx 26 seconds ago Up 22 seconds 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp
116+
docker-plugin_daemon-1 langgenius/dify-plugin-daemon:0.4.1-local "/bin/bash -c /app/e…" plugin_daemon 26 seconds ago Up 22 seconds 0.0.0.0:5003->5003/tcp, :::5003->5003/tcp
117+
docker-redis-1 redis:6-alpine "docker-entrypoint.s…" redis 26 seconds ago Up 25 seconds (health: starting) 6379/tcp
118+
docker-sandbox-1 langgenius/dify-sandbox:0.2.12 "/main" sandbox 26 seconds ago Up 25 seconds (health: starting)
119+
docker-ssrf_proxy-1 ubuntu/squid:latest "sh -c 'cp /docker-e…" ssrf_proxy 26 seconds ago Up 25 seconds 3128/tcp
120+
docker-weaviate-1 semitechnologies/weaviate:1.27.0 "/bin/weaviate --hos…" weaviate 26 seconds ago Up 25 seconds
121+
docker-web-1 langgenius/dify-web:1.10.1 "/bin/sh ./entrypoin…" web 26 seconds ago Up 25 seconds 3000/tcp
122+
docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp
123+
docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp
124+
```
125125

126126
With these steps, you should be able to install Dify successfully.
127127

128-
### Upgrade Dify
128+
## Upgrade Dify
129129

130130
Enter the docker directory of the dify source code and execute the following commands:
131131

@@ -137,12 +137,13 @@ docker compose pull
137137
docker compose up -d
138138
```
139139

140-
#### Sync Environment Variable Configuration (Important)
140+
<Note>
141+
* If the `.env.example` file has been updated, be sure to modify your local `.env` file accordingly.
141142

142-
* If the `.env.example` file has been updated, be sure to modify your local `.env` file accordingly.
143-
* Check and modify the configuration items in the `.env` file as needed to ensure they match your actual environment. You may need to add any new variables from `.env.example` to your `.env` file, and update any values that have changed.
143+
* Check and modify the configuration items in the `.env` file as needed to ensure they match your actual environment. You may need to add any new variables from `.env.example` to your `.env` file, and update any values that have changed.
144+
</Note>
144145

145-
### Access Dify
146+
## Access Dify
146147

147148
Access administrator initialization page to set up the admin account:
148149

@@ -164,19 +165,19 @@ http://localhost
164165
http://your_server_ip
165166
```
166167

167-
### Customize Dify
168+
## Customize Dify
168169

169170
Edit the environment variable values in your `.env` file directly. Then, restart Dify with:
170171

171-
You can switch the metadata database by modifying `DB_TYPE` and switch the vector database by modifying `VECTOR_STORE`. For more information, please refer to the [environment variables](https://docs.dify.ai/en/self-host/configuration/environments).
172-
173172
```
174173
docker compose down
175174
docker compose up -d
176175
```
177176

178-
The full set of annotated environment variables along can be found under docker/.env.example.
177+
<Tip>
178+
The full set of annotated environment variables along can be found under `docker/.env.example`. For more information, see [environment variables](/en/self-host/configuration/environments).
179+
</Tip>
179180

180-
### Read More
181+
## Read More
181182

182-
If you have any questions, please refer to [FAQs](/en/self-host/quick-start/faqs).
183+
If you have any questions, see [FAQs](/en/self-host/quick-start/faqs).

en/self-host/quick-start/faqs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: FAQs
99
Use the `--branch` flag to install a specific version:
1010

1111
```bash
12-
git clone https://github.com/langgenius/dify.git --branch 1.10.1
12+
git clone https://github.com/langgenius/dify.git --branch 0.15.3
1313
```
1414

1515
The rest of the setup is identical to installing the latest version.

0 commit comments

Comments
 (0)