|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p align="center"> |
|
|
<p align="center"> |
|
|
<a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-d9d9d9"></a> |
|
|
<a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-d9d9d9"></a> |
|
|
|
|
|
<a href="./README_TW.md"><img alt="繁體中文文件" src="https://img.shields.io/badge/繁體中文-d9d9d9"></a> |
|
|
<a href="./README_CN.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-d9d9d9"></a> |
|
|
<a href="./README_CN.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-d9d9d9"></a> |
|
|
<a href="./README_JA.md"><img alt="日本語のREADME" src="https://img.shields.io/badge/日本語-d9d9d9"></a> |
|
|
<a href="./README_JA.md"><img alt="日本語のREADME" src="https://img.shields.io/badge/日本語-d9d9d9"></a> |
|
|
<a href="./README_ES.md"><img alt="README en Español" src="https://img.shields.io/badge/Español-d9d9d9"></a> |
|
|
<a href="./README_ES.md"><img alt="README en Español" src="https://img.shields.io/badge/Español-d9d9d9"></a> |
|
|
|
|
|
|
|
|
<a href="./README_BN.md"><img alt="README in বাংলা" src="https://img.shields.io/badge/বাংলা-d9d9d9"></a> |
|
|
<a href="./README_BN.md"><img alt="README in বাংলা" src="https://img.shields.io/badge/বাংলা-d9d9d9"></a> |
|
|
</p> |
|
|
</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Dify is an open-source LLM app development platform. Its intuitive interface combines agentic AI workflow, RAG pipeline, agent capabilities, model management, observability features and more, letting you quickly go from prototype to production. |
|
|
|
|
|
|
|
|
Dify is an open-source LLM app development platform. Its intuitive interface combines agentic AI workflow, RAG pipeline, agent capabilities, model management, observability features and more, letting you quickly go from prototype to production. |
|
|
|
|
|
|
|
|
## Quick start |
|
|
## Quick start |
|
|
|
|
|
|
|
|
> Before installing Dify, make sure your machine meets the following minimum system requirements: |
|
|
> Before installing Dify, make sure your machine meets the following minimum system requirements: |
|
|
> |
|
|
|
|
|
>- CPU >= 2 Core |
|
|
|
|
|
>- RAM >= 4 GiB |
|
|
|
|
|
|
|
|
> |
|
|
|
|
|
> - CPU >= 2 Core |
|
|
|
|
|
> - RAM >= 4 GiB |
|
|
|
|
|
|
|
|
</br> |
|
|
</br> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
After running, you can access the Dify dashboard in your browser at [http://localhost/install](http://localhost/install) and start the initialization process. |
|
|
After running, you can access the Dify dashboard in your browser at [http://localhost/install](http://localhost/install) and start the initialization process. |
|
|
|
|
|
|
|
|
#### Seeking help |
|
|
#### Seeking help |
|
|
|
|
|
|
|
|
Please refer to our [FAQ](https://docs.dify.ai/getting-started/install-self-hosted/faqs) if you encounter problems setting up Dify. Reach out to [the community and us](#community--contact) if you are still having issues. |
|
|
Please refer to our [FAQ](https://docs.dify.ai/getting-started/install-self-hosted/faqs) if you encounter problems setting up Dify. Reach out to [the community and us](#community--contact) if you are still having issues. |
|
|
|
|
|
|
|
|
> If you'd like to contribute to Dify or do additional development, refer to our [guide to deploying from source code](https://docs.dify.ai/getting-started/install-self-hosted/local-source-code) |
|
|
> If you'd like to contribute to Dify or do additional development, refer to our [guide to deploying from source code](https://docs.dify.ai/getting-started/install-self-hosted/local-source-code) |
|
|
|
|
|
|
|
|
## Key features |
|
|
## Key features |
|
|
**1. Workflow**: |
|
|
|
|
|
Build and test powerful AI workflows on a visual canvas, leveraging all the following features and beyond. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
https://github.com/langgenius/dify/assets/13230914/356df23e-1604-483d-80a6-9517ece318aa |
|
|
|
|
|
|
|
|
**1. Workflow**: |
|
|
|
|
|
Build and test powerful AI workflows on a visual canvas, leveraging all the following features and beyond. |
|
|
|
|
|
|
|
|
|
|
|
https://github.com/langgenius/dify/assets/13230914/356df23e-1604-483d-80a6-9517ece318aa |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**2. Comprehensive model support**: |
|
|
|
|
|
Seamless integration with hundreds of proprietary / open-source LLMs from dozens of inference providers and self-hosted solutions, covering GPT, Mistral, Llama3, and any OpenAI API-compatible models. A full list of supported model providers can be found [here](https://docs.dify.ai/getting-started/readme/model-providers). |
|
|
|
|
|
|
|
|
**2. Comprehensive model support**: |
|
|
|
|
|
Seamless integration with hundreds of proprietary / open-source LLMs from dozens of inference providers and self-hosted solutions, covering GPT, Mistral, Llama3, and any OpenAI API-compatible models. A full list of supported model providers can be found [here](https://docs.dify.ai/getting-started/readme/model-providers). |
|
|
|
|
|
|
|
|
 |
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
**3. Prompt IDE**: |
|
|
|
|
|
Intuitive interface for crafting prompts, comparing model performance, and adding additional features such as text-to-speech to a chat-based app. |
|
|
|
|
|
|
|
|
**3. Prompt IDE**: |
|
|
|
|
|
Intuitive interface for crafting prompts, comparing model performance, and adding additional features such as text-to-speech to a chat-based app. |
|
|
|
|
|
|
|
|
|
|
|
**4. RAG Pipeline**: |
|
|
|
|
|
Extensive RAG capabilities that cover everything from document ingestion to retrieval, with out-of-box support for text extraction from PDFs, PPTs, and other common document formats. |
|
|
|
|
|
|
|
|
**4. RAG Pipeline**: |
|
|
|
|
|
Extensive RAG capabilities that cover everything from document ingestion to retrieval, with out-of-box support for text extraction from PDFs, PPTs, and other common document formats. |
|
|
|
|
|
|
|
|
**5. Agent capabilities**: |
|
|
|
|
|
You can define agents based on LLM Function Calling or ReAct, and add pre-built or custom tools for the agent. Dify provides 50+ built-in tools for AI agents, such as Google Search, DALL·E, Stable Diffusion and WolframAlpha. |
|
|
|
|
|
|
|
|
**5. Agent capabilities**: |
|
|
|
|
|
You can define agents based on LLM Function Calling or ReAct, and add pre-built or custom tools for the agent. Dify provides 50+ built-in tools for AI agents, such as Google Search, DALL·E, Stable Diffusion and WolframAlpha. |
|
|
|
|
|
|
|
|
**6. LLMOps**: |
|
|
|
|
|
Monitor and analyze application logs and performance over time. You could continuously improve prompts, datasets, and models based on production data and annotations. |
|
|
|
|
|
|
|
|
**6. LLMOps**: |
|
|
|
|
|
Monitor and analyze application logs and performance over time. You could continuously improve prompts, datasets, and models based on production data and annotations. |
|
|
|
|
|
|
|
|
**7. Backend-as-a-Service**: |
|
|
|
|
|
All of Dify's offerings come with corresponding APIs, so you could effortlessly integrate Dify into your own business logic. |
|
|
|
|
|
|
|
|
**7. Backend-as-a-Service**: |
|
|
|
|
|
All of Dify's offerings come with corresponding APIs, so you could effortlessly integrate Dify into your own business logic. |
|
|
|
|
|
|
|
|
## Feature Comparison |
|
|
## Feature Comparison |
|
|
|
|
|
|
|
|
<table style="width: 100%;"> |
|
|
<table style="width: 100%;"> |
|
|
<tr> |
|
|
<tr> |
|
|
<th align="center">Feature</th> |
|
|
<th align="center">Feature</th> |
|
|
|
|
|
|
|
|
## Using Dify |
|
|
## Using Dify |
|
|
|
|
|
|
|
|
- **Cloud </br>** |
|
|
- **Cloud </br>** |
|
|
We host a [Dify Cloud](https://dify.ai) service for anyone to try with zero setup. It provides all the capabilities of the self-deployed version, and includes 200 free GPT-4 calls in the sandbox plan. |
|
|
|
|
|
|
|
|
We host a [Dify Cloud](https://dify.ai) service for anyone to try with zero setup. It provides all the capabilities of the self-deployed version, and includes 200 free GPT-4 calls in the sandbox plan. |
|
|
|
|
|
|
|
|
- **Self-hosting Dify Community Edition</br>** |
|
|
- **Self-hosting Dify Community Edition</br>** |
|
|
Quickly get Dify running in your environment with this [starter guide](#quick-start). |
|
|
|
|
|
Use our [documentation](https://docs.dify.ai) for further references and more in-depth instructions. |
|
|
|
|
|
|
|
|
Quickly get Dify running in your environment with this [starter guide](#quick-start). |
|
|
|
|
|
Use our [documentation](https://docs.dify.ai) for further references and more in-depth instructions. |
|
|
|
|
|
|
|
|
- **Dify for enterprise / organizations</br>** |
|
|
- **Dify for enterprise / organizations</br>** |
|
|
We provide additional enterprise-centric features. [Log your questions for us through this chatbot](https://udify.app/chat/22L1zSxg6yW1cWQg) or [send us an email](mailto:business@dify.ai?subject=[GitHub]Business%20License%20Inquiry) to discuss enterprise needs. </br> |
|
|
|
|
|
|
|
|
We provide additional enterprise-centric features. [Log your questions for us through this chatbot](https://udify.app/chat/22L1zSxg6yW1cWQg) or [send us an email](mailto:business@dify.ai?subject=[GitHub]Business%20License%20Inquiry) to discuss enterprise needs. </br> |
|
|
> For startups and small businesses using AWS, check out [Dify Premium on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-t22mebxzwjhu6) and deploy it to your own AWS VPC with one-click. It's an affordable AMI offering with the option to create apps with custom logo and branding. |
|
|
> For startups and small businesses using AWS, check out [Dify Premium on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-t22mebxzwjhu6) and deploy it to your own AWS VPC with one-click. It's an affordable AMI offering with the option to create apps with custom logo and branding. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Staying ahead |
|
|
## Staying ahead |
|
|
|
|
|
|
|
|
Star Dify on GitHub and be instantly notified of new releases. |
|
|
Star Dify on GitHub and be instantly notified of new releases. |
|
|
|
|
|
|
|
|
 |
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Advanced Setup |
|
|
## Advanced Setup |
|
|
|
|
|
|
|
|
If you need to customize the configuration, please refer to the comments in our [.env.example](docker/.env.example) file and update the corresponding values in your `.env` file. Additionally, you might need to make adjustments to the `docker-compose.yaml` file itself, such as changing image versions, port mappings, or volume mounts, based on your specific deployment environment and requirements. After making any changes, please re-run `docker-compose up -d`. You can find the full list of available environment variables [here](https://docs.dify.ai/getting-started/install-self-hosted/environments). |
|
|
If you need to customize the configuration, please refer to the comments in our [.env.example](docker/.env.example) file and update the corresponding values in your `.env` file. Additionally, you might need to make adjustments to the `docker-compose.yaml` file itself, such as changing image versions, port mappings, or volume mounts, based on your specific deployment environment and requirements. After making any changes, please re-run `docker-compose up -d`. You can find the full list of available environment variables [here](https://docs.dify.ai/getting-started/install-self-hosted/environments). |
|
|
|
|
|
|
|
|
Deploy Dify to Cloud Platform with a single click using [terraform](https://www.terraform.io/) |
|
|
Deploy Dify to Cloud Platform with a single click using [terraform](https://www.terraform.io/) |
|
|
|
|
|
|
|
|
##### Azure Global |
|
|
##### Azure Global |
|
|
|
|
|
|
|
|
- [Azure Terraform by @nikawang](https://github.com/nikawang/dify-azure-terraform) |
|
|
- [Azure Terraform by @nikawang](https://github.com/nikawang/dify-azure-terraform) |
|
|
|
|
|
|
|
|
##### Google Cloud |
|
|
##### Google Cloud |
|
|
|
|
|
|
|
|
- [Google Cloud Terraform by @sotazum](https://github.com/DeNA/dify-google-cloud-terraform) |
|
|
- [Google Cloud Terraform by @sotazum](https://github.com/DeNA/dify-google-cloud-terraform) |
|
|
|
|
|
|
|
|
#### Using AWS CDK for Deployment |
|
|
#### Using AWS CDK for Deployment |
|
|
|
|
|
|
|
|
Deploy Dify to AWS with [CDK](https://aws.amazon.com/cdk/) |
|
|
Deploy Dify to AWS with [CDK](https://aws.amazon.com/cdk/) |
|
|
|
|
|
|
|
|
##### AWS |
|
|
|
|
|
|
|
|
##### AWS |
|
|
|
|
|
|
|
|
- [AWS CDK by @KevinZhao](https://github.com/aws-samples/solution-for-deploying-dify-on-aws) |
|
|
- [AWS CDK by @KevinZhao](https://github.com/aws-samples/solution-for-deploying-dify-on-aws) |
|
|
|
|
|
|
|
|
## Contributing |
|
|
## Contributing |
|
|
|
|
|
|
|
|
For those who'd like to contribute code, see our [Contribution Guide](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md). |
|
|
|
|
|
|
|
|
For those who'd like to contribute code, see our [Contribution Guide](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md). |
|
|
At the same time, please consider supporting Dify by sharing it on social media and at events and conferences. |
|
|
At the same time, please consider supporting Dify by sharing it on social media and at events and conferences. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
> We are looking for contributors to help with translating Dify to languages other than Mandarin or English. If you are interested in helping, please see the [i18n README](https://github.com/langgenius/dify/blob/main/web/i18n/README.md) for more information, and leave us a comment in the `global-users` channel of our [Discord Community Server](https://discord.gg/8Tpq4AcN9c). |
|
|
> We are looking for contributors to help with translating Dify to languages other than Mandarin or English. If you are interested in helping, please see the [i18n README](https://github.com/langgenius/dify/blob/main/web/i18n/README.md) for more information, and leave us a comment in the `global-users` channel of our [Discord Community Server](https://discord.gg/8Tpq4AcN9c). |
|
|
|
|
|
|
|
|
## Community & contact |
|
|
## Community & contact |
|
|
|
|
|
|
|
|
* [Github Discussion](https://github.com/langgenius/dify/discussions). Best for: sharing feedback and asking questions. |
|
|
|
|
|
* [GitHub Issues](https://github.com/langgenius/dify/issues). Best for: bugs you encounter using Dify.AI, and feature proposals. See our [Contribution Guide](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md). |
|
|
|
|
|
* [Discord](https://discord.gg/FngNHpbcY7). Best for: sharing your applications and hanging out with the community. |
|
|
|
|
|
* [X(Twitter)](https://twitter.com/dify_ai). Best for: sharing your applications and hanging out with the community. |
|
|
|
|
|
|
|
|
- [Github Discussion](https://github.com/langgenius/dify/discussions). Best for: sharing feedback and asking questions. |
|
|
|
|
|
- [GitHub Issues](https://github.com/langgenius/dify/issues). Best for: bugs you encounter using Dify.AI, and feature proposals. See our [Contribution Guide](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md). |
|
|
|
|
|
- [Discord](https://discord.gg/FngNHpbcY7). Best for: sharing your applications and hanging out with the community. |
|
|
|
|
|
- [X(Twitter)](https://twitter.com/dify_ai). Best for: sharing your applications and hanging out with the community. |
|
|
|
|
|
|
|
|
**Contributors** |
|
|
**Contributors** |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[](https://star-history.com/#langgenius/dify&Date) |
|
|
[](https://star-history.com/#langgenius/dify&Date) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Security disclosure |
|
|
## Security disclosure |
|
|
|
|
|
|
|
|
To protect your privacy, please avoid posting security issues on GitHub. Instead, send your questions to security@dify.ai and we will provide you with a more detailed answer. |
|
|
To protect your privacy, please avoid posting security issues on GitHub. Instead, send your questions to security@dify.ai and we will provide you with a more detailed answer. |
|
|
|
|
|
|
|
|
## License |
|
|
## License |
|
|
|
|
|
|
|
|
This repository is available under the [Dify Open Source License](LICENSE), which is essentially Apache 2.0 with a few additional restrictions. |
|
|
This repository is available under the [Dify Open Source License](LICENSE), which is essentially Apache 2.0 with a few additional restrictions. |
|
|
|
|
|
|