Joe f97a51ce24 fix: reranking disable timer error (#6910) пре 1 година
..
configs 8dd68e2034 fix(api/core/moderation/output_moderation.py): Fix config call. (#6769) пре 1 година
constants 104c797dd0 feat: Add support for i18n Turkish language (tr-TR) (#6886) пре 1 година
contexts 5e6fc58db3 Feat/environment variables in workflow (#6515) пре 1 година
controllers 7ab04e17e7 fix: return code in service api (#6911) пре 1 година
core f97a51ce24 fix: reranking disable timer error (#6910) пре 1 година
docker 8eb0d0fddd feat: support Celery auto-scale (#6249) пре 1 година
events d320d1468d Feat/delete file when clean document (#5882) пре 1 година
extensions feb4576ee7 chore: update SQLAlchemy configuration with custom naming convention (#6854) пре 1 година
fields 8157fccf6d delete weight_type (#6865) пре 1 година
libs a98284b1ef refactor(api): Switch to `dify_config` (#6750) пре 1 година
migrations feb4576ee7 chore: update SQLAlchemy configuration with custom naming convention (#6854) пре 1 година
models e23461c837 Fix/6615 40 varchar limit on DatasetCollectionBinding and Embedding model name (#6723) пре 1 година
schedule 5e6fc58db3 Feat/environment variables in workflow (#6515) пре 1 година
services 05141ede16 chore: optimize asynchronous deletion performance of app related data (#6634) пре 1 година
tasks 0625db0bf5 chore: optimize asynchronous workflow deletion performance of app related data (#6639) пре 1 година
templates 00b4cc3cd4 feat: implement forgot password feature (#5534) пре 1 година
tests 44801df8f8 fix score threshold limit be None (#6900) пре 1 година
.dockerignore 27f0ae8416 build: support Poetry for depencencies tool in api's Dockerfile (#5105) пре 1 година
.env.example ecb9c311b5 chore: make prompt generator max tokens configurable (#6693) пре 1 година
Dockerfile 9b7c74a5d9 chore: skip pip upgrade preparation in api dockerfile (#5999) пре 1 година
README.md fb5e3662d5 Chores: add missing profile for middleware docker compose cmd and fix ssrf-proxy doc link (#6372) пре 1 година
app.py 545d3c5a93 chore: Add processId field for metrics of threads/db-pool-stat/health (#6797) пре 1 година
commands.py a98284b1ef refactor(api): Switch to `dify_config` (#6750) пре 1 година
poetry.lock 6aa02f8c63 dep: bump pgvecto-rs client from 0.1.x to 0.2.x (#6891) пре 1 година
poetry.toml f62f71a81a build: initial support for poetry build tool (#4513) пре 1 година
pyproject.toml 6aa02f8c63 dep: bump pgvecto-rs client from 0.1.x to 0.2.x (#6891) пре 1 година

README.md

Dify Backend API

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.

   cd ../docker
   cp middleware.env.example middleware.env
   # change the profile to other vector database if you are not using weaviate
   docker compose -f docker-compose.middleware.yaml --profile weaviate -p dify up -d
   cd ../api
  1. Copy .env.example to .env
  2. Generate a SECRET_KEY in the .env file.

```bash for Linux sed -i "/^SECRET_KEY=/c\SECRET_KEY=$(openssl rand -base64 42)" .env


   ```bash for Mac
   secret_key=$(openssl rand -base64 42)
   sed -i '' "/^SECRET_KEY=/c\\
   SECRET_KEY=${secret_key}" .env
  1. Create environment.

Dify API service uses Poetry to manage dependencies. You can execute poetry shell to activate the environment.

  1. Install dependencies
   poetry env use 3.10
   poetry install

In case of contributors missing to update dependencies for pyproject.toml, you can perform the following shell instead.

   poetry shell                                               # activate current environment
   poetry add $(cat requirements.txt)           # install dependencies of production and update pyproject.toml
   poetry add $(cat requirements-dev.txt) --group dev    # install dependencies of development and update pyproject.toml
  1. Run migrate

Before the first launch, migrate the database to the latest version.

   poetry run python -m flask db upgrade
  1. Start backend
   poetry run python -m flask run --host 0.0.0.0 --port=5001 --debug
  1. Start Dify web service.
  2. Setup your application by visiting http://localhost:3000...
  3. If you need to debug local async processing, please start the worker service.
   poetry run python -m celery -A app.celery worker -P gevent -c 1 --loglevel INFO -Q dataset,generation,mail,ops_trace,app_deletion

The started celery app handles the async tasks, e.g. dataset importing and documents indexing.

Testing

  1. Install dependencies for both the backend and the test environment
   poetry install --with dev
  1. Run the tests locally with mocked system environment variables in tool.pytest_env section in pyproject.toml
   cd ../
   poetry run -C api bash dev/pytest/pytest_all_tests.sh