ОГЛАВЛЕНИЕ

Аннотация …3
Обозначения и сокращения …4
1 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПО …5
1.1 Назначение П О …5
1.2 Функции П О …5
1.3 Требования к АРМ администратора …5
1.4 Уровень подготовки администратора …5
2 АРХИТЕКТУРА РЕШЕНИЯ …6
3 ПРОЦЕСС УСТАНОВКИ ПО …8
4 УПРАВЛЕНИЕ ПОЛЬЗОВАТЕЛЯМИ … 10
5 УСТРАНЕНИЕ НЕИСПРАВНОСТЕЙ … 11


Аннотация
Настоящий документ содержит информацию, необходимую для эксплуатации экземпляра программного обеспечения «Круизная бортовая информационно-справочная система». АРМ директора круиза" со стороны администратора.
В данном документе представлено краткое описание ПО, процесса его установки и запуска. Представлен процесс действий пользователей при аварийных ситуациях.



1 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПО
1.1 Назначение П О
ПО БИСС АРМ директора круиза предназначено для:

• организации системы сбора данных о круизах и их агрегации в одном месте;
• управления информационными и персональными сервисами на борту;
• обеспечения доступа пользователям к данным через интерфейс мобильного приложения.

1.2 Функции П О
Основными функциональными возможностями ПО являются:

• управление информационными сервисами на борту;
• управление персональными сервисами на борту; − управление пользователями.

ПО также обладает следующими технологическими возможностями:

• механизм аутентификации и авторизации;
• интеграция с внешними системами; − логирование событий.

1.3 Требования к АРМ администратора
Особые требования к АРМ администратора не предъявляются.
Необходима поддержка актуальных версий веб-браузеров.

1.4 Уровень подготовки администратора
Администратор ПО должен:
− владеть навыками работы с технической документацией;
− обладать знаниями о стандартных протоколах передачи данных;
− обладать знаниями о средствах мониторинга ПО;
− обладать знаниями о средствах резервного копирования и восстановления данных в ПО;
− владеть знаниями и навыками администрирования сетевых инструментов;
− осуществлять управление списком пользователей.

2 АРХИТЕКТУРА РЕШЕНИЯ
ПО является единым объектом, представляющим совокупность программных модулей. Деление условное.
Схема архитектуры ПО представлена на рисунке 1.

Рисунок 1 — Архитектура П О

ПО БИСС АРМ директора круиза включает в себя следующие интерфейсы для администратора:

• «Список пользователей» — веб-интерфейс просмотра туристов в круизе и администраторов, зарегистрированных в ПО БИСС АРМ директора круиза.
• «Загрузка изображений» — веб-интерфейс контроля интеграции с внешними системами в вопросах передачи изображений.
• «Загрузка видео» — веб-интерфейс контроля интеграции с внешними системами в вопросах передачи видеофайлов.
• «Загрузка аудио» — веб-интерфейс контроля интеграции с внешними системами в вопросах передачи аудиофайлов.
• «Загрузка PDF-инструкций» — веб-интерфейс загрузки PDF-файлов, необходимых для отображения в мобильном приложении.
• «Загрузка Track. json» — веб-интерфейс загрузки файла с данными о долготе и широте точек на карте, по которым строится маршрут судна.
• «Обратная связь» — веб-интерфейс просмотра сообщений туристов, отправленных через мобильное приложение.
• «Настройки» — веб-интерфейс просмотра актуальных настроек ПО.
• «Достопримечательности» — веб-интерфейс управления достопримечательностями, встречающимися по маршруту судна.
• «Мой профиль» — веб-интерфейс просмотра данных об администраторе.

3 ПРОЦЕСС УСТАНОВКИ ПО
Установить nginx командой:
sudo apt-get install nginx
Установить Docker командой:
sudo apt-get install docker. io
Установить docker-compose командой:
sudo apt-get install docker-compose
Проверить наличие пароля для доступа к БД Postgres.
Если доступа нет, необходимо сбросить пароль пользователю postgres:
sudo docker exec -it biss-postgres bash su postgres psql
alter user postgres with password 'admin';
Описание файла .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
Необходимо настроить список IP-адресов, с которых можно будет аутентифицироваться в части backend. В application. yml необходимо настроить application. ip-whitelist.
Необходимо распаковать архив Biss_backoffice.zip в директорию
/mnt/src/biss/.
Для запуска базы данных необходимо запустить скрипт up_postgres.sh.
Для запуска ПО необходимо запустить скрипт up_prod.sh. Требуется ввести пароль пользователя при запросе, т.к. в скрипте присутствуют команды sudo.
Чтобы собрать архив Biss_backoffice.tar.gz, необходимо перейти в директорию /mnt/src/biss/infrastructure/package.
Требуется запустить скрипт 01_assemble_package.sh develop.
Далее можно забрать архив из директории
/mnt/src/biss/infrastructure/package.

4 УПРАВЛЕНИЕ ПОЛЬЗОВАТЕЛЯМИ
Администратору доступен список всех пользователей — и туристов на рейсе, и администраторов — со следующими атрибутами (Рисунок 2):
− имя;
− логин;
− роль;
− 4 последних цифры паспорта (для туриста);
− номер каюты (для туриста);
− статус УЗ.

Рисунок 2 — Интерфейс «Список пользователей»

Администратор может управлять УЗ как туристов на рейс, так и администраторов ПО БИСС АРМ директора круиза.
Он может добавлять, редактировать и удалять данные пользователей, а также блокировать УЗ при необходимости (Рисунок 3).

Рисунок 3 — Управление У З администраторов

Страница |

5 УСТРАНЕНИЕ НЕИСПРАВНОСТЕЙ
Для определения причин возникновения неисправностей предусмотрены отладочные файлы для каждого интерфейса ПО.
Файлы формируются автоматически и помещаются в директорию, в которую была произведена установка ПО. Срок хранения отладочных файлов — 5 дней. В отладочные файлы выводится информация об ошибках и отладочная информация отдельно по каждому модулю.
Размер каждого файла — 25 МБ. Если файл за день превышает 25 МБ, формируется еще один файл. Анализируя файлы, можно понять, на каком шаге остановилось выполнение симуляции, подготовки отчетов и причину возникновения проблемы.