update docs to reflect latest deployment flow (#124)

* update docs to reflect latest deployment flow

* Update link to docker compose deployment readme
pull/126/head
Chenhe Gu 2024-06-29 00:53:59 +08:00 committed by GitHub
parent 16ca4c95f5
commit c75adfa09e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 5 deletions

View File

@ -8,6 +8,12 @@
| Linux platforms | <p>Docker 19.03 or later<br>Docker Compose 1.25.1 or later</p> | Please refer to the [Docker installation guide](https://docs.docker.com/engine/install/) and [the Docker Compose installation guide](https://docs.docker.com/compose/install/) for more information on how to install Docker and Docker Compose, respectively. |
| Windows with WSL 2 enabled | Docker Desktop | We recommend storing the source code and other data that is bound to Linux containers in the Linux file system rather than the Windows file system. For more information, please refer to the [Docker Desktop installation guide for using the WSL 2 backend on Windows.](https://docs.docker.com/desktop/windows/install/#wsl-2-backend) |
> [!IMPORTANT]
>
> Dify 0.6.12 has introduced significant enhancements to Docker Compose deployment, designed to improve your setup and update experience. For more information, read the [README.md](https://github.com/langgenius/dify/blob/main/docker/README.md).
### Clone Dify
Clone the Dify source code to your local machine:
@ -22,6 +28,7 @@ Navigate to the docker directory in the Dify source code and execute the followi
```bash
cd dify/docker
cp .env.example .env
docker compose up -d
```
@ -46,7 +53,7 @@ Finally, check if all containers are running successfully:
docker compose ps
```
This includes 3 business services: api / worker / web, and 4 underlying components: weaviate / db / redis / nginx.
This includes 3 core services: api / worker / web, and 4 dependent components: weaviate / db / redis / nginx.
```bash
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
@ -77,10 +84,11 @@ Finally, access [http://localhost/install](http://localhost/install) to use the
### Customize Dify
The full set of environment variables can be found under docker/dotenvs. To change their values, delete the `.example` suffix from the corresponding `.env.example` file name and edit the values in file directly. Then, restart Dify with:
Edit the environment variable values in your `.env` file directly. Then, restart Dify with:
```
docker compose down
docker compose up -d
```
The full set of annotated environment variables along can be found under docker/.env.example.

View File

@ -20,6 +20,7 @@ Before enabling business services, we need to first deploy PostgresSQL / Redis /
```Bash
cd docker
cp middleware.env.example middleware.env
docker compose -f docker-compose.middleware.yaml up -d
```
@ -123,7 +124,7 @@ conda activate dify
.> dataset exchange=dataset(direct) key=dataset
.> generation exchange=generation(direct) key=generation
.> mail exchange=mail(direct) key=mail
[tasks]
. tasks.add_document_to_index_task.add_document_to_index_task
. tasks.clean_dataset_task.clean_dataset_task
@ -141,7 +142,7 @@ conda activate dify
. tasks.remove_segment_from_index_task.remove_segment_from_index_task
. tasks.update_segment_index_task.update_segment_index_task
. tasks.update_segment_keyword_index_task.update_segment_keyword_index_task
[2023-07-31 12:58:08,831: INFO/MainProcess] Connected to redis://:**@localhost:6379/1
[2023-07-31 12:58:08,840: INFO/MainProcess] mingle: searching for neighbors
[2023-07-31 12:58:09,873: INFO/MainProcess] mingle: all alone
@ -190,7 +191,7 @@ Please visit [https://nodejs.org/en/download](https://nodejs.org/en/download) an
# console or api domain.
# example: http://udify.app/api
NEXT_PUBLIC_PUBLIC_API_PREFIX=http://localhost:5001/api
# SENTRY
NEXT_PUBLIC_SENTRY_DSN=
NEXT_PUBLIC_SENTRY_ORG=