freebucks-proxy README

The project's README from github.com/trefeon/freebucks-proxy. As one markdown file: README.md.

freebuff-proxy

Go wire gateway in front of FreeBuff, with OpenAI-compatible and Anthropic endpoints plus an embedded Svelte dashboard.

What it is

Quickstart

cp .env.example .env   # then edit: AUTH_TOKENS, ADMIN_TOKEN, ...
go build ./backend/...
go run ./backend/cmd/freebuff-proxy

Then:

Defaults that matter (.env.example): SAFE_MODE=true (anti-ban preset), COST_MODE=free, 30 req/min and 1500 req/day Pacific limits.

Layout

Contributing

Protected main: branch → PR → green CI → squash merge, Conventional Commits. See AGENTS.md for the full operating guide. Never commit secrets.

freebucks-proxy (trefeon/freebucks-proxy)

Searching Database…

299 ·GitHub
archived
Что это?Шлюз на Go, который стоит перед FreeBuff и предоставляет совместимые с OpenAI и Anthropic чат-эндпоинты, переводя запросы в проводной протокол FreeBuff, со встроенной админ-панелью на Svelte.
Это прокси-сервер, который я запускаю сам, или hosted API?Это self-hosted прокси-сервер (бинарник или Docker-контейнер), который вы запускаете на своей машине; он предоставляет /v1/chat/completions, /v1/models и панель /admin.
Как его запустить?Настройте файл .env на основе .env.example, затем запустите Go-бэкенд (или используйте включённую связку Dockerfile/compose), чтобы поднять шлюз и встроенную панель по адресу /admin.
Нужны ли токены авторизации FreeBuff, чтобы это использовать?Да - он опирается на учётные данные FreeBuff. Заданный AUTHTOKENS включает режим пула или гибридный; пустой AUTHTOKENS переключает в режим моста, где каждый запрос должен нести свой собственный токен.
Проект ещё поддерживается?Нет - репозиторий явно помечен как устаревший и неподдерживаемый, так что обновления, исправления ошибок и совместимость с изменениями FreeBuff впредь не гарантируются.
Кто будет этим пользоваться?Разработчики, которые хотят общаться с FreeBuff через стандартные клиенты OpenAI или Anthropic API вместо нативного проводного протокола FreeBuff.
Какие три режима работы?Режим пула использует общий пул токенов (AUTHTOKENS задан, мост отключён); режим моста пересылает собственный токен каждого запроса (AUTHTOKENS пуст); гибридный режим (по умолчанию при заданном AUTHTOKENS) берёт учётные данные APIKEYS из пула, а любые другие пересылает как токен моста.
Как работает тарификация freebucks?Freebucks списываются раз в час сессии в момент её начала, возвращаются, если сессию удалили раньше времени, и пополняются по расписанию в полночь по тихоокеанскому времени в соответствии с картой проводных цен FreeBuff.
Есть ли встроенные лимиты запросов?Да, дефолтный .env.example поставляется с пресетом безопасного режима против бана, ограничивающим использование 30 запросами в минуту и 1500 запросами в день по тихоокеанскому времени.
Что показывает админ-панель?Это одностраничное приложение на Svelte, встроенное прямо в бинарник Go и обслуживаемое по /admin, для управления шлюзом и наблюдения за ним.
Creator
trefeon
Size
45.8 MB
Stars
299
Age
2mo
Commits · 90 Days