diff --git a/README.md b/README.md new file mode 100644 index 0000000..22883b5 --- /dev/null +++ b/README.md @@ -0,0 +1,105 @@ +![VTB logo](https://vtb-league.com/docs/brand/2019/VTB%20League%20logo%20RGB.png) + +RFB Stat - это система для автоматического сбора баскетбольной статистики. +Система состоит из двух основных компонентов: + + Сервис данных (rfb-data.service) - сбор и обработка данных + + Сервис визуализации (rfb-visual.service) - веб-интерфейс на основе Streamlit + +Требования + +* Ubuntu Linux +* Доступ к репозиторию `https://git.tvstart.ru/` +* *Права root для установки!!* + +# Установка + +Скрипт установки выполняет полную настройку системы: + +```shell +chmod +x deploy.sh +./deploy.sh -t <команда> -r <релиз> +``` +Параметры командной строки + + -t - Название команды (опционально, определяется по IP если не указано) + + -r - Релиз (ветка или тег в git, по умолчанию: main) + + -h - Справка по использованию + +# Примеры использования + +Установка с автоопределением команды по IP +```shell +./deploy.sh -r main +``` +Установка для конкретной команды +```shell +./deploy.sh -t cska -r main +``` +Установка тестовой версии +```shell +./deploy.sh -t zenit -r Barabanov_TEST +``` +# Пакеты и прочее что будет установленно: +Системные пакеты: + +* Python3 +* pip3 +* virtualenv +* Git +* Net-tools + +Виртуальное окружение Python с зависимостями: + +* streamlit +* requests +* pandas +* numpy +* plotly +* watchdog +* pillow +* streamlit_autorefresh + +# Systemd сервисы: + +`rfb-data.service - сбор данных` + +`rfb-visual.service - веб-интерфейс` + + +# Управление сервисами +Просмотр статуса обоих сервисов одновременно +```shell +systemctl status rfb-data.service rfb-visual.service +``` +# Просмотр логов +Логи сбора данных +```shell +journalctl -u rfb-data.service -f +``` +Логи веб-интерфейса +```shell +journalctl -u rfb-visual.service -f +``` + +# Управление сервисами +Перезапуск всех сервисов +```shell +systemctl restart rfb-data.service rfb-visual.service +``` +Остановка всех сервисов +```shell +systemctl stop rfb-data.service rfb-visual.service +``` +Запуск всех сервисов +```shell +systemctl start rfb-data.service rfb-visual.service +``` +# Доступ к приложению + +После установки приложение доступно по адресу: + +`http://ВАШ_IP_АДРЕС:8501`