DocsGPT README

The project's README from github.com/arc53/DocsGPT. As one markdown file: README.md.

DocsGPT 🦖

Private AI for agents, assistants and enterprise search

DocsGPT is an open-source AI platform for building intelligent agents and assistants. Features Agent Builder, deep research tools, document analysis (PDF, Office, web content, and audio), Multi-model support (choose your provider or run locally), and rich API connectivity for agents with actionable tools and integrations. Deploy anywhere with complete privacy control.

link to main GitHub showing Stars number link to main GitHub showing Forks number link to license file link to discord X (formerly Twitter) URL

⚡️ Quickstart • ☁️ Cloud Version • 💬 Discord
📖 Documentation • 👫 Contribute • 🗞 Blog


video-example-of-docs-gpt

Key Features:

Roadmap

You can find our full roadmap here. Please don't hesitate to contribute or create issues, it helps us improve DocsGPT!

Production Support / Help for Companies:

We're eager to provide personalized assistance when deploying your DocsGPT to a live environment.

Get a Demo :wave:⁠

Send Email :email:

Join the Lighthouse Program 🌟

Calling all developers and GenAI innovators! The DocsGPT Lighthouse Program connects technical leaders actively deploying or extending DocsGPT in real-world scenarios. Collaborate directly with our team to shape the roadmap, access priority support, and build enterprise-ready solutions with exclusive community insights.

Learn More & Apply →

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:

  1. Run the setup script:

    ./setup.sh
    

For Windows:

  1. Run the PowerShell setup script:

    PowerShell -ExecutionPolicy Bypass -File .\setup.ps1
    

Either script will guide you through setting up DocsGPT. Five options are available: using the public API, running locally, connecting to a local inference engine, using a cloud API provider, or building the docker image locally. The 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

Architecture chart

Project Structure

Code Of Conduct

We as members, contributors, and leaders, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. Please refer to the CODE_OF_CONDUCT.md file for more information about contributing.

Many Thanks To Our Contributors⚡

Contributors

License

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

This project is supported by:

color

DocsGPT (arc53/DocsGPT)

information-retrieval
Searching Database…

18.3K ·GitHub
What is this?DocsGPT is a private, self-hosted AI platform for building agents, assistants, and enterprise search tools, with a built-in Agent Builder, document analysis, deep research mode, and support for multiple LLM providers.
Is this a hosted service or something I run myself?It is a self-hosted application you deploy yourself (Flask backend, React frontend, Docker-based setup) rather than a SaaS product, built for private and secure operation with Kubernetes support for production.
How do I get it running?Clone the repository, then run the provided setup script (shell script for macOS/Linux, PowerShell script for Windows), which walks you through five options: public API, running locally, connecting to a local inference engine, using a cloud API provider, or building the Docker image yourself.
Do I need Docker before I start?Yes, Docker must be installed before running the setup script; the script then automatically configures your .env file and handles any needed downloads based on the option you pick.
Is this ready to drop into production as-is?The core platform is open source and self-hostable, but for live enterprise deployments the team explicitly offers personalized setup help, and major admin/security features like OIDC/SSO, RBAC, and team-scoped sharing were only completed in mid-2026.
Does it run on Windows too, not just Linux/macOS?Yes, there's a dedicated PowerShell setup script for Windows alongside the shell script for macOS and Linux, and it also supports Kubernetes for larger deployments.
Does my data stay private if I use this?Yes, DocsGPT is built to run privately and securely, and you can pair it with local models like Ollama or llama.cpp so documents never have to leave your own infrastructure.
Which LLM providers can I plug into DocsGPT?It works with major cloud LLMs (OpenAI, Google, Anthropic) as well as local inference engines like Ollama and llama.cpp, including a Bring Your Own Model option.
What kinds of files and sources can it ingest?It reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, images, and audio files, plus content pulled from URLs, sitemaps, Reddit, GitHub, and web crawlers.
What integrations come built in?DocsGPT ships with ready-made HTML/React chat widgets, search tools, and Discord/Telegram bots, along with connectors for SharePoint and Confluence.
What does the Agent Builder actually let me do?It's a visual workflow builder with conditional nodes for chaining tools, data sources, and LLM calls into custom agents without writing backend code.
Creator
arc53
Size
139.9 MB
Stars
18.3K
Age
3y
Commits · 90 Days