dify/api
2024-04-15 11:03:10 +08:00
..
.vscode
constants
controllers feat: Deprecate datetime.utcnow() in favor of datetime.now(timezone.utc).replace(tzinfo=None) for better timezone handling (#3408) (#3416) 2024-04-12 16:22:24 +08:00
core feat: remove langchain from output parsers (#3473) 2024-04-15 00:23:42 +08:00
docker
events feat: optimize the efficiency of generating chatbot conversation name (#3472) 2024-04-14 23:50:24 +08:00
extensions feat: Deprecate datetime.utcnow() in favor of datetime.now(timezone.utc).replace(tzinfo=None) for better timezone handling (#3408) (#3416) 2024-04-12 16:22:24 +08:00
fields
libs feat: remove langchain from output parsers (#3473) 2024-04-15 00:23:42 +08:00
migrations
models feat: Deprecate datetime.utcnow() in favor of datetime.now(timezone.utc).replace(tzinfo=None) for better timezone handling (#3408) (#3416) 2024-04-12 16:22:24 +08:00
schedule
services feat: Deprecate datetime.utcnow() in favor of datetime.now(timezone.utc).replace(tzinfo=None) for better timezone handling (#3408) (#3416) 2024-04-12 16:22:24 +08:00
tasks feat: Deprecate datetime.utcnow() in favor of datetime.now(timezone.utc).replace(tzinfo=None) for better timezone handling (#3408) (#3416) 2024-04-12 16:22:24 +08:00
templates
tests fix: test env key missing or wrong (#3430) 2024-04-12 19:08:48 +08:00
.dockerignore
.env.example Feat/api tool custom timeout (#3420) 2024-04-12 17:46:39 +08:00
app.py
commands.py
config.py
Dockerfile
pyproject.toml
README.md
requirements-dev.txt chore: separate Python dependencies for development (#3198) 2024-04-15 11:03:10 +08:00
requirements.txt chore: separate Python dependencies for development (#3198) 2024-04-15 11:03:10 +08:00

Dify Backend API

Usage

  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
    docker-compose -f docker-compose.middleware.yaml -p dify up -d
    cd ../api
    
  2. Copy .env.example to .env

  3. Generate a SECRET_KEY in the .env file.

    sed -i "/^SECRET_KEY=/c\SECRET_KEY=$(openssl rand -base64 42)" .env
    
  4. If you use Anaconda, create a new environment and activate it

    conda create --name dify python=3.10
    conda activate dify
    
  5. Install dependencies

    pip install -r requirements.txt
    
  6. Run migrate

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

    flask db upgrade
    

    ⚠️ If you encounter problems with jieba, for example

    > flask db upgrade
    Error: While importing 'app', an ImportError was raised:
    

    Please run the following command instead.

    pip install -r requirements.txt --upgrade --force-reinstall
    
  7. Start backend:

    flask run --host 0.0.0.0 --port=5001 --debug
    
  8. Setup your application by visiting http://localhost:5001/console/api/setup or other apis...

  9. If you need to debug local async processing, please start the worker service by running celery -A app.celery worker -P gevent -c 1 --loglevel INFO -Q dataset,generation,mail. The started celery app handles the async tasks, e.g. dataset importing and documents indexing.