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

Создано тестовое приложение в виде server.js-файла, который запускается на Node.js как веб-сервер. Исходный код находится в репозитории: https://git.hitsoft-it.com/e-dictation/rsv

Пользователь: ecopsy
Пароль: направляется отдельно

Сервер, собранный в docker-образ, имеет следующий идентификатор reg.hitsoft-it.com/e-dictation/rsv/server:latest

Последняя версия 0.1.2 аналогична идентификатору: reg.hitsoft-it.com/e-dictation/rsv/server:0.1.2

Чтобы получить доступ к репозиторию, необходимо авторизоваться в хранилище образов reg.hitsoft-it.com

Для этого нужно использовать команду:

docker login reg.hitsoft-it.com

Далее, ввести пароль и логин пользователя, указанные выше.

Для этого пользователя сгенерирован токен ecopsy_token:токен поэтому авторизоваться также можно через команду:

docker login reg.hitsoft-it.com -u ecopsy_token -p токен

Для запуска можно использовать docker compose, например, такой файл docker-compose.yml

version: '2.0'

services:

  server:
    image: reg.hitsoft-it.com/e-dictation/rsv/server:latest
    restart: always
    volumes:
      - ./logs:/server/logs
    ports:
      - "8980:8080" 
    networks:
      - rsv-network

networks:
  rsv-network:

Вместо 8980 можно указать любой предпочтительный порт, который будет пробрасыватьcя в докер, а вместо ./logs любой относительный (относительно файла docker-compose.yml) или абсолютный путь к директории, которая будет заменять директорию с логами в докере.

После создания файла, докер контейнер можно запустить командой:

docker compose up -d

Либо можно запускать docker-контейнер обычным докером при помощи команды:

docker run -v ./logs:/server/logs -p 8980:8080 -d reg.hitsoft-it.com/e-dictation/rsv/server:latest

Затем сервер будет доступен по адресу http://localhost:8980/calcResult на сервере, где запущен docker (либо на на другом порту, на который будет заменён 8980).

Полный цикл установки был проверен на чистой системе Ubuntu 22.04.2 LTS, в которую был установлен только docker и его компоненты.

Создано тестовое приложение в виде server.js-файла, который запускается на Node.js как веб-сервер по адресу 0.0.0.0:8080, и реализует метод /calcResult, который принимает три параметра:
dictId — строка,
userId — строка,
text — строка.

При заданных параметрах сервер вернёт HTTP-код 200 и фиксированный (отладочный) результат в виде JSON.

Сервер может принимать как GET-запросы с параметрами в URL-е, так и POST-запросы с параметрами, закодированными в форматах multipart/form-data, application/x-www-form-urlencoded или JSON-объекта.

Если какой-то параметр пропущен, сервер выдаст ошибку.