Denozordec b8dbf15254
CI / changes (push) Successful in 5s
CI / commitlint (push) Skipped
CI / go (push) Skipped
CI / bird2 (push) Skipped
CI / openapi (push) Successful in 38s
CI / web (push) Successful in 54s
CI / release (push) Successful in 3m56s
feat(api): update types to support CIDR in lookup queries
Enhanced the API type definitions to include CIDR support alongside IP and domain in the lookup functionality. Updated relevant comments and descriptions to reflect the new capabilities, ensuring clarity in the API documentation.
2026-07-31 13:24:52 +07:00
2026-05-19 17:58:24 +00:00

EvoBGP

Control plane для управления префиксами, модулями ingest, ревизиями конфигурации BIRD и выкладкой на BGP-спикеры. Репозиторий включает HTTP API на Go, веб-интерфейс (web/), CLI для реплик (evobgp-node), агент и Docker Compose для локального и эталонного развёртывания.

Документация

Документ Содержание
AGENTS.md Краткая карта репозитория и советы для ИИ-агентов (экономия контекста)
docs/README.md Оглавление и навигация по разделам
docs/overview.md Ключевые возможности продукта
docs/quickstart.md Быстрый запуск (Docker, локально, фронтенд)
docs/architecture.md Архитектура компонентов и потоков данных
docs/api.md Как работать с REST API и OpenAPI
docs/access.md API-ключи, роли, нода, CORS, безопасность

Контракт HTTP API: docs/openapi.yaml. Человекочитаемый просмотр: docs/openapi.html (см. docs/OPENAPI-GITEA.md).

Быстрый старт (Docker)

Из каталога deploy/compose (PowerShell):

cd deploy\compose
Copy-Item .env.example .env -Force   # EVOBGP_REGISTRY=git.shts.su/<owner>
docker login git.shts.su
docker compose --profile microvps pull
docker compose --profile microvps up -d

Профиль microvps поднимает evobgp-all, PostgreSQL, BIRD2 и агент (образы из Container Registry, без --build). API по умолчанию: http://localhost:8080.

Эталонный стек (несколько сервисов, NATS, веб UI, Prometheus):

docker compose --profile reference pull
docker compose --profile reference up -d

Подробности портов и переменных окружения — в docs/quickstart.md и в комментариях в deploy/compose/docker-compose.yaml.

Разработка

  • Go: модуль evobgp, точки входа в cmd/.
  • Веб: SvelteKit в каталоге web/ (см. web/README.md).

Версионирование и релизы

Версии определяются автоматически из Conventional Commits при merge в main (semantic-release на Gitea Actions). Первая версия — 1.0.0; ручной bump не нужен.

  • docs/releasing.md — пайплайн, commit conventions, секреты CI
  • API: GET /version и GET /v1/version (поле version)
  • Docker-образы: теги latest, vX.Y.Z, X.Y.Z — в том же CI run, что и релиз (job release)

Лицензия и условия использования — по политике владельца репозитория.

S
Description
No description provided
Readme
5 MiB
v2.50.1
Latest
2026-08-31 10:21:59 +07:00
Languages
TypeScript 64.3%
Go 33.2%
Shell 1.4%
PowerShell 0.4%
HCL 0.2%
Other 0.5%