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)

Searching Database…

18.3K ·GitHub
Что это такое?DocsGPT — это приватная платформа ИИ с самостоятельным развёртыванием для создания агентов, ассистентов и инструментов корпоративного поиска. В ней есть встроенный Agent Builder, анализ документов, режим глубокого исследования и поддержка нескольких провайдеров LLM.
Это облачный сервис или то, что я запускаю сам?Это приложение для самостоятельного развёртывания (бэкенд на Flask, фронтенд на React, настройка на основе Docker), а не продукт SaaS. Оно создано для приватной и безопасной работы и поддерживает Kubernetes для продакшена.
Как это запустить?Клонируйте репозиторий, затем запустите предусмотренный скрипт установки (скрипт shell для macOS/Linux или скрипт PowerShell для Windows). Он проведёт вас через пять вариантов: публичный API, локальный запуск, подключение к локальному движку инференса, использование облачного провайдера API или самостоятельную сборку образа Docker.
Нужен ли Docker перед началом работы?Да, Docker должен быть установлен до запуска скрипта установки. Затем скрипт автоматически настроит ваш файл .env и выполнит необходимые загрузки в зависимости от выбранного варианта.
Можно ли сразу использовать это в продакшене?Основная платформа имеет открытый исходный код и может быть развёрнута на собственных серверах. Однако для корпоративного внедрения команда прямо предлагает персональную помощь с настройкой. Ключевые функции администрирования и безопасности, такие как OIDC/SSO, RBAC и общий доступ в рамках команды, были завершены только в середине 2026 года.
Работает ли это и на Windows, а не только на Linux/macOS?Да, есть отдельный скрипт установки для Windows на PowerShell, а также скрипт shell для macOS и Linux. Кроме того, поддерживается Kubernetes для крупных развёртываний.
Мои данные останутся приватными, если я буду этим пользоваться?Да, DocsGPT создан для приватной и безопасной работы. Его можно использовать вместе с локальными моделями, такими как Ollama или llama.cpp, поэтому документы никогда не покидают вашу собственную инфраструктуру.
Какие провайдеры LLM можно подключить к DocsGPT?DocsGPT работает с крупными облачными LLM (OpenAI, Google, Anthropic), а также с локальными движками инференса, такими как Ollama и llama.cpp. Есть и вариант Bring Your Own Model.
Какие типы файлов и источников он может загружать?Он читает PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, изображения и аудиофайлы. Также он загружает контент по URL, из sitemap, Reddit, GitHub и с помощью веб-краулеров.
Какие интеграции есть из коробки?В DocsGPT есть готовые виджеты чата на HTML/React, инструменты поиска и боты для Discord и Telegram. Также есть коннекторы для SharePoint и Confluence.
Что на самом деле позволяет делать Agent Builder?Это визуальный конструктор рабочих процессов с условными узлами. Он позволяет объединять инструменты, источники данных и вызовы LLM в пользовательских агентов без написания кода бэкенда.
Creator
arc53
Size
139.9 MB
Stars
18.3K
Age
3y
Commits · 90 Days