diff --git a/README.md b/README.md index ba138d8..d0bf16b 100644 --- a/README.md +++ b/README.md @@ -7,21 +7,18 @@ RFB Stat - это система для автоматического сбор Требования - Ubuntu Linux +* Ubuntu Linux +* Доступ к репозиторию `https://git.tvstart.ru/` +* *Права root для установки!!* - Доступ к репозиторию https://git.tvstart.ru/ychernenko/RFB.git - - Права root для установки!! - -Установка -Автоматическая установка +# Установка Скрипт установки выполняет полную настройку системы: -bash +```shell chmod +x deploy.sh ./deploy.sh -t <команда> -r <релиз> - +``` Параметры командной строки -t - Название команды (опционально, определяется по IP если не указано) @@ -30,100 +27,77 @@ chmod +x deploy.sh -h - Справка по использованию -Примеры использования -bash +# Примеры использования -# Установка с автоопределением команды по IP +Установка с автоопределением команды по IP +```shell ./deploy.sh -r main - -# Установка для конкретной команды +``` +Установка для конкретной команды +```shell ./deploy.sh -t cska -r main - -# Установка тестовой версии +``` +Установка тестовой версии +```shell ./deploy.sh -t zenit -r Barabanov_TEST - +``` # Пакеты и прочее что будет установленно: - Системные пакеты: +Системные пакеты: - Python3, pip, virtualenv +* Python3 +* pip3 +* virtualenv +* Git +* Net-tools - Git +Виртуальное окружение Python с зависимостями: - Systemd +* streamlit +* requests +* pandas +* numpy +* plotly +* watchdog +* pillow +* streamlit_autorefresh + +# Systemd сервисы: - Net-tools +`rfb-data.service - сбор данных` - Виртуальное окружение Python с зависимостями: +`rfb-visual.service - веб-интерфейс` - 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 - +Просмотр статуса обоих сервисов одновременно +```shell +systemctl status rfb-data.service rfb-visual.service +``` # Просмотр логов - Логи сбора данных - journalctl -u rfb-data.service -f - +```shell +journalctl -u rfb-data.service -f +``` Логи веб-интерфейса - 'journalctl -u rfb-visual.service -f' - -#Управление сервисами - Перезапуск всех сервисов - systemctl restart rfb-data.service rfb-visual.service +```shell +journalctl -u rfb-visual.service -f +``` +# Управление сервисами +Перезапуск всех сервисов +```shell +systemctl restart rfb-data.service rfb-visual.service +``` Остановка всех сервисов - systemctl stop rfb-data.service rfb-visual.service - +```shell +systemctl stop rfb-data.service rfb-visual.service +``` Запуск всех сервисов - systemctl start rfb-data.service rfb-visual.service - +```shell +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 +`http://ВАШ_IP_АДРЕС:8501`