Установка Archive API

Для установки Archive API в Docker нужно:

  • задать параметры контейнера;

  • выполнить скрипт, который создаст контейнер на основе образа;

  • запустить контейнер;

  • настроить доступ к Archive API через Nginx.

Задание параметров контейнера

Для того чтобы задать параметры контейнера, нужно открыть конфигурационный файл ContainerConfiguration.json в текстовом редакторе:

nano ~/Загрузки/TerraLink.xDEPro/Archives.REST/ContainerConfiguration.json

Параметры контейнера приведены ниже:

{
    "Appsettings": {    // содержимое файла конфигурации appsettings.json
        // ...
    }
}

В поле Appsettings передается содержимое конфигурационного файла Archive API. Здесь нужно настроить подключение Archive API к базе данных.

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

{
    "ProviderName": "Npgsql",
    "ConnectionString": "User ID=xde;Password=1234aA;Host=192.168.11.128;Port=5432;Database=DOCFLOW_DB;MaxPoolSize=500"
}

Примечание

В примере установки используется PostgreSQL, установленный локально. Контейнер по умолчанию не может обращаться к Docker-хосту, используя имя localhost или IP-адрес 127.0.0.1. Здесь используется пример внешнего IP-адреса Docker-хоста.

Затем нужно сохранить файл ContainerConfiguration.json (Ctrl+O) и выйти из редактора (Ctrl+X).

Примечание

Archive API использует базу данных интеграционного модуля. Если планируется использовать PostgreSQL, установленный на другой машине, то в строке подключения нужно указать имя хоста (либо IP-адрес) и порт установленного экземпляра PostgreSQL.

См. также:
Конфигурационный файл Archive API

Создание и запуск контейнера

Для создания контейнера нужно перейти в папку с образом:

cd ~/Загрузки/TerraLink.xDEPro/Archives.REST

и с помощью Powershell Core выполнить скрипт CreateDockerContainer.ps1:

rootlessenv pwsh ./CreateDockerContainer.ps1

В результате будет создан контейнер с именем xde-archives-rest-container.

В терминал также будет выведен идентификатор контейнера. Он понадобится для запуска.

Примечание

Определить идентификатор контейнера можно, выполнив команду:

rootlessenv docker container ls -a

Команда выведет в терминал список контейнеров с их именами и идентификаторами.

Теперь следует запустить контейнер:

rootlessenv docker container start container_id

где container_id - идентификатор созданного контейнера, полученный на предыдущем шаге.

Далее нужно вернуться в домашнюю папку:

cd ~

Лог-файлы

Вместе с контейнером в Docker создается том для хранения лог-файлов.
Имя тома: xde-archives-rest-logs.

Для получения пути к тому в файловой системе Docker-хоста нужно выполнить команду:

rootlessenv docker volume inspect xde-archives-rest-logs

Поле Mountpoint будет указывать на путь к папке с лог-файлами в файловой системе Docker-хоста.

Примечание

Содержимое тома доступно только с правами суперпользователя.

Настройка доступа к Archive API через Nginx

Для настройки доступа к Archive API через Nginx требуется создать файл с конфигурацией сайта в текстовом редакторе:

sudo nano /etc/nginx/sites-available/xde-archive-api

и скопировать в него содержимое:

server {
    # виртуальный сервер настраивается на порт по умолчанию для этого HTTP-сервиса + 100
    listen        6105;

    # в примере доступ к этому HTTP-сервису возможен только по IP-адресу
    server_name   192.168.11.128;
    location / {
        # порт по умолчанию для этого HTTP-сервиса - 6005
        proxy_pass         http://127.0.0.1:6005;
        proxy_http_version 1.1;
        proxy_set_header   Upgrade $http_upgrade;
        proxy_set_header   Connection keep-alive;
                    proxy_set_header   Host $host:$server_port;
        proxy_cache_bypass $http_upgrade;
        proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header   X-Forwarded-Proto $scheme;
    }
}

Затем нужно сохранить файл (Ctrl+O) и выйти из редактора (Ctrl+X).

Примечание

Для доступа по IP-адресу значение параметра server_name должно быть равно фактическому IP-адресу машины, на которую устанавливается Archive API. Здесь указан пример IP-адреса.

Теперь нужно создать ссылку на конфигурационный файл сайта в папке /etc/nginx/sites-enabled/ и перезапустить Nginx:

sudo ln -s /etc/nginx/sites-available/xde-archive-api /etc/nginx/sites-enabled/
sudo systemctl restart nginx

Предупреждение

Не используйте HTTP-подключение к Nginx в продуктивной среде. Это может привести к несанкционированному доступу к данным, в том числе к содержимому документов и паролям. Используйте HTTPS-подключение.

Проверка доступности Archive API

Для проверки доступности Archive API нужно открыть браузер на машине, отличной от той, на которую производится установка. В адресной строке браузера указать настроенный адрес и порт:

http://192.168.11.128:6105

В ответ в браузере должна открыться страница Swagger UI.