diff --git a/README.md b/README.md index bb08819d6..27bfd040d 100644 --- a/README.md +++ b/README.md @@ -290,6 +290,7 @@ See the [API documentation](./docs/api.md) for all endpoints. ### Web & Desktop +- [Onyx](https://github.com/onyx-dot-app/onyx) - [Open WebUI](https://github.com/open-webui/open-webui) - [SwiftChat (macOS with ReactNative)](https://github.com/aws-samples/swift-chat) - [Enchanted (macOS native)](https://github.com/AugustDev/enchanted) diff --git a/docs/docs.json b/docs/docs.json index 71a6f17a0..5457014a1 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -97,6 +97,7 @@ { "group": "Integrations", "pages": [ + "/integrations/onyx", "/integrations/vscode", "/integrations/jetbrains", "/integrations/codex", diff --git a/docs/images/onyx-login.png b/docs/images/onyx-login.png new file mode 100644 index 000000000..4234e983c Binary files /dev/null and b/docs/images/onyx-login.png differ diff --git a/docs/images/onyx-ollama-form.png b/docs/images/onyx-ollama-form.png new file mode 100644 index 000000000..b2342015b Binary files /dev/null and b/docs/images/onyx-ollama-form.png differ diff --git a/docs/images/onyx-ollama-llm.png b/docs/images/onyx-ollama-llm.png new file mode 100644 index 000000000..8b29b2aa1 Binary files /dev/null and b/docs/images/onyx-ollama-llm.png differ diff --git a/docs/images/onyx-query.png b/docs/images/onyx-query.png new file mode 100644 index 000000000..373354562 Binary files /dev/null and b/docs/images/onyx-query.png differ diff --git a/docs/integrations/onyx.mdx b/docs/integrations/onyx.mdx new file mode 100644 index 000000000..e0587efb2 --- /dev/null +++ b/docs/integrations/onyx.mdx @@ -0,0 +1,63 @@ +--- +title: Onyx +--- + +## Overview +[Onyx](http://onyx.app/) is a self-hostable Chat UI that integrates with all Ollama models. Features include: +- Creating custom Agents +- Web search +- Deep Research +- RAG over uploaded documents and connected apps +- Connectors to applications like Google Drive, Email, Slack, etc. +- MCP and OpenAPI Actions support +- Image generation +- User/Groups management, RBAC, SSO, etc. + +Onyx can be deployed for single users or large organizations. + +## Install Onyx + +Deploy Onyx with the [quickstart guide](https://docs.onyx.app/deployment/getting_started/quickstart). + + +Resourcing/scaling docs [here](https://docs.onyx.app/deployment/getting_started/resourcing). + + +## Usage with Ollama + +1. Login to your Onyx deployment (create an account first). +
+ Onyx Login Page +
+2. In the set-up process select `Ollama` as the LLM provider. +
+ Onyx Set Up Form +
+3. Provide your **Ollama API URL** and select your models. +If you're running Onyx in Docker, to access your computer's local network use `http://host.docker.internal` instead of `http://127.0.0.1`. +
+ Selecting Ollama Models +
+ +You can also easily connect up Onyx Cloud with the `Ollama Cloud` tab of the setup. + +## Send your first query +
+ Onyx Query Example +
\ No newline at end of file