diff --git a/README.md b/README.md index daa9216..6dd0eab 100644 --- a/README.md +++ b/README.md @@ -1,89 +1,119 @@ -![VTB logo](https://vtb-league.com/docs/brand/2019/VTB%20League%20logo%20RGB.png) +![VTB Logo](https://vtb-league.com/docs/brand/2019/VTB%20League%20logo%20RGB.png) -RFB Stat - это система для автоматического сбора баскетбольной статистики. +# RFB Stat -Требования +**RFB Stat** — это система для автоматического сбора баскетбольной статистики. -* Ubuntu Linux -* Доступ к репозиторию `https://git.tvstart.ru/` -* *Права root для установки!!* +## Требования -# Установка +- **Ubuntu Linux** +- Доступ к репозиторию `https://git.tvstart.ru/` +- **Права root для установки** + +## Установка Скрипт установки выполняет полную настройку системы: ```shell chmod +x deploy.sh +``` +```shell ./deploy.sh -t <команда> -r <релиз> ``` -Параметры командной строки - -t - Название команды (опционально, определяется по IP если не указано) +### Параметры командной строки - -r - Релиз (ветка или тег в git, по умолчанию: main) +| Опция | Описание | +|-------|----------| +| `-t` | Название команды (опционально, определяется по IP, если не указано) | +| `-r` | Релиз (ветка или тег в git; по умолчанию: `main`) | +| `-l` | Лига (опционально) | +| `-h` | Справка по использованию | - -l Лига (опционально) +### Примеры использования - -h - Справка по использованию +1. **Установка с автоопределением команды по IP** -# Примеры использования + ```shell + ./deploy.sh + ``` + +2. **Установка для конкретной команды** + + ```shell + ./deploy.sh -t cska -r main + ``` + +3. **Установка тестовой версии** + + ```shell + ./deploy.sh -t zenit -r TEST -l vtb + ``` + +## Установленные пакеты и зависимости + +### Системные пакеты: + +- Python3 +- pip3 +- virtualenv +- Git +- Net-tools + +### Виртуальное окружение Python с зависимостями: + +- requests>=2.31.0 +- pandas>=2.0.0 +- numpy>=1.24.0 +- fastapi>=0.115.0 +- uvicorn>=0.30.0 +- python-telegram-handler +- python-dotenv +- nasio +- pillow + +### Дополнительные инструкции для установки зависимостей + +Для установки пакетов из дополнительного репозитория, используйте следующую команду: -Установка с автоопределением команды по IP ```shell -./deploy.sh +pip install -r requirements.txt --extra-index-url https://git.tvstart.ru/api/packages/lexx/pypi/simple ``` -Установка для конкретной команды -```shell -./deploy.sh -t cska -r main -``` -Установка тестовой версии -```shell -./deploy.sh -t zenit -r TEST -l vtb -``` -# Пакеты и прочее что будет установленно: -Системные пакеты: -* Python3 -* pip3 -* virtualenv -* Git -* Net-tools +## Управление сервисами -Виртуальное окружение Python с зависимостями: +### Просмотр статуса сервисов -* requests -* pandas -* numpy -* fastapi -* uvicorn -* requests -* python-telegram-handler - -# Управление сервисами -Просмотр статуса ```shell systemctl status rfb-data.service ``` -Перезапуск сервиса + +### Перезапуск сервисов + ```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 ``` -Просмотр логов -```shell -journalctl -u rfb-data.service -f -``` -# Онлайн состояние системы -После установки статус приложение доступен по адресу: +### Просмотр логов + +```shell +journalctl -t RFB -f +``` + +### Онлайн состояние системы +После установки статус приложения доступен по адресу: `http://ВАШ_IP_АДРЕС:8000/status` -