diff --git a/README.md b/README.md new file mode 100644 index 0000000..ba138d8 --- /dev/null +++ b/README.md @@ -0,0 +1,129 @@ +RFB Stat - это система для автоматического сбора баскетбольной статистики. +Система состоит из двух основных компонентов: + + Сервис данных (rfb-data.service) - сбор и обработка данных + + Сервис визуализации (rfb-visual.service) - веб-интерфейс на основе Streamlit + +Требования + + Ubuntu Linux + + Доступ к репозиторию https://git.tvstart.ru/ychernenko/RFB.git + + Права root для установки!! + +Установка +Автоматическая установка + +Скрипт установки выполняет полную настройку системы: +bash + +chmod +x deploy.sh +./deploy.sh -t <команда> -r <релиз> + +Параметры командной строки + + -t - Название команды (опционально, определяется по IP если не указано) + + -r - Релиз (ветка или тег в git, по умолчанию: main) + + -h - Справка по использованию + +Примеры использования +bash + +# Установка с автоопределением команды по IP +./deploy.sh -r main + +# Установка для конкретной команды +./deploy.sh -t cska -r main + +# Установка тестовой версии +./deploy.sh -t zenit -r Barabanov_TEST + +# Пакеты и прочее что будет установленно: + Системные пакеты: + + Python3, pip, virtualenv + + Git + + Systemd + + Net-tools + + Виртуальное окружение Python с зависимостями: + + streamlit + + requests + + pandas + + numpy + + plotly + + watchdog + + pillow + + streamlit_autorefresh + + Systemd сервисы: + + rfb-data.service - сбор данных + + rfb-visual.service - веб-интерфейс + + Настройка firewall для порта 8501 + +# Управление сервисами +Просмотр статуса + + systemctl status rfb-data.service rfb-visual.service + +# Просмотр логов + +Логи сбора данных + journalctl -u rfb-data.service -f + +Логи веб-интерфейса + 'journalctl -u rfb-visual.service -f' + +#Управление сервисами + Перезапуск всех сервисов + systemctl restart rfb-data.service rfb-visual.service + +Остановка всех сервисов + systemctl stop rfb-data.service rfb-visual.service + +Запуск всех сервисов + systemctl start rfb-data.service rfb-visual.service + +# Доступ к приложению + +После установки приложение доступно по адресу: +text + +http://ВАШ_IP_АДРЕС:8501 + +#Структура проекта + + /root/RFB/ + ├── .venv/ # Виртуальное окружение Python + ├── visual.py # Веб-интерфейс Streamlit + ├── get_data.py # Скрипт сбора данных + ├── requirements.txt # Зависимости Python + └── start_rfb.sh # Скрипт запуска (устарел) + + +Проверьте настройки firewall: +bash + +ufw status + +Контакты + +Для получения технической поддержки обращайтесь к разработчикам системы. \ No newline at end of file