zhuhao c9dfe1ad92 feat: support user-defined configuration of log file size and retention count (#9610) 1 year ago
..
.idea 7ae728a9a3 fix nltk averaged_perceptron_tagger download and fix score limit is none (#7582) 1 year ago
.vscode e61752bd3a feat/enhance the multi-modal support (#8818) 1 year ago
configs c9dfe1ad92 feat: support user-defined configuration of log file size and retention count (#9610) 1 year ago
constants 3e9d271b52 nltk security issue and upgrade unstructured (#9558) 1 year ago
contexts e61752bd3a feat/enhance the multi-modal support (#8818) 1 year ago
controllers ed96a6b6c0 fix: remove email code login redirect (#9698) 1 year ago
core e11d5ac708 feat(model_runtime): add new model 'claude-3-5-sonnet-20241022' (#9708) 1 year ago
docker 8dfdb37de3 fix: use LOG_LEVEL for celery startup (#7628) 1 year ago
events e61752bd3a feat/enhance the multi-modal support (#8818) 1 year ago
extensions c9dfe1ad92 feat: support user-defined configuration of log file size and retention count (#9610) 1 year ago
factories ef5f476cd6 fix(api): enhance file factory URL handling (#9631) 1 year ago
fields 1b9bf9c62d feat(api): add video and audio file size limits to upload config (#9703) 1 year ago
libs 4d9160ca9f refactor: use dify_config to replace legacy usage of flask app's config (#9089) 1 year ago
migrations e61752bd3a feat/enhance the multi-modal support (#8818) 1 year ago
models 0e965b6529 chore(models): convert created_by_role to its value for consistency (#9612) 1 year ago
schedule 5aabb83f5a update dataset clean rule (#9426) 1 year ago
services 67016feb96 feat(api): enhance file preview handling (#9674) 1 year ago
tasks 4fd2743efa Feat/new login (#8120) 1 year ago
templates 4fd2743efa Feat/new login (#8120) 1 year ago
tests 9a5bdae07f feat(condition): add support for 'exists' and 'not exists' operators (#9687) 1 year ago
.dockerignore 27f0ae8416 build: support Poetry for depencencies tool in api's Dockerfile (#5105) 1 year ago
.env.example c9dfe1ad92 feat: support user-defined configuration of log file size and retention count (#9610) 1 year ago
Dockerfile b411a89703 fix(dockerfile): update libsqlite3 package version (#9530) 1 year ago
README.md a8134a49c4 fix: poetry installation in CI jobs (#9336) 1 year ago
app.py 4d9160ca9f refactor: use dify_config to replace legacy usage of flask app's config (#9089) 1 year ago
app_factory.py 4d9160ca9f refactor: use dify_config to replace legacy usage of flask app's config (#9089) 1 year ago
commands.py 8e7a752b2a feat: add upstash as a new vector database provider (#9644) 1 year ago
poetry.lock 3e9d271b52 nltk security issue and upgrade unstructured (#9558) 1 year ago
poetry.toml f62f71a81a build: initial support for poetry build tool (#4513) 1 year ago
pyproject.toml 3e9d271b52 nltk security issue and upgrade unstructured (#9558) 1 year ago
pytest.ini b933c9d206 chore: move testing env variables from pyproject.toml to pytest.ini (#9019) 1 year ago

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