Введение #
Коробочная версия ApiDQ состоит из двух частей:
- база данных PostgreSQL с эталонными справочниками;
- приложение - набор сервисов (
gateway,address,phone,name), которые запускаются в Docker.
Чтобы запустить ApiDQ на вашем сервере, вам необходимо:
- Подписать контракт с командой ApiDQ.
- Получить от команды ApiDQ параметры доступа к GitLab и SFTP-серверу (
gitlab_login,gitlab_password,sftp_login,sftp_password) и лицензионный ключ (LICENSE_KEY) - Загрузить справочники - инструкция
- Установить и настроить базу данных - инструкция
- Установить и настроить службы ApiDQ - инструкция
Порядок установки новых версий и справочников описан в разделе Обновление и восстановление.
Требования к серверу #
Инструкции раздела написаны и проверяются для следующего окружения:
| Компонент | Версия |
|---|---|
| Операционная система | Ubuntu 24.04 LTS |
| PostgreSQL | 18 + PostGIS 3 |
| Docker | Docker Engine с плагином Docker Compose v2 (команда docker compose) |
Рекомендуемые ресурсы для адресного сервиса по России (RU): 8 CPU, от 8 ГБ RAM. База данных со справочниками занимает около 40 ГБ; с учётом файлов справочников и запаса на обновление рекомендуем диск от 100 ГБ (SSD).
Мы рекомендуем устанавливать ПО и базу данных ApiDQ на разных виртуальных серверах. Установка на один сервер также возможна - отличия отмечены в инструкциях.
Сетевые доступы #
С серверов ApiDQ должны быть доступны:
| Адрес | Назначение |
|---|---|
gitlab.apiship.ru:5050 | Docker Registry с образами сервисов |
storage.apidq.io:65110 | SFTP-сервер со справочниками |
api.apidq.io:443 | Автоматическое продление лицензионного ключа |