docs: update README to include information about the EvoBGP web interface, linking to quickstart and access documentation for setup and configuration.
This commit is contained in:
1 parent
6a55f72ab3
commit
5d21f013cf
8 files changed
+602
No files matched your search
@@ -0,0 +1,42 @@
|
||||
# EvoBGP
|
||||
|
||||
Control plane для управления префиксами, модулями ingest, ревизиями конфигурации BIRD и выкладкой на BGP-спикеры. Репозиторий включает HTTP API на Go, веб-интерфейс (`web/`), CLI для реплик (`evobgp-node`), агент и Docker Compose для локального и эталонного развёртывания.
|
||||
|
||||
## Документация
|
||||
|
||||
| Документ | Содержание |
|
||||
|----------|------------|
|
||||
| [docs/README.md](docs/README.md) | Оглавление и навигация по разделам |
|
||||
| [docs/overview.md](docs/overview.md) | Ключевые возможности продукта |
|
||||
| [docs/quickstart.md](docs/quickstart.md) | Быстрый запуск (Docker, локально, фронтенд) |
|
||||
| [docs/architecture.md](docs/architecture.md) | Архитектура компонентов и потоков данных |
|
||||
| [docs/api.md](docs/api.md) | Как работать с REST API и OpenAPI |
|
||||
| [docs/access.md](docs/access.md) | API-ключи, роли, нода, CORS, безопасность |
|
||||
|
||||
Контракт HTTP API: [docs/openapi.yaml](docs/openapi.yaml). Человекочитаемый просмотр: [docs/openapi.html](docs/openapi.html) (см. [docs/OPENAPI-GITEA.md](docs/OPENAPI-GITEA.md)).
|
||||
|
||||
## Быстрый старт (Docker)
|
||||
|
||||
Из каталога [deploy/compose](deploy/compose) (PowerShell):
|
||||
|
||||
```powershell
|
||||
cd deploy\compose
|
||||
docker compose --profile microvps up -d --build
|
||||
```
|
||||
|
||||
Профиль **microvps** поднимает `evobgp-all`, PostgreSQL, BIRD2 и агент. API по умолчанию: `http://localhost:8080`.
|
||||
|
||||
Эталонный стек (несколько сервисов, NATS, веб UI, Prometheus):
|
||||
|
||||
```powershell
|
||||
docker compose --profile reference up -d --build
|
||||
```
|
||||
|
||||
Подробности портов и переменных окружения — в [docs/quickstart.md](docs/quickstart.md) и в комментариях в [deploy/compose/docker-compose.yaml](deploy/compose/docker-compose.yaml).
|
||||
|
||||
## Разработка
|
||||
|
||||
- **Go:** модуль `evobgp`, точки входа в `cmd/`.
|
||||
- **Веб:** SvelteKit в каталоге `web/` (см. [web/README.md](web/README.md)).
|
||||
|
||||
Лицензия и условия использования — по политике владельца репозитория.
|
||||
Reference in new issue
Block a user