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)

sso
Searching Database…

32.5K ·GitHub
What is this?Onyx is an open source AI platform that gives you a full-featured chat interface on top of any LLM, with built-in RAG, web search, agents, and more.
Is this a library I import, or an app I deploy?It's a self-hosted application (backend + Next.js frontend) that you deploy yourself, not a library you add to code.
How do I get it running?You deploy it with a single command, and there are guides for Docker, Kubernetes, Helm/Terraform, or major cloud providers.
Do I need my own LLM or API keys to use it?Yes, you connect it to an LLM provider, either a proprietary API (Anthropic, OpenAI, Gemini) or a self-hosted model server like Ollama, LiteLLM, or vLLM.
What's the difference between Onyx Lite and the Standard deployment?Lite is a lightweight Chat UI needing under 1GB memory, while Standard adds the vector/keyword index for RAG, background workers for connector syncing, inference servers, Redis cache, and MinIO blob storage.
Is this meant for individuals or for company-wide deployment?Both — it scales from a single user testing it out to enterprise rollouts with SSO, RBAC, audit logs, and whitelabeling.
Does my data stay on my own infrastructure?Since Onyx is self-hosted end-to-end (chat, indexing, and inference), your data and documents stay within your own deployment rather than going to a third-party SaaS.
Is the whole thing free, or is some of it paid?The Community Edition is fully free under MIT and covers chat, RAG, agents, and actions; an Enterprise Edition adds extra features aimed at larger organizations.
What is 'Deep Research' mode?It's a multi-step research flow that produces in-depth reports instead of a single-turn answer; the README notes it was 'top of leaderboard as of Feb 2026'.
Can Onyx connect to tools outside the chat window?Yes, via Actions and MCP, Onyx agents can interact with external applications using flexible auth options, on top of 50+ built-in indexing connectors.
Can I talk to Onyx instead of typing?Yes, Voice Mode lets you chat using text-to-speech and speech-to-text.
How does web search work in Onyx?It supports search providers like Serper, Google PSE, Brave, and SearXNG, plus an in-house web crawler and integrations with Firecrawl/Exa.
Size
274.1 MB
Stars
32.5K
Age
3y
Commits · 90 Days