dify/api
takatost 7753ba2d37
FEAT: NEW WORKFLOW ENGINE (#3160)
Co-authored-by: Joel <iamjoel007@gmail.com>
Co-authored-by: Yeuoly <admin@srmxy.cn>
Co-authored-by: JzoNg <jzongcode@gmail.com>
Co-authored-by: StyleZhang <jasonapring2015@outlook.com>
Co-authored-by: jyong <jyong@dify.ai>
Co-authored-by: nite-knite <nkCoding@gmail.com>
Co-authored-by: jyong <718720800@qq.com>
2024-04-08 18:51:46 +08:00
..
.vscode chore: replace outdated config in vscode debug settings (#3106) 2024-04-05 17:49:09 +08:00
constants FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
controllers FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
core FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
docker improvement: introduce Super-Linter actions to check style for shell script, dockerfile and yaml files (#1966) 2024-01-09 10:31:52 +08:00
events FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
extensions add embedding cache and clean embedding cache job (#3087) 2024-04-02 20:46:24 +08:00
fields FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
libs FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
migrations FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
models FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
schedule Feat/dify rag (#2528) 2024-02-22 23:31:57 +08:00
services FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
tasks FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
templates fix: email template style (#1914) 2024-01-04 16:53:11 +08:00
tests FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
.dockerignore build: fix .dockerignore file (#800) 2023-08-11 18:19:44 +08:00
.env.example FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
app.py feat: support HTTP response compression in api server (#2680) 2024-03-05 14:45:22 +08:00
commands.py FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
config.py FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +08:00
Dockerfile Add gmpy2 dependencies packages (#2216) 2024-01-26 03:09:24 +08:00
pyproject.toml fix: event handlers not registered globally (#2479) 2024-02-19 16:04:52 +08:00
README.md fix typo in readme (#3096) 2024-04-03 20:29:02 +08:00
requirements.txt FEAT: NEW WORKFLOW ENGINE (#3160) 2024-04-08 18:51:46 +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
    

3.5 If you use Anaconda, 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 -P gevent -c 1 --loglevel INFO -Q dataset,generation,mail, celery can do dataset importing and other async tasks.