mirror of
https://github.com/tiennm99/DocsGPT.git
synced 2026-10-05 16:13:51 +00:00
Alex
4f0bf2cca8
deployment/install.sh (curl | bash) and install.ps1 (irm | iex) check for Docker, install uv when it is missing or older than 0.8 (pinned 0.12.15 via Astral's installer), install or upgrade the docsgpt package with `uv tool install`, and hand the terminal to `docsgpt up` with any arguments. On Linux without Docker the shell installer offers get.docker.com. Both run entirely inside a function, so a download cut short runs nothing. Releases attach both scripts next to the Compose file, which is where docs.ac/install and docs.ac/install.ps1 will point. installer-lint.yml runs shellcheck and the PowerShell parser; docker-image-verify.yml now installs through install.sh. README, Quickstart, Docker-Deploying and the changelog lead with the one-liner.
194 lines
9.0 KiB
Markdown
194 lines
9.0 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, 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.
|
||
</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/vN7YFfdMpj"></a>
|
||
<a href="https://x.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/vN7YFfdMpj">💬 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>
|
||
<img src="https://d3dg1063dc54p9.cloudfront.net/videos/demo-26.gif" alt="video-example-of-docs-gpt" width="800" height="480">
|
||
</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, images, and audio files such as MP3, WAV, M4A, OGG, and WebM.</li>
|
||
<li><strong>🎙️ Speech Workflows:</strong> Record voice input into chat, transcribe audio on the backend, and ingest meeting recordings or voice notes as searchable knowledge.</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] 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]
|
||
> DocsGPT runs on [Docker](https://docs.docker.com/engine/install/). The installer checks for it first.
|
||
|
||
**macOS and Linux:**
|
||
|
||
```bash
|
||
curl -fsSL https://docs.ac/install | bash
|
||
```
|
||
|
||
**Windows (PowerShell):**
|
||
|
||
```powershell
|
||
irm https://docs.ac/install.ps1 | iex
|
||
```
|
||
|
||
The installer gets [uv](https://docs.astral.sh/uv/), installs the `docsgpt` Python package with it, and runs `docsgpt up`. That asks who should reach DocsGPT (only this computer, your network, or a domain with HTTPS) and which model provider to use, then starts it, at http://localhost:7091 for a local install. Afterwards, `docsgpt status`, `docsgpt logs`, `docsgpt upgrade`, `docsgpt down` and `docsgpt uninstall` manage it.
|
||
|
||
To read the script before running it:
|
||
|
||
```bash
|
||
curl -fsSL https://docs.ac/install -o install.sh
|
||
less install.sh
|
||
bash install.sh
|
||
```
|
||
|
||
A more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available in our documentation.
|
||
|
||
### From a clone, with the setup script
|
||
|
||
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
|
||
|
||
- **docsgpt** - Backend Flask application (the `docsgpt` Python package).
|
||
|
||
- **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⚡
|
||
|
||
<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.
|
||
|
||
## This project is supported by:
|
||
|
||
<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>
|
||
<p>
|
||
<a href="https://get.neon.com/docsgpt">
|
||
<img width="201" alt="color" src="https://github.com/user-attachments/assets/7d9813b7-0e6d-403f-b5af-68af066b326f" />
|
||
</a>
|
||
|
||
</p>
|