Thomas
6ea7a6ff09
* Add Homarr provider proxy foundation * Complete Homarr provider integration * Harden Homarr provider integration * Address Homarr provider review feedback * Address CodeRabbit provider feedback * Localize provider errors * Handle provider activity load failures * docs: improve workshop and homepage * Harden Homarr provider limits * fix: harden the Homarr provider * fix: address provider review feedback * fix: clarify provider request accounting * feat: complete the Homarr provider endpoint * fix: terminate invalid provider streams
55 lines
2.2 KiB
Plaintext
55 lines
2.2 KiB
Plaintext
---
|
|
title: Homarr provider
|
|
sidebar_position: 2
|
|
tags:
|
|
- Assistant
|
|
- AI
|
|
- Privacy
|
|
- Community
|
|
---
|
|
|
|
import { OpenCollectiveLink } from "@site/src/components/assistant-provider/open-collective-link";
|
|
|
|
# Homarr provider
|
|
|
|
The Homarr provider gives Workshop users access to the **Homarr model** without an administrator API key. The Homarr
|
|
team selects a capable model based on quality, reliability, and cost, and can change the upstream model without
|
|
changing the user-facing provider. Each user signs in with GitHub and receives a separate daily allowance.
|
|
|
|
## Set it up
|
|
|
|
1. Open **Management → Assistant**.
|
|
2. Select **Homarr** as the provider.
|
|
3. Save the provider connection.
|
|
4. Select the available model, enable the assistant, and save.
|
|
5. Open the assistant and sign in to the Workshop when asked.
|
|
|
|
## Daily allowance
|
|
|
|
- Each user starts with **50 request units per UTC day**.
|
|
- Each model request uses one unit. Agent tool loops can make multiple model requests.
|
|
- Once Workshop forwards a request, it uses one unit even if the upstream later fails. This prevents failed requests
|
|
from bypassing the shared cost and abuse limits.
|
|
- The allowance resets at 00:00 UTC.
|
|
|
|
The battery beside the model selector shows the remaining allowance and reset time. The Workshop server enforces the
|
|
limit before it sends a request to OpenRouter.
|
|
|
|
## Data and cost
|
|
|
|
The Workshop keeps the OpenRouter API key on its server. It does not send that key to Homarr or the browser.
|
|
|
|
Prompts, attachments, tool definitions, and tool results are sent through OpenRouter to generate a response. The
|
|
Workshop proxy does not retain that content, responses, or per-request telemetry. It stores only the Workshop user,
|
|
UTC day, and counters required to enforce per-user and global daily allowances. Requests require OpenRouter routing
|
|
with zero data retention and data collection disabled. Homarr does not use this content to train language models.
|
|
|
|
We would rather become millionaires in a more ethical manner.
|
|
|
|
The Homarr community pays for these requests. Donations help cover the cost.
|
|
|
|
<OpenCollectiveLink />
|
|
|
|
Workshop operators can change the upstream model, per-user allowance, global allowance, and security limits in the
|
|
[Workshop operator guide](./operator#homarr-provider-proxy).
|