dify/api/README.md

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 up -d
   cd ../api
   

2. Copy .env.example to .env

3. Generate a SECRET_KEY in the .env file.

   openssl rand -base64 42
   

4. Install dependencies

   pip install -r requirements.txt
   

5. Run migrate

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

   flask db upgrade
   

6. Start backend:

   flask run --host 0.0.0.0 --port=5001 --debug
   

7. Setup your application by visiting http://localhost:5001/console/api/setup or other apis...

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