DocsGPT 🦖

Open-Source RAG Assistant

DocsGPT is an open-source genAI tool that helps users get reliable answers from any knowledge source, while avoiding hallucinations. It enables quick and reliable information retrieval, with tooling and agentic system capability built in.

⚡️ Quickstart
📖 Documentation • 🗞 Blog

Key Features:

• 🗂️ Wide Format Support: Reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, and images.
• 🌐 Web & Data Integration: Ingests from URLs, sitemaps, Reddit, GitHub and web crawlers.
• ✅ Reliable Answers: Get accurate, hallucination-free responses with source citations viewable in a clean UI.
• 🔑 Streamlined API Keys: Generate keys linked to your settings, documents, and models, simplifying chatbot and integration setup.
• 🔗 Actionable Tooling: Connect to APIs, tools, and other services to enable LLM actions.
• 🧩 Pre-built Integrations: Use readily available HTML/React chat widgets, search tools, Discord/Telegram bots, and more.
• 🔌 Flexible Deployment: Works with major LLMs (OpenAI, Google, Anthropic) and local models (Ollama, llama_cpp).
• 🏢 Secure & Scalable: Run privately and securely with Kubernetes support, designed for enterprise-grade reliability.

Roadmap

• Full GoogleAI compatibility (Jan 2025)
• Add tools (Jan 2025)
• Manually updating chunks in the app UI (Feb 2025)
• Devcontainer for easy development (Feb 2025)
• ReACT agent (March 2025)
• Chatbots menu re-design to handle tools, agent types, and more (April 2025)
• New input box in the conversation menu (April 2025)
• Add triggerable actions / tools (webhook) (April 2025)
• Agent optimisations (May 2025)
• Anthropic Tool compatibility (June 2025)
• MCP support (June 2025)
• Add OAuth 2.0 authentication for tools and sources (July 2025)
• Agent scheduling

QuickStart

Note

Make sure you have Docker installed

A more detailed Quickstart is available in our documentation

1. Clone the repository:

   git clone https://github.com/arc53/DocsGPT.git
   cd DocsGPT

   For macOS and Linux:

2. Run the setup script:

   ./setup.sh

   For Windows:

3. Run the PowerShell setup script:

   PowerShell -ExecutionPolicy Bypass -File .\setup.ps1

Either script will guide you through setting up DocsGPT. Four options available: using the public API, running locally, connecting to a local inference engine, or using a cloud API provider. Scripts will automatically configure your .env file and handle necessary downloads and installations based on your chosen option.

Navigate to http://localhost:5173/

To stop DocsGPT, open a terminal in the DocsGPT directory and run:

docker compose -f deployment/docker-compose.yaml down

(or use the specific docker compose down command shown after running the setup script).

Note

For development environment setup instructions, please refer to the Development Environment Guide.

Contributing

Please refer to the CONTRIBUTING.md file for information about how to get involved. We welcome issues, questions, and pull requests.

Architecture

Project Structure

• Application - Flask app (main application).

• Extensions - Extensions, like react widget or discord bot.

• Frontend - Frontend uses Vite and React.

• Scripts - Miscellaneous scripts.

License

The source code license is MIT, as described in the LICENSE file.