|
@@ -2,6 +2,9 @@
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
+> [!IMPORTANT]
|
|
|
+> In the v0.6.12 release, we deprecated `pip` as the package management tool for Dify API Backend service and replaced it with `poetry`.
|
|
|
+
|
|
|
1. Start the docker-compose stack
|
|
|
|
|
|
The backend require some middleware, including PostgreSQL, Redis, and Weaviate, which can be started together using `docker-compose`.
|
|
@@ -29,8 +32,6 @@
|
|
|
|
|
|
Dify API service uses [Poetry](https://python-poetry.org/docs/) to manage dependencies. You can execute `poetry shell` to activate the environment.
|
|
|
|
|
|
- > Using pip can be found [below](#usage-with-pip).
|
|
|
-
|
|
|
5. Install dependencies
|
|
|
|
|
|
```bash
|
|
@@ -84,63 +85,3 @@
|
|
|
cd ../
|
|
|
poetry run -C api bash dev/pytest/pytest_all_tests.sh
|
|
|
```
|
|
|
-
|
|
|
-## Usage with pip
|
|
|
-
|
|
|
-> [!NOTE]
|
|
|
-> In the next version, we will deprecate pip as the primary package management tool for dify api service, currently Poetry and pip coexist.
|
|
|
-
|
|
|
-1. Start the docker-compose stack
|
|
|
-
|
|
|
- The backend require some middleware, including PostgreSQL, Redis, and Weaviate, which can be started together using `docker-compose`.
|
|
|
-
|
|
|
- ```bash
|
|
|
- cd ../docker
|
|
|
- docker-compose -f docker-compose.middleware.yaml -p dify up -d
|
|
|
- cd ../api
|
|
|
- ```
|
|
|
-
|
|
|
-2. Copy `.env.example` to `.env`
|
|
|
-3. Generate a `SECRET_KEY` in the `.env` file.
|
|
|
-
|
|
|
- ```bash
|
|
|
- sed -i "/^SECRET_KEY=/c\SECRET_KEY=$(openssl rand -base64 42)" .env
|
|
|
- ```
|
|
|
-
|
|
|
-4. Create environment.
|
|
|
-
|
|
|
- If you use Anaconda, create a new environment and activate it
|
|
|
-
|
|
|
- ```bash
|
|
|
- conda create --name dify python=3.10
|
|
|
- conda activate dify
|
|
|
- ```
|
|
|
-
|
|
|
-5. Install dependencies
|
|
|
-
|
|
|
- ```bash
|
|
|
- pip install -r requirements.txt
|
|
|
- ```
|
|
|
-
|
|
|
-6. Run migrate
|
|
|
-
|
|
|
- Before the first launch, migrate the database to the latest version.
|
|
|
-
|
|
|
- ```bash
|
|
|
- flask db upgrade
|
|
|
- ```
|
|
|
-
|
|
|
-7. Start backend:
|
|
|
-
|
|
|
- ```bash
|
|
|
- flask run --host 0.0.0.0 --port=5001 --debug
|
|
|
- ```
|
|
|
-
|
|
|
-8. Setup your application by visiting <http://localhost:5001/console/api/setup> or other apis...
|
|
|
-9. If you need to debug local async processing, please start the worker service.
|
|
|
-
|
|
|
- ```bash
|
|
|
- celery -A app.celery worker -P gevent -c 1 --loglevel INFO -Q dataset,generation,mail
|
|
|
- ```
|
|
|
-
|
|
|
- The started celery app handles the async tasks, e.g. dataset importing and documents indexing.
|