onyx README

The project's README from github.com/onyx-dot-app/onyx. As one markdown file: README.md.

Discord Documentation Documentation License

onyx-dot-app/onyx | Trendshift

Onyx - The Open Source AI Platform

Onyx is the application layer for LLMs - bringing a feature-rich interface that can be easily hosted by anyone. Onyx enables LLMs through advanced capabilities like RAG, web search, code execution, file creation, deep research and more.

Connect your applications with over 50+ indexing based connectors provided out of the box or via MCP.

[!TIP] Deploy with a single command:

curl -fsSL https://onyx.app/install_onyx.sh | bash

Onyx Chat Silent Demo


⭐ Features

Onyx supports all major LLM providers, both self-hosted (like Ollama, LiteLLM, vLLM, etc.) and proprietary (like Anthropic, OpenAI, Gemini, etc.).

To learn more - check out our docs!


🚀 Deployment Modes

Onyx supports deployments in Docker, Kubernetes, Helm/Terraform and provides guides for major cloud providers. Detailed deployment guides found here.

Onyx supports two separate deployment options: standard and lite.

Onyx Lite

The Lite mode can be thought of as a lightweight Chat UI. It requires less resources (under 1GB memory) and runs a less complex stack. It is great for users who want to test out Onyx quickly or for teams who are only interested in the Chat UI and Agents functionalities.

Standard Onyx

The complete feature set of Onyx which is recommended for serious users and larger teams. Additional components not included in Lite mode:

[!TIP]
To try Onyx for free without deploying, visit Onyx Cloud.


🏢 Onyx for Enterprise

Onyx is built for teams of all sizes, from individual users to the largest global enterprises:

📚 Licensing

There are two editions of Onyx:

For feature details, check out our website.

👪 Community

Join our open source community on Discord!

💡 Contributing

Looking to contribute? Please check out the Contribution Guide for more details.

onyx (onyx-dot-app/onyx)

Searching Database…

32.5K ·GitHub
这是什么?Onyx 是一个开源的 AI 平台,可以在任意大语言模型之上提供功能完整的聊天界面,并内置 RAG、网络搜索、智能体等功能。
这是我要导入到代码里的库,还是要自己部署的应用?这是一个自托管应用(后端加 Next.js 前端),需要你自己部署,而不是可以添加到代码中的库。
我该怎么让它运行起来?只需一条命令即可部署,并且提供 Docker、Kubernetes、Helm/Terraform 或主流云服务商的部署指南。
使用它是否需要我自己的大语言模型或 API 密钥?需要。你需要将它连接到一个大语言模型服务商,可以是闭源 API(Anthropic、OpenAI、Gemini),也可以是自托管的模型服务器,例如 Ollama、LiteLLM 或 vLLM。
Onyx Lite 和 Standard 版部署有什么区别?Lite 是轻量级聊天界面,内存需求不到 1GB;Standard 版则增加了用于 RAG 的向量和关键词索引、用于连接器同步的后台工作进程、推理服务器、Redis 缓存和 MinIO 对象存储。
这是面向个人,还是面向全公司部署的?两者皆可。从单个用户试用,到配备 SSO、RBAC、审计日志和白标定制的企业级推广,它都能扩展。
我的数据会留在自己的基础设施中吗?由于 Onyx 是端到端自托管的(包括聊天、索引和推理),你的数据和文档会留在自己的部署环境中,而不会发送到第三方 SaaS 服务。
这套东西是完全免费的,还是有部分收费?社区版在 MIT 许可证下完全免费,涵盖聊天、RAG、智能体和动作功能;企业版则增加了面向大型组织的额外功能。
‘深度研究’模式是什么?这是一个多步骤的研究流程,会生成深入的报告,而不是单轮回答;README 中提到它‘截至 2026 年 2 月位居排行榜榜首’。
Onyx 能连接聊天窗口之外的工具吗?可以。通过 Actions 和 MCP,Onyx 的智能体可以借助灵活的认证选项与外部应用交互,此外还内置了 50 多种索引连接器。
我能用说话代替打字与 Onyx 交流吗?可以,语音模式支持通过文字转语音和语音转文字进行对话。
Onyx 的网络搜索是如何工作的?它支持 Serper、Google PSE、Brave 和 SearXNG 等搜索服务商,另外还有内置的网页爬虫,并集成了 Firecrawl 和 Exa。
Size
280.3 MB
Stars
32.5K
Age
3y
Commits · 90 Days