Сервер ReVizor

Совет

Выберите вкладку в соответствии с используемым семейством ОС.

Windows

Если при установке на Windows был выбран компонент Cервер ReVizor, то при завершении установки будет запущено вспомогательное приложение для его настройки.

Настройка подключения к базе данных.

На странице подключения к базе данных необходимо задать следующие параметры:

• провайдер СУБД: Microsoft SQL Server или PostgreSQL
• адрес SQL-сервера, который будет использоваться для ReVizor; если используется Microsoft SQL Server с TCP/IP или PostgreSQL, то порт указывается слитно через запятую, например, localhost,5432
• выбрать тип аутентификации(Windows-аутентификация доступна только для Microsoft SQL Server)
• задать имя пользователя и пароль администратора для подключения к БД — эти данные будут использоваться только при установке, чтобы произвести первоначальную настройку(создание пользователя, БД, настройка прав и т.д.)

После ввода всех параметров необходимо нажать Продолжить.

Настройка веб-сервера.

На странице параметров сервера необходимо задать следующие параметры:

• имя хоста или IP-адрес, которые будут использоваться для открытия приложения
• порт После чего нажать на кнопку Продолжить.

Успешное завершение.

Веб-интерфейс после завершения установки будет доступен на заданном хосте и порте, например, http://127.0.0.1:12000.

Также эти параметры после установки можно изменить, отредактировав их в файле конфигурации (по умолчанию C:\ReVizor\Server\appsettings.production.json) в секции AppConfig и перезапустив службу ReVizorServer:

Host: имя хоста или IP-адрес, например, 192.168.0.1 Port: порт для входящих подключений, например, 12000 WebAppUri: путь к веб-интерфейсу в виде «http://<Host>:<Port>», где Host и Port это указанные выше параметры, например http://192.168.0.1:12000; также, если для доступа к веб-интерфейсу предоставляется через Интернет, то можно указать доменное имя, например, https://example.com

Внимание

При изменении параметров Host и Port в файле конфигурации сервера, для корректной работы системы необходимо также изменить соответствующие параметры и в файлах конфигурации служб опроса!

Linux

СУБД

Для работы службы сервера необходимо установить СУБД PostgreSQL. Для установки следуйте инструкциям с официального сайта PostgreSQL. Для РЕД ОС можно воспользоваться инструкцией с сайта РЕД ОС Установка PostgreSQL.

Перед первоначальной установкой службы сервера ReVizor в установленной СУБД необходимо создать базу данных ReVizorDb, пользователя revizor и предоставить пользователю права доступа к базе. Если база и пользователь уже имеются, то этот шаг можно пропустить. Для создания необходимо запустить консоль psql и выполнить следующие команды:

Внимание

Необходимо соблюдать регистр имён пользователей и БД, а также кавычки и точка-запятые в конце запросов!

1. Переключитесь на пользователя root и введите пароль:

su -

2. Переключитесь на пользователя postgres

su - postgres

3. Запустите psql и выполните следующие команды ниже. После ввода команд для выхода из консоли psql введите \q.

CREATE DATABASE "ReVizorDb";

CREATE USER "revizor" WITH ENCRYPTED PASSWORD '*' CREATEDB SUPERUSER;

где * — это пароль пользователя revizor, который необходимо будет далее внести в файл конфигурации в поле Password секции DbConfig

GRANT ALL PRIVILEGES ON DATABASE "ReVizorDb" TO "revizor";

4. Если требуется изменить IP-адрес, на котором PostgreSQL прослушивает входящие подключения, а также добавить доступ к СУБД, то это можно настроить в файлах: pg_hba.conf и postgresql.conf. Для применения изменений может потребоваться перезагрузка служб PostgreSQL.

Создание бэкапа БД

Если необходимо создать бэкап базы данных, то это можно сделать воспользовавшись утилитой pg_dump:

pg_dump -d ReVizorDb -U postgres -f <путь куда сохранить бэкап>

Установка и настройка

1. Скопируйте пакет службы сервера ReVizor на машину, где требуется установка, и запустите процесс командой(замените * - на имеющуюся версию):

• Fedora/РЕД ОС:

sudo dnf install ./revizor-server-*.rpm

• Debian/AstraLinux:

sudo apt install ./revizor-server-*.deb

2. После установки будут доступны следующие файлы и директории:

• /etc/opt/revizor/server/appsettings.production.json — файл конфигурации сервера,
• /etc/systemd/system/revizor-server.service — файл systemd настроек службы сервера,
• /opt/revizor/server/ — папка с установленным приложением службы сервера,
• /var/log/revizor/server/ — папка с журналами работы службы сервера

3. После первоначальной установки для корректной работы службы сервера ReVizor необходимо изменить настроечные параметры в файле конфигурации /etc/opt/revizor/server/appsettings.production.json.

   В секции AppConfig:

• SecurityKey — секретный симметричный ключ JWT(ключ обязательно нужно заменить на другой), который, например, можно сгенерировать командой openssl rand -hex 32
• Host и Port — IP-адрес и порт для входящих TCP-подключений и веб-интерфейса
• WebAppUri — ссылка на приложение для внешних источников(например, если имеется домен https://example.com, либо ссылка вида http://{Host}:{Port})

Внимание

Ключ SecurityKey обязательно должен быть заменен, так как от него зависит безопасноть входа в систему! Рекомендуется использовать криптографически случайную последовательность байт. Ключ нужно хранить в тайне и только в файле конфигурации.

Внимание

При изменении параметров Host и Port в файле конфигурации сервера, для корректной работы системы необходимо также изменить соответствующие параметры и в файлах конфигурации служб опроса!

В секции DbConfig:

• Server — IP-адрес сервера PostgreSQL
• Port — порт сервера PostgreSQL(по умолчанию 5432)
• UserID и Password — имя пользователя и пароль для входа на сервер PostgreSQL созданные выше

4. Далее службу можно запустить средствами операционной системы командой:

sudo systemctl start revizor-server.service

После запуска веб-интерфейс будет доступен по вышеуказанному адресу WebAppUri. После первого входа в систему рекомендуется поменять пароль администратора(логин и пароль по умолчанию: Администратор/Администратор).

Запуск и остановка

Запуск службы:

sudo systemctl start revizor-server.service

Остановка службы:

sudo systemctl stop revizor-server.service