mirror of
https://github.com/arc53/DocsGPT.git
synced 2025-11-29 08:33:20 +00:00
174 lines
7.9 KiB
Markdown
174 lines
7.9 KiB
Markdown
<h1 align="center">
|
||
DocsGPT 🦖
|
||
</h1>
|
||
|
||
<p align="center">
|
||
<strong>Private AI for agents, assistants and enterprise search</strong>
|
||
</p>
|
||
|
||
<p align="left">
|
||
<strong><a href="https://www.docsgpt.cloud/">DocsGPT</a></strong> is an open-source AI platform for building intelligent agents and assistants. Features Agent Builder, deep research tools, document analysis (PDF, Office, web content), 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.
|
||
</p>
|
||
|
||
<div align="center">
|
||
|
||
<a href="https://github.com/arc53/DocsGPT"></a>
|
||
<a href="https://github.com/arc53/DocsGPT"></a>
|
||
<a href="https://github.com/arc53/DocsGPT/blob/main/LICENSE"></a>
|
||
<a href="https://www.bestpractices.dev/projects/9907"><img src="https://www.bestpractices.dev/projects/9907/badge"></a>
|
||
<a href="https://discord.gg/n5BX8dh8rU"></a>
|
||
<a href="https://twitter.com/docsgptai"></a>
|
||
|
||
<a href="https://docs.docsgpt.cloud/quickstart">⚡️ Quickstart</a> • <a href="https://app.docsgpt.cloud/">☁️ Cloud Version</a> • <a href="https://discord.gg/n5BX8dh8rU">💬 Discord</a>
|
||
<br>
|
||
<a href="https://docs.docsgpt.cloud/">📖 Documentation</a> • <a href="https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md">👫 Contribute</a> • <a href="https://blog.docsgpt.cloud/">🗞 Blog</a>
|
||
<br>
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
<br>
|
||
🎃 <a href="https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md"> Hacktoberfest Prizes, Rules & Q&A </a> 🎃
|
||
<br>
|
||
<br>
|
||
</div>
|
||
|
||
|
||
<div align="center">
|
||
<br>
|
||
<img src="https://d3dg1063dc54p9.cloudfront.net/videos/demov7.gif" alt="video-example-of-docs-gpt" width="800" height="450">
|
||
</div>
|
||
<h3 align="left">
|
||
<strong>Key Features:</strong>
|
||
</h3>
|
||
<ul align="left">
|
||
<li><strong>🗂️ Wide Format Support:</strong> Reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, and images.</li>
|
||
<li><strong>🌐 Web & Data Integration:</strong> Ingests from URLs, sitemaps, Reddit, GitHub and web crawlers.</li>
|
||
<li><strong>✅ Reliable Answers:</strong> Get accurate, hallucination-free responses with source citations viewable in a clean UI.</li>
|
||
<li><strong>🔑 Streamlined API Keys:</strong> Generate keys linked to your settings, documents, and models, simplifying chatbot and integration setup.</li>
|
||
<li><strong>🔗 Actionable Tooling:</strong> Connect to APIs, tools, and other services to enable LLM actions.</li>
|
||
<li><strong>🧩 Pre-built Integrations:</strong> Use readily available HTML/React chat widgets, search tools, Discord/Telegram bots, and more.</li>
|
||
<li><strong>🔌 Flexible Deployment:</strong> Works with major LLMs (OpenAI, Google, Anthropic) and local models (Ollama, llama_cpp).</li>
|
||
<li><strong>🏢 Secure & Scalable:</strong> Run privately and securely with Kubernetes support, designed for enterprise-grade reliability.</li>
|
||
</ul>
|
||
|
||
## Roadmap
|
||
|
||
- [x] Full GoogleAI compatibility (Jan 2025)
|
||
- [x] Add tools (Jan 2025)
|
||
- [x] Manually updating chunks in the app UI (Feb 2025)
|
||
- [x] Devcontainer for easy development (Feb 2025)
|
||
- [x] ReACT agent (March 2025)
|
||
- [x] Chatbots menu re-design to handle tools, agent types, and more (April 2025)
|
||
- [x] New input box in the conversation menu (April 2025)
|
||
- [x] Add triggerable actions / tools (webhook) (April 2025)
|
||
- [x] Agent optimisations (May 2025)
|
||
- [x] Filesystem sources update (July 2025)
|
||
- [x] Json Responses (August 2025)
|
||
- [x] MCP support (August 2025)
|
||
- [x] Google Drive integration (September 2025)
|
||
- [ ] Add OAuth 2.0 authentication for MCP (September 2025)
|
||
- [ ] Sharepoint integration (October 2025)
|
||
- [ ] Deep Agents (October 2025)
|
||
- [ ] Agent scheduling
|
||
|
||
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. 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:
|
||
|
||
```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 - Flask app (main application).
|
||
|
||
- Extensions - Extensions, like react widget or discord bot.
|
||
|
||
- Frontend - Frontend uses <a href="https://vitejs.dev/">Vite</a> and <a href="https://react.dev/">React</a>.
|
||
|
||
- Scripts - Miscellaneous 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⚡
|
||
|
||
<a href="https://github.com/arc53/DocsGPT/graphs/contributors" alt="View Contributors">
|
||
<img src="https://contrib.rocks/image?repo=arc53/DocsGPT" alt="Contributors" />
|
||
</a>
|
||
|
||
## License
|
||
|
||
The source code license is [MIT](https://opensource.org/license/mit/), as described in the [LICENSE](LICENSE) file.
|
||
|
||
<p>This project is supported by:</p>
|
||
<p>
|
||
<a href="https://www.digitalocean.com/?utm_medium=opensource&utm_source=DocsGPT">
|
||
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
|
||
</a>
|
||
</p>
|