mirror of https://github.com/langgenius/dify.git synced 2026-10-16 15:35:32 +08:00

Files

T

Stephen ZhouandClaude Opus 5.5 7fb2f932fd Merge remote-tracking branch 'origin/main' into deploy/konwledge

Adapt the KnowledgeFS branch to main's refactors:
- Move KnowledgeFS membership hooks from the removed account_service into
  WorkspaceRepository/WorkspaceMemberService within the same transaction.
- Route Classic-to-Agent upgrade endpoints through a new
  KnowledgeUpgradeApplicationService behind console_account_admission, and
  carry creator_ids and knowledge_fs_upgrade through the dataset list service.
- Adopt main's data-source credential repository/gateways in KnowledgeFS
  initial-source preview, tasks, and datasource backwards invocation.
- Take main's catalog-driven difyctl v2; the hand-written KnowledgeFS CLI
  commands are dropped since the server catalog now drives commands.
- Port dify-ui API renames (AlertDialogFooter, DrawerClose + IconButton),
  the lazy workflow panel map, the dataset card inline menu, and the new
  date picker into the reorganized knowledge UI.
- Restore main's external knowledge endpoint JSON probe and missing oxlint
  suppressions lost in earlier merges; regenerate contracts and OpenAPI docs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

2026-10-08 16:09:19 +08:00

3.0 KiB

Raw Blame History

Dify Backend API

Setup and Run

uv, Docker Compose, and the Node.js and pnpm versions pinned in the root package.json are required. Run the commands below from the repository root, with each long-running service in its own terminal.

Using scripts (recommended)

Run setup for a new checkout (copies env files and installs dependencies). This overwrites api/.env, web/.env.local, and docker/middleware.env; preserve existing configuration before rerunning it.
```
./dev/setup
```
Review api/.env, web/.env.local, and docker/middleware.env values (see the SECRET_KEY note below).
Start middleware (PostgreSQL/Redis/Weaviate).
```
./dev/start-docker-compose
```
Start backend (runs migrations first).
```
./dev/start-api
```
Start Dify web service.
```
./dev/start-web
```
./dev/setup and ./dev/start-web install JavaScript dependencies through the repository root workspace, so you do not need a separate cd web && pnpm install step.
Set up your application by visiting http://localhost:3000.
Start the worker service (executes queued async tasks).
```
./dev/start-worker
```
Start Celery Beat when scheduled tasks are needed. This is required when KNOWLEDGE_FS_LIFECYCLE_WORKER_ENABLED=true so provisioning and deletion outbox commands are dispatched to the lifecycle worker.
```
./dev/start-beat
```

Environment notes

Important

When the frontend and backend run on different subdomains, set COOKIE_DOMAIN to the site’s top-level domain (e.g., example.com). The frontend and backend must be under the same top-level domain in order to share authentication cookies.

Leave SECRET_KEY empty to let Dify generate a persistent key in the storage directory. To manage it explicitly, generate a value with openssl rand -base64 42 and set SECRET_KEY in api/.env.

Testing

Run from the repository root:

uv sync --project api --group dev
make test
make test TARGET_TESTS=./api/tests/unit_tests/<path>
make lint
make type-check

make test includes provider unit tests and runs controller tests separately. Integration suites are CI-only and are not expected to run locally. Test environment defaults live in api/pyproject.toml under tool.pytest_env; see the backend agent guide for package conventions.

API contracts

The API schema guide owns schema changes and verification. Generate the OpenAPI specifications and TypeScript/Zod contracts through the workspace script:

pnpm -C packages/contracts gen-api-contract

Refresh the checked-in Markdown reference with:

uv run --project api python api/dev/generate_swagger_markdown_docs.py \
  --swagger-dir packages/contracts/openapi --markdown-dir api/openapi/markdown --keep-swagger-json

Update the backend schema owner and regenerate contracts instead of converting types manually or editing generated files.

3.0 KiB Raw Blame History Unescape Escape