> ## Documentation Index
> Fetch the complete documentation index at: https://docs.springwinter.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Deploy RAGFlow

> Set up RAGFlow and connect its dependencies with Spring Winter.

## Deploy with an agent

Copy agent prompt

Help me deploy RAGFlow. Read [https://docs.springwinter.dev/deploy/open-source/ragflow](https://docs.springwinter.dev/deploy/open-source/ragflow.md), [https://ragflow.io/docs/dev/configurations](https://ragflow.io/docs/dev/configurations), and [https://docs.springwinter.dev/api-reference/agents](https://docs.springwinter.dev/api-reference/agents.md). Fetch the public OpenAPI specification from my Spring Winter origin. Use my local SPRINGWINTER\_TOKEN or existing SPRINGWINTER\_API\_TOKEN. Keep credentials out of chat, logs and source.

Confirm my project, AWS connection, Region and budget. Pin a release. Check its required services, container port, health path, network access and durable storage. Data requirements for this deployment: MySQL for the documented MySQL layout, a document index, object storage and any cache or queue services required by the pinned release.

1. Pin a release and use its Compose profiles to list required services. For the MySQL layout, create a compatible private MySQL database first. Wait for the writer and create the application database and role if required.
2. Set the mysql host, port, name, user and password inputs for service\_conf.yaml.template as defined by that release. Replace Compose hostnames with actual private endpoints when services run separately.
3. Start the selected document engine and durable object storage. Start the cache, queue and any other enabled services before the RAGFlow processes that use them. Keep data services private.
4. For the full Compose layout, use a persistent container host. If you split the HTTP service onto Spring Winter, verify private reachability, startup commands and all required companion processes first. Wait for schema initialization before serving requests.

Show me the planned resources, database and migration order, secret names and estimated cost. Identify components that require separate hosting. Wait for approval before making changes. Use documented Spring Winter operations and wait for each workflow to finish. Upload a non-sensitive document, wait for indexing and confirm a query retrieves a relevant passage. Report resource links and anything you could not verify.

## Before you start

[Connect your AWS account](https://docs.springwinter.dev/connect-aws.md) and choose a project. Review the [upstream deployment instructions](https://ragflow.io/docs/dev/configurations) for the release you plan to pin.

## Data dependencies

MySQL for the documented MySQL layout, a document index, object storage and any cache or queue services required by the pinned release. See [SQL databases](https://docs.springwinter.dev/deploy/databases.md) for private writer access and connection details.

## Deployment order

1. Pin a release and use its Compose profiles to list required services. For the MySQL layout, create a compatible private MySQL database first. Wait for the writer and create the application database and role if required.
2. Set the `mysql` host, port, name, user and password inputs for `service_conf.yaml.template` as defined by that release. Replace Compose hostnames with actual private endpoints when services run separately.
3. Start the selected document engine and durable object storage. Start the cache, queue and any other enabled services before the RAGFlow processes that use them. Keep data services private.
4. For the full Compose layout, use a persistent container host. If you split the HTTP service onto Spring Winter, verify private reachability, startup commands and all required companion processes first. Wait for schema initialization before serving requests.

Use [Runtime variables](https://docs.springwinter.dev/concepts/environment-variables.md) for runtime credentials. For a [Spring Winter web server](https://docs.springwinter.dev/deploy/web-servers.md), set an app-supported health path that returns HTTP 200 without credentials. Check **History** before running the application check.

## Verify the deployment

Upload a non-sensitive document, wait for indexing and confirm a query retrieves a relevant passage.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.