free-router-proxy README

The project's README from github.com/www222fff/free-router-proxy. As one markdown file: README.md.

Free Router

Free Router architecture: any OpenAI client to a local gateway to pluggable providers

Local OpenAI-compatible gateway. Point any client at http://127.0.0.1:8787/v1 and use free-best. It ranks currently free models across any OpenAI-compatible provider you configure, then fails over when one is rate-limited, down, or empty. A missing key just drops that provider.

Site: www222fff.github.io/free-router

Run

Node.js 20+. Copy .env.example to .env, add at least one provider key, then:

git clone https://github.com/www222fff/free-router.git
cd free-router
cp .env.example .env
./start.sh

Stop with ./stop.sh. Docker: docker compose up -d. Open http://127.0.0.1:8787/ to set keys and watch usage.

Variable Where
GEMINI_API_KEY Google AI Studio
OPENROUTER_API_KEY openrouter.ai/keys
TOKENROUTER_API_KEY TokenRouter
BAI_API_KEY chat.b.ai

More providers: add a block in config.json. See How it works.

./models.sh          # current free-best order
./models.sh --usage  # today's quota

Star History

Star History Chart

free-router-proxy (www222fff/free-router-proxy)

Searching Database…

Что это такое?Free Router — локальный шлюз, совместимый с OpenAI, который направляет ваш клиент к бесплатным моделям любого настроенного вами провайдера с OpenAI-совместимым API, ранжирует их и автоматически переключается, когда один лимитирован по частоте, недоступен или не имеет ключа.
Это хостинговый сервис или то, что я запускаю сам?Это самостоятельно размещаемый локальный сервер (приложение Node.js или Docker-контейнер), который вы запускаете на своей машине, а не облачный сервис.
Как его запустить?Запустите на Node.js 20+: скопируйте .env.example в .env, добавьте хотя бы один ключ провайдера, затем стартуйте сервер; остановка — через ./stop.sh. Либо запустите через Docker Compose командой 'docker compose up -d'.
Что нужно перед запуском?Нужны Node.js 20 или новее (или Docker, если используете compose-вариант) и хотя бы один API-ключ от OpenAI-совместимого провайдера, предлагающего бесплатные модели.
Что будет, если бесплатная квота провайдера исчерпается?Если настроенный провайдер лимитирован, недоступен или пуст, Free Router автоматически переключается на следующего в рейтинге; провайдер без настроенного ключа просто пропускается.
На каких платформах это можно запускать?Работает везде, где доступен Node.js 20+ или Docker, включая Linux, macOS и Windows.
Как он выбирает, какую бесплатную модель использовать?Он ранжирует актуальные бесплатные модели у всех настроенных вами OpenAI-совместимых провайдеров и направляет к лучшей доступной, автоматически переключаясь при сбое.
Можно ли направить на него мой существующий OpenAI-клиент?Да, поскольку он открывает OpenAI-совместимый API, достаточно направить любой имеющийся OpenAI-клиент на локальный эндпоинт Free Router вместо эндпоинта провайдера.
Нужно ли настраивать каждого провайдера?Нет, достаточно добавить ключи для провайдеров, которых хотите использовать; провайдеры без настроенного ключа автоматически пропускаются.
Creator
www222fff
Size
0.6 MB
Stars
478
Age
1mo
Commits · 90 Days