Информационные системы

ООО «ГИНТЕЛЛ»



Инструкция по установке

программного обеспечения

компьютерная платформа «ПЛИТА»





Оглавление

Требования к системе
Предварительная установка
Установка и запуск


Версия документа

№ п.п.

Дата

Описание изменений

1

30.10.2024

Создание документа




Требования к системе
Минимальные аппаратные требования, предъявляемые к конфигурации серверного оборудования:

Серверное оборудование \ кол-во пользователей

до 100

до 500

до 1000

до 3000

Количество серверов

1

1

2*

2*

Параметры сервера

WEB/БД

WEB/БД

WEB

БД

WEB

БД

Количество вычислительных потоков процессоров (шт.)

4

8

8

8

24

12

Тактовая частота процессора (Ггц)

2,5

2,5

2,5

2,5

2,5

2,5

Оперативная память (Гб)

16

16

16

16

32

32

Свободное дисковое пространство (Гб)

500

600

1000

300

3000

600

Тип дисковых накопителей

SATA

SATA

SATA/

SAS

SAS

SATA/

SAS

SAS

Пропускная способность локальной сети Мбит/сек

100

100

1000

1000

1000

1000

* Для работы более 500 пользователей платформы необходимо разнести инсталляцию на два сервера.

•Сервер баз данных (БД) — СУБД PostgreSQL >10.14.
•Сервер приложений (WEB) — Web-сервер nginx и совместимый сервер приложений для работы поисковой системы и быстрого просмотра файлов.
Также доступна разнесенная установка с использованием трёх серверов, в которой сервер приложений также работает на отдельном сервере.

Параметры сервера коммуникаций \ кол-во пользователей

до 20

до 50

до 100

до 200

Количество вычислительных потоков процессоров (шт.)

8

16

24

32

Тактовая частота процессора (ГГц)

3,0

3,0

3,0

3,0

Оперативная память (Гб)

16

16

32

64

Свободное дисковое пространство (Гб)

500

500

1000

1000

Тип дисковых накопителей

SATA

SATA

SATA

SATA

Пропускная способность локальной сети Мбит/сек

100

100

1000

1000


Серверное и сетевое оборудование ядра сети должно быть обеспечено бесперебойным энергоснабжением. Емкость ИБП должна обеспечивать непрерывную работу оборудования при отсутствии энергоснабжения в течение минимум 60 минут. Рекомендуем организовать мониторинг состояния ИБП и обеспечить корректное завершение работы серверов в автономном режиме.
Рекомендуем применять отказоустойчивые дисковые массивы (RAID). Для хранения резервных копий баз данных и файлов Системы рекомендуем обеспечить внешний (сетевой или дисковый) ресурс.
Для обеспечения оптимальной производительности и стабильности работы Системы не рекомендуется устанавливать на серверы прочее программное обеспечение, не относящееся к работе Системы.
При одновременной работе в системе 40 и более пользователей на сервере под управлением ОС Windows высокая производительность и стабильные показатели времени отклика системы не гарантируется. В качестве операционной системы на серверах рекомендуем использовать 64-разрядные ОС на базе ОС Linux.

Требования к программному обеспечению
При установке Системы на сервер с ОС Linux х64:
•операционная система – Debian 10, 11, CentOS 7, Red Hat Enterprise Linux 7, 8, 9, Rocky Linux 8, 9, Ubuntu 18.04, 20.04, 22.04, Astra Linux 1.8, РЕД ОС 7.4.3, 8.

При установке Системы на сервер с ОС Windows x64:
•операционная система – Windows Server 2016/2019;
•файловая система – NTFS.
•необходимые библиотеки и утилиты для работы Системы
При использовании сервера коммуникаций:
•операционная система – Debian 10, 11, CentOS 7, Red Hat Enterprise Linux 7, 8, 9, Rocky Linux 8, 9, Ubuntu 18.04, 20.04, 22.04, Astra Linux 1.8, РЕД ОС 7.4.3, 8.

Требования к клиентским станциям
Обязательные требования:
•наличие сетевой карты (соединение с сетями передачи данных);
•веб-браузеры для работы в Системе: Google Chrome, Яндекс браузер, Microsoft Edge;
•установленный пакет офисных приложений (для MS Office версия не ниже 2003).

Рабочие места
Минимальная комплектация:
•операционная система: Windows 7/8/10, ОС на базе ОС Linux;
•тактовая частота процессора: не менее 2 GHz 2 Core;
•оперативная память (ОЗУ): не менее 8 Gb;
•жёсткий диск: не менее 250 Gb свободного дискового пространства;
•экран: не менее 17”, разрешение не менее 1024×768.
Рекомендуемая комплектация:
•операционная система: Windows 7/8/10, ОС на базе ОС Linux;
•тактовая частота процессора: не менее 3 GHz 2+ Core;
•оперативная память (ОЗУ): не менее 16 Gb;
•жёсткий диск: не менее 500 Gb свободного дискового пространства;
•экран: не менее 17”, разрешение не менее 1280×1024.


Предварительная установка
Установите и запустите Docker Engine и Docker Compose, следуя официальной инструкции https://docs.docker.com/engine/install/.
При использовании Astra Linux следуйте официальной инструкции https://wiki.astralinux.ru/pages/viewpage.action?pageId=158601444

В качестве СУБД для работы программного обеспечения ПЛИТА используется PostgreSQL. Программа может работать как с отдельно установленным сервером PostgreSQL, так и поставляться с Docker-контейнером PostgreSQL в зависимости от требований пользователей. В случае использования отдельного экземпляра PostgreSQL, следуйте официальной инструкции по установке https://www.postgresql.org/

Установка и запуск
1.Распакуйте предоставляемый архив для установки приложения.
2.Приложение состоит из бэкенд (plate) и фронтенд (plate-frontend) частей.
3.Откройте папку plate и отредактируйте файл .env в распакованной папке для настройки параметров программы. Ниже представлено описание параметров .env файла:

DOMAIN

Имя домена

FULL_HOSTNAME

Полное имя устройства, на котором запущено приложение

PLATE_FRONTEND_URL

Адрес фронтенд части приложения

CERTIFICATE_CRT_PATH

Путь к файлу сертификата безопасности SSL

CERTIFICATE_KEY_PATH

Путь к файлу приватного ключа сертификата

STORAGE_PATH

Путь к папке для хранения файлов приложения

LOGS_PATH

Путь к папке для хранения журналов работы приложения

TIME_ZONE

Часовой пояс для определенной географической области

ENVIRONMENT

Окружение для запуска приложения (по умолчанию Production)

ASPNETCORE_ENVIRONMENT

Окружение для ASP.NET Core контейнеров (по умолчанию Production)

LOG_MIN_LEVEL

Минимальный уровень логирования сообщений в журнале

SMTP_HOST

Домен или хост, на котором запущен SMTP сервер

SMTP_PORT

Порт SMTP сервера

SMTP_FROM_ADDRESS

От кого приходит письмо

SMTP_USER_NAME

Имя пользователя от SMTP сервера

SMTP_PASSWORD

Пароль от SMTP сервера

SMTP_USE_SSL

Использовать шифрованное подключения SMTP

SMTP_AUTHENTICATION_TYPE

Тип аутентификации SMTP

RABBITMQ_LOGIN

Имя пользователя RabbitMQ

RABBITMQ_PASSWORD

Пароль RabbitMQ

RABBITMQ_PORT

Порт, на котором запущен RabbitMQ (по умолчанию 5672)

POSTGRES_USER

Имя пользователя для подключения к базе данных

POSTGRES_PASSWORD

Пароль для подключения к базе данных

POSTGRES_PORT

Порт, на котором запущен PostgreSQL (по умолчанию 8443)

POSTGRES_DB

Название базы данных

KEYCLOAK_ADMIN

Имя пользователя Keycloak

KEYCLOAK_ADMIN_PASSWORD

Пароль пользователя Keycloak

KEYCLOAK_PORT

Порт, на котором запущен Keycloak (по умолчанию 5432)

KEYCLOAK_LOG_LEVEL

Минимальный уровень логирования сообщений в журнале Keycloak

KEYCLOAK_METRICS_ENABLED

Включение метрик Keycloak

KEYCLOAK_HEALTH_ENABLED

Включение проверки работоспособности Keycloak

KEYCLOAK_DB

Название базы данных для Keycloak

KEYCLOAK_DB_URL

Адрес подключения базы данных Keycloak

KEYCLOAK_AUTH_SERVER_URL

Адрес сервера, на котором развернут Keycloak

KEYCLOAK_REALM

Название Realm Keycloak (по умолчанию gintell)

KEYCLOAK_RESOURCE

Название Ресурса Keycloak (по умолчанию gintell)

KEYCLOAK_VERIFY_TOKEN_AUDIENCE

Использовать токены авторизации Keycloak (по умолчанию true)

KEYCLOAK_CREDENTIALS_SECRET

Секрет для безопасного доступа к Keycloak

KEYCLOAK_SSL_REQUIRED

Использовать шифрованное подключения Keycloak (по умолчанию true)

REDIS_PORT

Порт, на котором запущен Redis (по умолчанию 6379)

REDIS_STACK_PORT

Порт, на котором запущен Redis Stack (по умолчанию 8001)

REDIS_CONNECT_TIMEOUT

Время ожидания подключения к Redis в миллисекундах (по умолчанию 10000)

REDIS_SYNC_TIMEOUT

Время ожидания синхронизации данных для синхронных операций Redis (по умолчанию 10000)

PLATE_GATEWAY_PORT

Порт, на котором запущен шлюз приложения ПЛИТА (По умолчанию 7777)

PLATE_GATEWAY_LOG_MIN_LEVEL

Минимальный уровень логирования сообщений в журнале шлюза приложения ПЛИТА (по умолчанию совпадает с LOG_MIN_LEVEL)

PLATE_IDENTITY_DB

Имя базы данных для сервиса идентификации приложения ПЛИТА (по умолчанию Gintell.Identity)

PLATE_IDENTITY_LOG_MIN_LEVEL

Минимальный уровень логирования сообщений в журнале сервиса идентификации приложения ПЛИТА (по умолчанию совпадает с LOG_MIN_LEVEL)

PLATE_IDENTITY_KEYCLOAK_ADMIN_ID

Идентификатор администратора в Keycloak

PLATE_LICENSES_LOG_MIN_LEVEL

Минимальный уровень логирования сообщений в журнале сервиса лицензирования приложения ПЛИТА (по умолчанию совпадает с LOG_MIN_LEVEL)

PLATE_NOTIFICATIONS_LOG_MIN_LEVEL

Минимальный уровень логирования сообщений в журнале сервиса уведомлений приложения ПЛИТА (по умолчанию совпадает с LOG_MIN_LEVEL)

PLATE_NOTIFICATIONS_EMAIL_TEMPLATES

Путь к папке с шаблонами для электронных писем

PLATE_OBJECTS_LOG_MIN_LEVEL

Минимальный уровень логирования сообщений в журнале сервиса объектов приложения ПЛИТА (по умолчанию совпадает с LOG_MIN_LEVEL)

PLATE_OBJECTS_DB

Имя базы данных сервиса объектов приложения ПЛИТА (по умолчанию Gintell.Objects.[workspaceId])

PLATE_STORAGE_LOG_MIN_LEVEL

Минимальный уровень логирования сообщений в журнале сервиса хранения приложения ПЛИТА (по умолчанию совпадает с LOG_MIN_LEVEL)

PLATE_STORAGE_PORT

Порт сервиса хранения приложения ПЛИТА (по умолчанию 7158)

PLATE_WORKSPACES_DB

Имя базы данных сервиса рабочих пространств Приложения ПЛИТА (по умолчанию Gintell.Workspaces)

PLATE_WORKSPACES_LOG_MIN_LEVEL

Минимальный уровень логирования сообщений в журнале сервиса рабочих пространств приложения ПЛИТА (по умолчанию совпадает с LOG_MIN_LEVEL)

4.Откройте папку plate-frontend и отредактируйте файл .env в распакованной папке для настройки параметров программы. Ниже представлено описание параметров .env файла:

NEXT_PUBLIC_API_GATEWAY

Адрес шлюза приложения ПЛИТА

NEXT_PUBLIC_API_STORAGE

Адрес сервиса хранения приложения ПЛИТА

NEXT_PUBLIC_LICENSE_ID

Код активации лицензии приложения ПЛИТА

CERTIFICATE_CRT_PATH

Путь к файлу сертификата безопасности SSL

CERTIFICATE_KEY_PATH

Путь к файлу приватного ключа сертификата

TIME_ZONE

Часовой пояс для определенной географической области

5.Выполните установку и запуск, запустив скрипт install.sh для ОС семейства Linux или install.bat на ОС семейства Windows.
6.Если у вас возникли вопросы или проблемы, обратитесь в службу поддержки support@gintell.ru