-LAN- 754791efd3 fix(file_factory): validate upload_file_id format as UUID (#12084) 4 meses atrás
..
.idea 7ae728a9a3 fix nltk averaged_perceptron_tagger download and fix score limit is none (#7582) 8 meses atrás
.vscode e61752bd3a feat/enhance the multi-modal support (#8818) 6 meses atrás
configs 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
constants 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
contexts e61752bd3a feat/enhance the multi-modal support (#8818) 6 meses atrás
controllers 5d04638091 feat(message_feedback): add content argument to feedback creation (#12077) 4 meses atrás
core 50b7ec3c73 fix(http_request): add error handling for invalid URLs (#12082) 4 meses atrás
docker 8d4bb9b40d feat: integrate opendal storage (#11508) 4 meses atrás
events 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
extensions 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
factories 754791efd3 fix(file_factory): validate upload_file_id format as UUID (#12084) 4 meses atrás
fields 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
libs 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
migrations c1aa55f3ea fix: remove the unused retry index field (#11903) 4 meses atrás
models 83ea931e3c refactor: optimize database usage (#12071) 4 meses atrás
schedule 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
services 7da4fb68da fix: can not find model bug (#12051) 4 meses atrás
tasks 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
templates 4fd2743efa Feat/new login (#8120) 6 meses atrás
tests 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
.dockerignore 27f0ae8416 build: support Poetry for depencencies tool in api's Dockerfile (#5105) 10 meses atrás
.env.example 3ea54e9d25 fix: update S3 and Azure configuration typos in .env.example and corr… (#12055) 4 meses atrás
.ruff.toml 3ea54e9d25 fix: update S3 and Azure configuration typos in .env.example and corr… (#12055) 4 meses atrás
Dockerfile ef204817ae chore(api/Dockerfile): Bump perl to 0.40.0-8 (#11234) 4 meses atrás
README.md da601f0bef chore: update base image to Python 3.12 in Dockerfile (#10358) 5 meses atrás
app.py e86756cb39 feat(app_factory): speed up api startup (#11762) 4 meses atrás
app_factory.py 99f40a9682 feat: full support for opendal and sync configurations between .env and docker-compose (#11754) 4 meses atrás
commands.py 49bc602fb2 fix: --name option for the create-tenant command does not take effect (#11993) 4 meses atrás
dify_app.py 9b46b02717 refactor: assembling the app features in modular way (#9129) 4 meses atrás
mypy.ini 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
poetry.lock 2b2263a349 Feat/parent child retrieval (#12086) 4 meses atrás
poetry.toml f62f71a81a build: initial support for poetry build tool (#4513) 10 meses atrás
pyproject.toml 56e15d09a9 feat: mypy for all type check (#10921) 4 meses atrás
pytest.ini 096c0ad564 feat: Add support for TEI API key authentication (#11006) 5 meses atrás

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

   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.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