DocsGPT π¦
**[DocsGPT](https://www.docsgpt.cloud/)** 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.
**Key Features:**
**ποΈ Wide Format Support:** Reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, images, and audio files such as MP3, WAV, M4A, OGG, and WebM.
**ποΈ Speech Workflows:** Record voice input into chat, transcribe audio on the backend, and ingest meeting recordings or voice notes as searchable knowledge.
**π 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
- [x] Agent Workflow Builder with conditional nodes ( February 2026 )
- [x] Research mode ( March 2026 )
- [x] SharePoint & Confluence connectors ( March β April 2026 )
- [x] Postgres migration for user data ( April 2026 )
- [x] OpenTelemetry observability ( April 2026 )
- [x] Bring Your Own Model (BYOM) ( April 2026 )
- [x] Agent scheduling (RedBeat-backed) ( April 2026 )
- [x] Notifications & conversation search ( May 2026 )
- [x] Analytics & logs revamp with per-agent attribution ( June 2026 )
- [x] OIDC / SSO login with SCIM provisioning & groups ( June 2026 )
- [x] Admin dashboard & role-based access control (RBAC) ( June 2026 )
- [x] Agent import / export ( June 2026 )
- [x] Teams with team-scoped sharing & roles ( June 2026 )
You can find our full roadmap [here](https://github.com/orgs/arc53/projects/2). 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:](https://www.docsgpt.cloud/contact)β
[Send Email :email:](mailto:support@docsgpt.cloud?subject=DocsGPT%20support%2Fsolutions)
## 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 β](https://docs.google.com/forms/d/1KAADiJinUJ8EMQyfTXUIGyFbqINNClNR3jBNWq7DgTE)
## QuickStart
> [!Note]
> Make sure you have [Docker](https://docs.docker.com/engine/install/) installed
A more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available in our documentation
1. **Clone the repository:**
```bash
git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT
```
**For macOS and Linux:**
2. **Run the setup script:**
```bash
./setup.sh
```
**For Windows:**
2. **Run the PowerShell setup script:**
```powershell
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:
```bash
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](https://docs.docsgpt.cloud/Deploying/Development-Environment).
## Contributing
Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for information about how to get involved. We welcome issues, questions, and pull requests.
## Architecture
## Project Structure
- **Application** - Backend Flask application.
- **Extensions** - Integrations and widgets (e.g., Chatwoot, React widget).
- **Frontend** - Web UI built with [Vite](https://vitejs.dev/) and [React](https://react.dev/).
- **Scripts** - Miscellaneous utility scripts.
## 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](CODE_OF_CONDUCT.md) file for more information about contributing.
## Many Thanks To Our Contributorsβ‘
## License
The source code license is [MIT](https://opensource.org/license/mit/), as described in the [LICENSE](LICENSE) file.
## This project is supported by: