docs: consolidate architecture docs into bible
This commit is contained in:
67
README.md
67
README.md
@@ -1,68 +1,11 @@
|
||||
# LOGPile
|
||||
|
||||
LOGPile — standalone Go-приложение для анализа диагностических данных BMC.
|
||||
Standalone Go application for BMC diagnostics analysis with an embedded web UI.
|
||||
|
||||
Поддерживает два сценария:
|
||||
1. Загрузка архивов/снапшотов и оффлайн-анализ в веб-интерфейсе.
|
||||
2. Live-сбор через Redfish API с последующим экспортом.
|
||||
## Documentation
|
||||
|
||||
## Сборка
|
||||
- Architecture and technical documentation (single source of truth): [`docs/bible/README.md`](docs/bible/README.md)
|
||||
|
||||
```bash
|
||||
make build # bin/logpile (текущая платформа)
|
||||
make build-all # все платформы в bin/
|
||||
```
|
||||
## License
|
||||
|
||||
Требования: Go 1.22+
|
||||
|
||||
## Запуск
|
||||
|
||||
```bash
|
||||
./bin/logpile
|
||||
./bin/logpile --port 8082
|
||||
./bin/logpile --no-browser
|
||||
./bin/logpile --version
|
||||
```
|
||||
|
||||
На Windows `--hold-on-crash` включён по умолчанию (консоль не закрывается при падении).
|
||||
|
||||
## macOS: снятие карантина
|
||||
|
||||
```bash
|
||||
xattr -d com.apple.quarantine /path/to/logpile-darwin-arm64
|
||||
```
|
||||
|
||||
## Форматы загрузки
|
||||
|
||||
`POST /api/upload` принимает:
|
||||
- архивы: `.tar`, `.tar.gz`, `.tgz`
|
||||
- JSON snapshot (`AnalysisResult`)
|
||||
|
||||
## Live Redfish
|
||||
|
||||
```bash
|
||||
POST /api/collect
|
||||
{
|
||||
"host": "bmc01.example.local",
|
||||
"protocol": "redfish",
|
||||
"port": 443,
|
||||
"username": "admin",
|
||||
"auth_type": "password",
|
||||
"password": "secret",
|
||||
"tls_mode": "insecure"
|
||||
}
|
||||
```
|
||||
|
||||
## Экспорт
|
||||
|
||||
- `GET /api/export/csv` — серийные номера
|
||||
- `GET /api/export/json` — полный AnalysisResult
|
||||
- `GET /api/export/reanimator` — формат Reanimator
|
||||
|
||||
## Архитектурная документация
|
||||
|
||||
→ [`docs/bible/`](docs/bible/README.md)
|
||||
|
||||
## Лицензия
|
||||
|
||||
MIT — см. `LICENSE`.
|
||||
MIT (see `LICENSE`)
|
||||
|
||||
Reference in New Issue
Block a user