BirdLense Hub — Документация
Версия 0.3.2 (источник правды: корневой файл
VERSION) · OpenAPI: YAML · Интерактив: Redoc · Сайт доков: gfermoto.github.io/BirdLense-Hub
Этот каталог — единый источник правды для администраторов, интеграторов и контрибьюторов: запуск, устранение проблем, расширение проекта и основа для сайта, вики или статей (см. OVERVIEW).
Три входа
| Путь | Задача | Куда идти |
|---|---|---|
| Запуск | Docker, камеры, прод | OVERVIEW → INSTALL → SCENARIOS |
| Интеграции | Frigate, BirdNET, MQTT, HA, Telegram | SCENARIOS → CONFIGURATION |
| Разработка | Код, тесты, релизы | Структура репозитория → LOCAL_DEV → TESTING → Contributing |
Продукт и справка
| Тема | English | Русский |
|---|---|---|
| Краткое описание (About на GitHub, анонсы) | EN | RU |
| О проекте (лендинг, статьи) | OVERVIEW | RU |
| Установка и деплой | INSTALL | RU |
| Сценарии | SCENARIOS | RU |
| Конфигурация | CONFIGURATION | RU |
| Термины (Hub, Frigate, слияние…) | GLOSSARY | RU |
| Возможности и API | FEATURES | RU |
| Архитектура | ARCHITECTURE | RU |
| API | API · OpenAPI Redoc | RU · Redoc |
| Версионирование | VERSIONING | RU |
| Чеклист деплоя на сервер | DEPLOY_SERVER | RU |
Безопасность и эксплуатация
| Тема | Документ |
|---|---|
| Доступ и пароли | ACCESS_CONTROL |
| Риски и рекомендации | SECURITY |
| Восстановление конфига | RECOVERY_CONFIG |
| Не работает | TROUBLESHOOTING |
Качество и инструменты
| Тема | Документ |
|---|---|
| Тесты и проверка после деплоя | TESTING |
| Журнал автоматической верификации (релизы / критические фиксы) | VERIFICATION |
| MCP (Model Context Protocol — внешние ИИ-ассистенты) | MCP_SETUP |
ML, данные, план
| Тема | English | Русский |
|---|---|---|
| Обучение моделей | TRAINING | RU |
| Датасеты и скрипты | DATASETS | RU |
| Версионирование | VERSIONING | RU |
| Roadmap | ROADMAP | RU |
Мета
| Тема | Документ |
|---|---|
| Структура репозитория (онбординг) | REPOSITORY_LAYOUT · RU |
| Как вести документацию | Documentation |
Анализ безопасности (docs/) |
SECURITY · RU |
| Ротация секретов (прод) | SECRETS_ROTATION.ru.md · EN |
| Чеклист open-source | OPEN_SOURCE_PREP · RU |
| Управление и внешний наблюдатель | GOVERNANCE.ru.md · EN |
| Issues, доска и процесс | ROADMAP.ru.md § Триаж · EN; корневой CONTRIBUTING.ru.md |
| Настройка GitHub через gh | GITHUB_SETUP_GH.ru.md · EN |
| Wiki и отчёты CI | WIKI_AUTOMATION.ru.md · EN |
| Статус переводов | I18N_STATUS |
Разделы ↔ файлы (сверка с mkdocs.yml) |
SITE_MAP · EN |
| MkDocs и GitHub Pages | Documentation.ru.md § Статический сайт |
| Архив | archive/README (в репозитории; не входит в сборку MkDocs) |
Команды (из корня репозитория)
| Цель | Команда |
|---|---|
| Локально | cd app && make local → http://localhost:8085 |
| Web-тесты | cd app && make test-web |
| Telegram proxy autorotate | make proxy-rotation-install (статус: make proxy-rotation-status) |
| Полный индекс | Вы здесь ✓ |
| Предпросмотр статического сайта | pip install -r requirements-docs.txt && mkdocs serve (подробности) |
Деплой на сервер: INSTALL.