avm/hassio-addons
1
0 Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-11-04 03:42:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
hassio-addons/omniroute
T
History

README.md

Home Assistant add-on: OmniRoute

I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons.

If this add-on saves you time or makes your setup easier, I would be very grateful for your support!

Buy me a coffee Donate via PayPal

Addon informations

Version Ingress Arch

Codacy Badge GitHub Super-Linter Builder

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

Stargazers repo roster for @alexbelgium/hassio-addons

downloads evolution

About

OmniRoute is an open-source, self-hosted AI inference gateway and proxy providing a unified OpenAI-compatible endpoint with intelligent fallbacks, load balancing, quota pooling, token compression, and routing across 350+ AI providers.

Key features:

  • Unified OpenAI-Compatible Gateway: Drop-in replacement supporting /v1/chat/completions, native /v1/responses, vision, and tool calling.
  • Smart Fallbacks & Quotas: Seamlessly retries alternative providers or fallback models in milliseconds on rate limits, errors, or quota exhaustion.
  • Context & Token Compression: Built-in prompt and context compression engines to reduce token consumption and costs.
  • IDE & Assistant Ready: Integrates seamlessly with Cursor, Claude Code, Cline, Roo Code, Aider, OpenCode, VS Code, and other developer tools.
  • Management Web UI: Local dashboard to configure providers, API keys, fallback routes, quota tracking, and view real-time latency and call logs.
  • Home Assistant Ingress: Direct access from the Home Assistant sidebar and Open Web UI without leaving your dashboard.

Installation

  1. Add this repository to your Home Assistant instance: Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.
  2. Install the OmniRoute add-on.
  3. Configure the add-on options (e.g. set an INITIAL_PASSWORD for the admin web UI).
  4. Start the add-on.
  5. Click Open Web UI to access via Home Assistant Ingress.

Configuration

Web UI is accessible via Home Assistant Ingress. Direct network access on port 20128 is disabled (null) by default for security; set a host port (e.g. 20128) under the Configuration tab if you wish to expose the gateway directly on your LAN.

Options

Option Type Default Description
INITIAL_PASSWORD password (unset) Initial password for the administrator account on first setup. If unset, the password is created via the onboarding wizard in the web UI.
REQUIRE_API_KEY bool true When true, proxy requests to /v1 require a valid API key configured in OmniRoute.
OMNIROUTE_MEMORY_MB int 1024 Maximum Node.js V8 old space memory in megabytes for the inference gateway.
TZ str (unset) Timezone for the container (e.g. Europe/Paris).
env_vars list [] Arbitrary environment variables passed into OmniRoute.

Connecting Developer Tools

Configure your coding assistants to connect to the OmniRoute gateway:

  • Base URL: http://<homeassistant-ip>:20128/v1
  • API Key: The API key generated in the OmniRoute dashboard (under API Keys)
Reference in new issue View Git Blame Copy Permalink