mirror of
https://github.com/danswer-ai/danswer.git
synced 2025-03-17 13:22:42 +01:00
6ca400ced9
* Add Missing Date and Message-ID Headers to Ensure Email Delivery * fix issue Performance issue during connector deletion #4191 * fix ruff * bump to rebuild PR --------- Co-authored-by: ThomaciousD <2194608+ThomaciousD@users.noreply.github.com> Co-authored-by: Richard Kuo (Danswer) <rkuo@onyx.app>
118 lines
5.1 KiB
Markdown
118 lines
5.1 KiB
Markdown
<!-- DANSWER_METADATA={"link": "https://github.com/onyx-dot-app/onyx/blob/main/README.md"} -->
|
|
|
|
<a name="readme-top"></a>
|
|
|
|
<h2 align="center">
|
|
<a href="https://www.onyx.app/"> <img width="50%" src="https://github.com/onyx-dot-app/onyx/blob/logo/OnyxLogoCropped.jpg?raw=true)" /></a>
|
|
</h2>
|
|
|
|
<p align="center">
|
|
<p align="center">Open Source Gen-AI + Enterprise Search.</p>
|
|
|
|
<p align="center">
|
|
<a href="https://docs.onyx.app/" target="_blank">
|
|
<img src="https://img.shields.io/badge/docs-view-blue" alt="Documentation">
|
|
</a>
|
|
<a href="https://join.slack.com/t/onyx-dot-app/shared_invite/zt-2twesxdr6-5iQitKZQpgq~hYIZ~dv3KA" target="_blank">
|
|
<img src="https://img.shields.io/badge/slack-join-blue.svg?logo=slack" alt="Slack">
|
|
</a>
|
|
<a href="https://discord.gg/TDJ59cGV2X" target="_blank">
|
|
<img src="https://img.shields.io/badge/discord-join-blue.svg?logo=discord&logoColor=white" alt="Discord">
|
|
</a>
|
|
<a href="https://github.com/onyx-dot-app/onyx/blob/main/README.md" target="_blank">
|
|
<img src="https://img.shields.io/static/v1?label=license&message=MIT&color=blue" alt="License">
|
|
</a>
|
|
</p>
|
|
|
|
<strong>[Onyx](https://www.onyx.app/)</strong> (formerly Danswer) is the AI platform connected to your company's docs, apps, and people.
|
|
Onyx provides a feature rich Chat interface and plugs into any LLM of your choice.
|
|
Keep knowledge and access controls sync-ed across over 40 connectors like Google Drive, Slack, Confluence, Salesforce, etc.
|
|
Create custom AI agents with unique prompts, knowledge, and actions that the agents can take.
|
|
Onyx can be deployed securely anywhere and for any scale - on a laptop, on-premise, or to cloud.
|
|
|
|
|
|
<h3>Feature Highlights</h3>
|
|
|
|
**Deep research over your team's knowledge:**
|
|
|
|
https://private-user-images.githubusercontent.com/32520769/414509312-48392e83-95d0-4fb5-8650-a396e05e0a32.mp4?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk5Mjg2MzYsIm5iZiI6MTczOTkyODMzNiwicGF0aCI6Ii8zMjUyMDc2OS80MTQ1MDkzMTItNDgzOTJlODMtOTVkMC00ZmI1LTg2NTAtYTM5NmUwNWUwYTMyLm1wND9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE5VDAxMjUzNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWFhMzk5Njg2Y2Y5YjFmNDNiYTQ2YzM5ZTg5YWJiYTU2NWMyY2YwNmUyODE2NWUxMDRiMWQxZWJmODI4YTA0MTUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.a9D8A0sgKE9AoaoE-mfFbJ6_OKYeqaf7TZ4Han2JfW8
|
|
|
|
|
|
**Use Onyx as a secure AI Chat with any LLM:**
|
|
|
|
|
|
|
|
|
|
**Easily set up connectors to your apps:**
|
|
|
|
|
|
|
|
|
|
**Access Onyx where your team already works:**
|
|
|
|
|
|
|
|
|
|
## Deployment
|
|
**To try it out for free and get started in seconds, check out [Onyx Cloud](https://cloud.onyx.app/signup)**.
|
|
|
|
Onyx can also be run locally (even on a laptop) or deployed on a virtual machine with a single
|
|
`docker compose` command. Checkout our [docs](https://docs.onyx.app/quickstart) to learn more.
|
|
|
|
We also have built-in support for high-availability/scalable deployment on Kubernetes.
|
|
References [here](https://github.com/onyx-dot-app/onyx/tree/main/deployment).
|
|
|
|
|
|
## 🔍 Other Notable Benefits of Onyx
|
|
- Custom deep learning models for indexing and inference time, only through Onyx + learning from user feedback.
|
|
- Flexible security features like SSO (OIDC/SAML/OAuth2), RBAC, encryption of credentials, etc.
|
|
- Knowledge curation features like document-sets, query history, usage analytics, etc.
|
|
- Scalable deployment options tested up to many tens of thousands users and hundreds of millions of documents.
|
|
|
|
|
|
## 🚧 Roadmap
|
|
- New methods in information retrieval (StructRAG, LightGraphRAG, etc.)
|
|
- Personalized Search
|
|
- Organizational understanding and ability to locate and suggest experts from your team.
|
|
- Code Search
|
|
- SQL and Structured Query Language
|
|
|
|
|
|
## 🔌 Connectors
|
|
Keep knowledge and access up to sync across 40+ connectors:
|
|
|
|
- Google Drive
|
|
- Confluence
|
|
- Slack
|
|
- Gmail
|
|
- Salesforce
|
|
- Microsoft Sharepoint
|
|
- Github
|
|
- Jira
|
|
- Zendesk
|
|
- Gong
|
|
- Microsoft Teams
|
|
- Dropbox
|
|
- Local Files
|
|
- Websites
|
|
- And more ...
|
|
|
|
See the full list [here](https://docs.onyx.app/connectors).
|
|
|
|
|
|
## 📚 Licensing
|
|
There are two editions of Onyx:
|
|
|
|
- Onyx Community Edition (CE) is available freely under the MIT Expat license. Simply follow the Deployment guide above.
|
|
- Onyx Enterprise Edition (EE) includes extra features that are primarily useful for larger organizations.
|
|
For feature details, check out [our website](https://www.onyx.app/pricing).
|
|
|
|
To try the Onyx Enterprise Edition:
|
|
1. Checkout [Onyx Cloud](https://cloud.onyx.app/signup).
|
|
2. For self-hosting the Enterprise Edition, contact us at [founders@onyx.app](mailto:founders@onyx.app) or book a call with us on our [Cal](https://cal.com/team/onyx/founders).
|
|
|
|
|
|
## 💡 Contributing
|
|
Looking to contribute? Please check out the [Contribution Guide](CONTRIBUTING.md) for more details.
|
|
|