You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Bowen Liang ccaf335466 fix: rollback gmpy2 to 2.1.5 (#3745 )		2 years ago
..
.vscode	chore: replace outdated config in vscode debug settings (#3106 )	2 years ago
constants	FEAT: NEW WORKFLOW ENGINE (#3160 )	2 years ago
controllers	refactor: tool parameter cache (#3703 )	2 years ago
core	bedrock llm Model file name change (#3714 )	2 years ago
docker	…
events	refactor: tool parameter cache (#3703 )	2 years ago
extensions	feat: Deprecate datetime.utcnow() in favor of datetime.now(timezone.utc).replace(tzinfo=None) for better timezone handling (#3408 ) (#3416 )	2 years ago
fields	FEAT: NEW WORKFLOW ENGINE (#3160 )	2 years ago
libs	chore: apply ruff rules on tests and app.py (#3605 )	2 years ago
migrations	fix: in alembic's offline mode (db migrate with --sql option), skip data operations (#3533 )	2 years ago
models	Feat/enterprise sso (#3602 )	2 years ago
schedule	…
services	refactor: tool parameter cache (#3703 )	2 years ago
tasks	feat: Deprecate datetime.utcnow() in favor of datetime.now(timezone.utc).replace(tzinfo=None) for better timezone handling (#3408 ) (#3416 )	2 years ago
templates	…
tests	chore: apply ruff rules on tests and app.py (#3605 )	2 years ago
.dockerignore	…
.env.example	feat: support relyt vector database (#3367 )	2 years ago
Dockerfile	improvement: speed up dependency installation in docker image rebuilds by mounting cache layer (#3218 )	2 years ago
README.md	test: add scripts for running tests on api module both locally and CI jobs (#3497 )	2 years ago
app.py	feat: add file log (#3612 )	2 years ago
commands.py	feat: support relyt vector database (#3367 )	2 years ago
config.py	version to 0.6.4 (#3670 )	2 years ago
pyproject.toml	chore: apply ruff rules on tests and app.py (#3605 )	2 years ago
requirements-dev.txt	test: add scripts for running tests on api module both locally and CI jobs (#3497 )	2 years ago
requirements.txt	fix: rollback gmpy2 to 2.1.5 (#3745 )	2 years ago

README.md

Dify Backend API

Usage

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
```
Copy .env.example to .env

Generate a SECRET_KEY in the .env file.

sed -i "/^SECRET_KEY=/c\SECRET_KEY=$(openssl rand -base64 42)" .env

If you use Anaconda, create a new environment and activate it
```
conda create --name dify python=3.10
conda activate dify
```
Install dependencies
```
pip install -r requirements.txt
```
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
```

Start backend:

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

Setup your application by visiting http://localhost:5001/console/api/setup or other apis...
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.

Testing

Install dependencies for both the backend and the test environment
```
pip install -r requirements.txt -r requirements-dev.txt
```
Run the tests locally with mocked system environment variables in tool.pytest_env section in pyproject.toml
```
dev/pytest/pytest_all_tests.sh
```