dify/api
2023-08-23 20:15:45 +08:00
..
constants
controllers
core feat: optimize hf inference endpoint (#975) 2023-08-23 19:47:50 +08:00
docker
events
extensions
libs
migrations
models
services Fix:condition for dataset availability check (#973) 2023-08-23 19:57:27 +08:00
tasks
tests feat: optimize hf inference endpoint (#975) 2023-08-23 19:47:50 +08:00
.dockerignore
.env.example
app.py
commands.py
config.py feat: bump version to 0.3.15 (#959) 2023-08-22 18:20:33 +08:00
Dockerfile
README.md
requirements.txt feat: upgrade xinference to 0.2.1 which support stream response (#977) 2023-08-23 20:15:45 +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.

    openssl rand -base64 42
    

3.5 If you use annaconda, create a new environment and activate it

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

    pip install -r requirements.txt
    
  2. 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
    
  3. Start backend:

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

  5. If you need to debug local async processing, you can run celery -A app.celery worker -Q dataset,generation,mail, celery can do dataset importing and other async tasks.

  6. Start frontend:

    docker run -it -d --platform linux/amd64 -p 3000:3000 -e EDITION=SELF_HOSTED -e CONSOLE_URL=http://127.0.0.1:5000 --name web-self-hosted langgenius/dify-web:latest
    

    This will start a dify frontend, now you are all set, happy coding!