mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-11-04 03:42:14 +00:00
2f733f33f5
* feat(omniroute): add OmniRoute add-on v3.8.52 * docs(omniroute): fix markdown list spacing and table formatting * fix(omniroute): sanitize nginx log format, drop json sub_filter, and drop privileges when PUID configured * fix(omniroute): use --clear-groups in setpriv to allow numeric PUID without passwd entry * fix(omniroute): ensure cp error stops migration before rm -rf deletes data * refactor(omniroute): simplify and align with repo architecture based on maintainer review * omniroute: keep upstream CSP, fix healthcheck, drop non-Supervisor fallbacks - ingress.conf: rewrite only frame-ancestors 'none' -> 'self' in upstream's CSP (nginx map) instead of replacing it with a broad one - Dockerfile: healthcheck used '&>' which dash (/bin/sh) parses as a background job, so it could never fail; use '>/dev/null 2>&1' - drop :-/ingress, :-8099, :-0.0.0.0 and || true fallbacks - delete 20-config_location.sh (only created the mounted /config) - config.yaml: no empty INITIAL_PASSWORD default; OMNIROUTE_MEMORY_MB int - CHANGELOG/README: port 20128 is opt-in; TZ and password have no default Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * omniroute: wrap long config.yaml lines Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: BirdNET-Go Addon Builder <addon-builder@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
71 lines
5.5 KiB
Markdown
71 lines
5.5 KiB
Markdown
# 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][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
[OmniRoute](https://github.com/cheaper-inference/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:
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
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)
|