Yeuoly e77cd87842 fix: linter 4 ヶ月 前
..
.idea 7ae728a9a3 fix nltk averaged_perceptron_tagger download and fix score limit is none (#7582) 8 ヶ月 前
.vscode e61752bd3a feat/enhance the multi-modal support (#8818) 6 ヶ月 前
configs 4199998c7e Merge branch 'main' into fix/chore-fix 4 ヶ月 前
constants 56e15d09a9 feat: mypy for all type check (#10921) 4 ヶ月 前
contexts a1cdca02e3 fix: formatter 4 ヶ月 前
controllers 00cf5f3841 fix: linters 4 ヶ月 前
core b34d815883 feat: support auto generate and template 4 ヶ月 前
docker 8d4bb9b40d feat: integrate opendal storage (#11508) 4 ヶ月 前
events 4199998c7e Merge branch 'main' into fix/chore-fix 4 ヶ月 前
extensions 430af95b53 fix: linter 4 ヶ月 前
factories 4199998c7e Merge branch 'main' into fix/chore-fix 4 ヶ月 前
fields 4199998c7e Merge branch 'main' into fix/chore-fix 4 ヶ月 前
libs 4199998c7e Merge branch 'main' into fix/chore-fix 4 ヶ月 前
migrations ee6841648c fix: migrations and imports recycle 4 ヶ月 前
models ee6841648c fix: migrations and imports recycle 4 ヶ月 前
schedule 56e15d09a9 feat: mypy for all type check (#10921) 4 ヶ月 前
services e77cd87842 fix: linter 4 ヶ月 前
tasks 4199998c7e Merge branch 'main' into fix/chore-fix 4 ヶ月 前
templates 4fd2743efa Feat/new login (#8120) 6 ヶ月 前
tests 4199998c7e Merge branch 'main' into fix/chore-fix 4 ヶ月 前
.dockerignore 7c83d5ce76 feat: add dockerignore items 7 ヶ月 前
.env.example 4199998c7e Merge branch 'main' into fix/chore-fix 4 ヶ月 前
.ruff.toml d057067543 fix: remove ruff ignore SIM300 (#11810) 4 ヶ月 前
Dockerfile 86291c13e4 Merge branch 'main' into fix/chore-fix 5 ヶ月 前
README.md da601f0bef chore: update base image to Python 3.12 in Dockerfile (#10358) 5 ヶ月 前
app.py e86756cb39 feat(app_factory): speed up api startup (#11762) 4 ヶ月 前
app_factory.py 99f40a9682 feat: full support for opendal and sync configurations between .env and docker-compose (#11754) 4 ヶ月 前
commands.py ac5e3caebc optimize: migrate speed 4 ヶ月 前
dify_app.py 9b46b02717 refactor: assembling the app features in modular way (#9129) 5 ヶ月 前
mypy.ini 56e15d09a9 feat: mypy for all type check (#10921) 4 ヶ月 前
poetry.lock 56e15d09a9 feat: mypy for all type check (#10921) 4 ヶ月 前
poetry.toml f62f71a81a build: initial support for poetry build tool (#4513) 11 ヶ月 前
pyproject.toml 56e15d09a9 feat: mypy for all type check (#10921) 4 ヶ月 前
pytest.ini 096c0ad564 feat: Add support for TEI API key authentication (#11006) 5 ヶ月 前

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
   cp .env.example .env 
  1. Generate a SECRET_KEY in the .env file.

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

   bash for Mac
   ```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.12
   poetry install
  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 handle and debug the async tasks (e.g. dataset importing and documents indexing), 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

Testing

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