diff --git a/api/README.md b/api/README.md index b23edeab72..b647367046 100644 --- a/api/README.md +++ b/api/README.md @@ -42,7 +42,7 @@ The scripts resolve paths relative to their location, so you can run them from a 1. Set up your application by visiting `http://localhost:3000`. -1. Optional: start the worker service (async tasks, runs from `api`). +1. Start the worker service (async and scheduler tasks, runs from `api`). ```bash ./dev/start-worker @@ -54,86 +54,6 @@ The scripts resolve paths relative to their location, so you can run them from a ./dev/start-beat ``` -### Manual commands - -
-Show manual setup and run steps - -These commands assume you start from the repository root. - -1. Start the docker-compose stack. - - The backend requires middleware, including PostgreSQL, Redis, and Weaviate, which can be started together using `docker-compose`. - - ```bash - cp docker/middleware.env.example docker/middleware.env - # Use mysql or another vector database profile if you are not using postgres/weaviate. - docker compose -f docker/docker-compose.middleware.yaml --profile postgresql --profile weaviate -p dify up -d - ``` - -1. Copy env files. - - ```bash - cp api/.env.example api/.env - cp web/.env.example web/.env.local - ``` - -1. Install UV if needed. - - ```bash - pip install uv - # Or on macOS - brew install uv - ``` - -1. Install API dependencies. - - ```bash - cd api - uv sync --group dev - ``` - -1. Install web dependencies. - - ```bash - cd web - pnpm install - cd .. - ``` - -1. Start backend (runs migrations first, in a new terminal). - - ```bash - cd api - uv run flask db upgrade - uv run flask run --host 0.0.0.0 --port=5001 --debug - ``` - -1. Start Dify [web](../web) service (in a new terminal). - - ```bash - cd web - pnpm dev:inspect - ``` - -1. Set up your application by visiting `http://localhost:3000`. - -1. Optional: start the worker service (async tasks, in a new terminal). - - ```bash - cd api - uv run celery -A app.celery worker -P threads -c 2 --loglevel INFO -Q api_token,dataset,priority_dataset,priority_pipeline,pipeline,mail,ops_trace,app_deletion,plugin,workflow_storage,conversation,workflow,schedule_poller,schedule_executor,triggered_workflow_dispatcher,trigger_refresh_executor,retention - ``` - -1. Optional: start Celery Beat (scheduled tasks, in a new terminal). - - ```bash - cd api - uv run celery -A app.celery beat - ``` - -
- ### Environment notes > [!IMPORTANT]