From eab97c1e2153b4c00a9898cc1ca2c03a2fe6b346 Mon Sep 17 00:00:00 2001 From: Muhammad Tamir Date: Sun, 16 Nov 2025 21:25:43 +0700 Subject: [PATCH] Update README.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/README.md b/README.md index 556b6b7..7e11ec8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,50 @@ # OpenWebUI-RAG +This repository contains resources, scripts, and outputs related to **OpenWebUI** with RAG (Retrieval-Augmented Generation) support. + +> ⚠️ **Content Notice:** If you see material here that you own and want it removed, please **DM me on Discord: NekoMonci**. I will remove it promptly. + +--- + +## About + +OpenWebUI-RAG is designed to: + +- Integrate knowledge bases into **OpenWebUI** for enhanced question answering. +- Allow dynamic loading of `.md` or `.mdx` documents as RAG sources. +- Support multiple LLM providers for retrieval-based generation. +This repository is part of my ongoing development projects under **YueMi-Development**. + +--- + +## Usage + +1. Clone the repository: +```bash +git clone https://git.yuemi.org/YueMi-Development/OpenWebUI-RAG.git +``` +2. Add your knowledge base files (.md or .mdx) into the designated folder. +3. Configure your .env or CLI parameters for your LLM provider (OpenAI, Gemini, Anthropic). +4. Start the OpenWebUI server with RAG enabled. + +--- + +## Contributing + +Contributions are welcome! You can help improve this project by submitting Pull Requests: +- Fork the repository +- Create a new branch for your feature or fix +- Make your changes and test them +- Submit a Pull Request to the main repository +Please ensure your contributions are compatible with AGPL-3.0 licensing. + +--- + +## License + +This project’s code is licensed under AGPL-3.0. Any included content that originates from external sources remains the property of the respective owners. + +--- + +## Contact +- Discord: NekoMonci (for removal requests or questions) \ No newline at end of file