Files
EvoBGP/README.md
T
Denozordec 5d21f013cf
CI / changes (push) Successful in 5s
CI / go (push) Successful in 19s
CI / openapi (push) Has been skipped
CI / bird2 (push) Successful in 16s
docs: update README to include information about the EvoBGP web interface, linking to quickstart and access documentation for setup and configuration.
2026-04-05 17:10:21 +07:00

2.4 KiB
Raw Blame History

EvoBGP

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

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

Документ Содержание
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
docker compose --profile microvps up -d --build

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

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

docker compose --profile reference up -d --build

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

Разработка

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

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