ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ
«КРУИЗНАЯ БОРТОВАЯ ИНФОРМАЦИОННО-СПРАВОЧНАЯ СИСТЕМА».
АРМ ДИРЕКТОРА КРУИЗА»
ИНСТРУКЦИЯ ПО УСТАНОВКЕ ЭКЗЕМПЛЯРА ПО
ОГЛАВЛЕНИЕ
Общая информация о документе........................................... 3Обозначения и сокращения.................................................... 4
1 ТРЕБОВАНИЯ ДЛЯ УСТАНОВКИ И НАСТРОЙКИ ПО............. 5
2 НАСТРОЙКА ОКРУЖЕНИЯ ПО............................................... 7
2.1 Установка пакета nginx......................................................... 7
2.2 Установка пакета Docker и docker-compose............................ 7
2.3 Смена пароля к базе данных................................................. 7
3 НАСТРОЙКА КОНФИГУРАЦИОННЫХ ФАЙЛОВ..................... 8
3.1 Описание файла .env-prod, содержащего настройки ПО......... 8
3.2 Настройка списка IP-адресов................................................ 8
4 РАЗВЕРТЫВАНИЕ СЕРВИСА НА ОСНОВЕ DOCKER-ОБРАЗА. 9
4.1 Распаковка архивов.............................................................. 9
4.2 Запуск базы данных.............................................................. 9
4.3 Запуск ПО............................................................................. 9
5 СБОРКА АРХИВА BISS_BACKOFFICE.TAR.GZ...................... 10
Общая информация о документе
Настоящий документ представляет собой руководство по установке и настройке программного обеспечения «Круизная бортовая информационно-справочная система». АРМ директора круиза».
В данном документе представлены системные требования и описан пошаговый процесс установки и настройки ПО.
Обозначение | Определение |
АРМ | Автоматизированное рабочее место |
БД | База данных |
ОС | Операционная система |
ПО, ПО БИСС АРМ директора круиза, ПО КруБИСС АРМ директора круиза | ПО «Круизная бортовая информационно-справочная система». АРМ директора круиза» |
ПК | Персональный компьютер |
СУБД | Система управления базами данных |
1. ТРЕБОВАНИЯ ДЛЯ УСТАНОВКИ И НАСТРОЙКИ ПО
Перед началом процесса создания и разворачивания пакета для ПО БИСС АРМ директора круиза на сервере должны быть установлены следующие зависимости (Таблица 1).
№ | Файл | Описание |
1 | Директория app | Директория с файлами для начала работы |
1.1 | docker-compose.yml | Файл для создания docker- контейнера |
1.2 | Dockerfile | Файл для создания docker-образа |
Таблица 1. Список необходимых зависимостей
Системное требование | Описание |
Astra Linux CE 2.12.44 (Orel) | Должна быть установлена ОС с русской локализацией |
PostgreSQL 16 | Запускается в docker-контейнере, по умолчанию требуется: − пользователь postgres с паролем postgres (для доступа к БД установить пароль admin). Если используются другие настройки, значения необходимо прописать в файле .env-prod |
Docker; Docker Compose | Инструкция по установке приведена в данном документе |
Nginx 1.18 | Инструкция по установке приведена в данном документе |
Перед настройкой ПО БИСС АРМ директора круиза должен быть получен архив файлов Biss_backoffice.zip (Таблица 2).
Таблица 2. Состав файлов в поставляемом архиве
1.3 | webapp-0.0.1- SNAPSHOT.jar | Архив с частью backend |
2 | Директория frontend | Директория со статическими файлами ReactJS |
3 | Директория nginx | Директория с конфигурационными файлами для nginx |
3.1 | biss.conf | Файл конфигурации nginx |
4 | Директория postgres | Директория с файлами для работы базы данных Postgres |
4.1 | docker-compose.yml | Файл для создания docker- контейнера |
4.2 | Dockerfile | Файл для создания docker-образа |
4.3 | initdb.sql | SQLScript файл с начальными настройками базы данных |
5 | .env-prod | Конфигурационный файл |
6 | copy_nginx_assets.sh | Скрипт для загрузки и настройки части frontend и nginx |
7 | up_prod.sh | Файл для запуска ПО |
8 | down_prod.sh | Файл для остановки ПО |
9 | up_postgres.sh | Файл для запуска базы данных |
10 | down_postgres.sh | Файл для остановки базы данных |
2 НАСТРОЙКА ОКРУЖЕНИЯ ПО
2.1 Установка пакета nginx
Выполнить команду:
sudo apt-get install nginx
2.2 Установка пакета Docker и docker-compose
Установить Docker командой:
sudo apt-get install docker.io
Установить docker-compose командой:
sudo apt-get install docker-compose
2.3 Смена пароля к базе данных
Проверить наличие пароля для доступа к БД Postgres.
Если доступа нет, необходимо сбросить пароль пользователю postgres:
sudo docker exec –it biss-postgres bash su postgres psql alter user postgres with password 'admin';
3 НАСТРОЙКА КОНФИГУРАЦИОННЫХ ФАЙЛОВ
3.1 Описание файла .env-prod, содержащего настройки ПО
## имя пользователя postgres
PG_USER=postgres
## пароль пользователя
PG_PASS=admin
## имя хоста, на котором стоит Postgres (или IP-адрес)
PG_HOST=localhost
#ключ для JWT Token (для авторизации). Заполняется случайными данными
JWT_SECRET=zdtlD3JK56m6wTTgsNFsdfSdfwerfewq
#issuer для JWT Token (для авторизации)
JWT_ISSUER=smartturbo.ru
#папка, где будут храниться логи
LOGS_DIR=/var/log/biss
#имя пользователя для админки Postgres. Не используется в инфраструктуре заказчика
PGADMIN_DEFAULT_EMAIL=admin@example.com
#Пароль пользователя для админки Postgres. Не используется в инфраструктуре заказчика PGADMIN_DEFAULT_PASSWORD=admin
#Порт, по которому подключается GPS-трекер к системе
GPS_PORT=ttyUSB0
3.2 Настройка списка IP-адресов
Необходимо настроить список IP-адресов, с которых можно будет аутентифицироваться в части backend.
Вapplication.ymlнеобходимо настроить application.ipwhitelist.
4 РАЗВЕРТЫВАНИЕ СЕРВИСА НА ОСНОВЕ DOCKER-ОБРАЗА
4.1 Распаковка архивов
Необходимо распаковать архив Biss_backoffice.zip в директорию /mnt/src/biss/.
4.2 Запуск базы данных
Необходимо запустить скрипт up_postgres.sh.
4.3 Запуск ПО
Необходимо запустить скрипт up_prod.sh.
Требуется ввести пароль пользователя при запросе, т.к. в скрипте присутствуют команды sudo.
5 СБОРКА АРХИВА BISS_BACKOFFICE.TAR.GZ
Необходимо перейти в директорию
/mnt/src/biss/infrastructure/package.
Требуется запустить скрипт 01_assemble_package.sh develop.
Далее можно забрать архив из директории
/mnt/src/biss/infrastructure/package.
