Xu Song 8c2f62fb92 Feat: support json output for bing-search (#10904) vor 2 Jahren
..
.idea 7ae728a9a3 fix nltk averaged_perceptron_tagger download and fix score limit is none (#7582) vor 2 Jahren
.vscode e61752bd3a feat/enhance the multi-modal support (#8818) vor 2 Jahren
configs 8ff65abbc6 ext_redis.py support redis clusters --- Fixes #9538 (#9789) vor 2 Jahren
constants db1d2aaff5 Feat/add Slovensko (Slovenija) (#10731) vor 2 Jahren
contexts e61752bd3a feat/enhance the multi-modal support (#8818) vor 2 Jahren
controllers 904ea05bf6 fix: download some remote files raise error (#10781) vor 2 Jahren
core 8c2f62fb92 Feat: support json output for bing-search (#10904) vor 2 Jahren
docker 931e76e3d1 fix: remove unused queue `generation` (#10532) vor 2 Jahren
events e61752bd3a feat/enhance the multi-modal support (#8818) vor 2 Jahren
extensions 8ff65abbc6 ext_redis.py support redis clusters --- Fixes #9538 (#9789) vor 2 Jahren
factories af53e2b6b0 Fix : Add a process to fetch the mime type from the file name for signed url in remote_url #10872 version2 (#10908) vor 2 Jahren
fields 01014a6a84 fix: external dataset missing score_threshold_enabled (#10943) vor 2 Jahren
libs 51db59622c chore(lint): cleanup repeated cause exception in logging.exception replaced by helpful message (#10425) vor 2 Jahren
migrations 128efc3193 Feat/clean message records (#10588) vor 2 Jahren
models 328965ed7c Fix: crash of workflow file upload (#10831) vor 2 Jahren
schedule 128efc3193 Feat/clean message records (#10588) vor 2 Jahren
services 0067b16d1e fix: refactor all 'or []' and 'or {}' logic to make code more clear (#10883) vor 2 Jahren
tasks 94c9cadbd8 fix image files not deleted on indexing_estimate #9541 (#10798) vor 2 Jahren
templates 4fd2743efa Feat/new login (#8120) vor 2 Jahren
tests 8ff65abbc6 ext_redis.py support redis clusters --- Fixes #9538 (#9789) vor 2 Jahren
.dockerignore 27f0ae8416 build: support Poetry for depencencies tool in api's Dockerfile (#5105) vor 2 Jahren
.env.example 8ff65abbc6 ext_redis.py support redis clusters --- Fixes #9538 (#9789) vor 2 Jahren
Dockerfile a3155e0613 Update expat version (#10686) vor 2 Jahren
README.md ec9f6220c9 doc: fix better doc for api develop, droping dead hint (#10906) vor 2 Jahren
app.py 3e04c92ff9 chore(api): remove setting of expired remember_token cookie in after_request (#10582) vor 2 Jahren
app_factory.py 0e8ab0588f fix: (#10437 followup) fix conditions with DEBUG config (#10438) vor 2 Jahren
commands.py 51db59622c chore(lint): cleanup repeated cause exception in logging.exception replaced by helpful message (#10425) vor 2 Jahren
poetry.lock 90d6ebc879 Add youtube-transcript-api as tool (#10772) vor 2 Jahren
poetry.toml f62f71a81a build: initial support for poetry build tool (#4513) vor 2 Jahren
pyproject.toml 90d6ebc879 Add youtube-transcript-api as tool (#10772) vor 2 Jahren
pytest.ini 0ebd985672 feat: add models for gitee.ai (#9490) vor 2 Jahren

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