From c99f35ddc8dcd13c37d0f2f8de84e83290b9bd0d Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:38:57 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 169 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 169 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..0ae9179 --- /dev/null +++ b/README.en.md @@ -0,0 +1,169 @@ +

+ 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](https://img.shields.io/github/stars/arc53/docsgpt?style=social) + ![link to main GitHub showing Forks number](https://img.shields.io/github/forks/arc53/docsgpt?style=social) + ![link to license file](https://img.shields.io/github/license/arc53/docsgpt) + + ![link to discord](https://img.shields.io/discord/1070046503302877216) + ![X (formerly Twitter) URL](https://img.shields.io/twitter/follow/docsgptai) + +⚑️ Quickstart β€’ ☁️ Cloud Version β€’ πŸ’¬ Discord +
+πŸ“– Documentation β€’ πŸ‘« Contribute β€’ πŸ—ž Blog +
+ +
+ + +
+
+video-example-of-docs-gpt +
+

+ Key Features: +

+ + +## 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 available: using the public API, running locally, connecting to a local inference engine, using a cloud API provider, or build the docker image locally. 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 + +![Architecture chart](https://github.com/user-attachments/assets/fc6a7841-ddfc-45e6-b5a0-d05fe648cbe2) + +## Project Structure + +- Application - Flask app (main application). + +- Extensions - Extensions, like react widget or discord bot. + +- Frontend - Frontend uses Vite and React. + +- 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⚑ + + + 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: + +

+ + + +

+

+ + color + + +