Introduction #
The standalone version of ApiDQ consists of two parts:
- database - PostgreSQL with reference dictionaries;
- application - a set of services (
gateway,address,phone,name) running in Docker.
To run a new instance of the ApiDQ services on your server you need:
- Sign contract with ApiDQ team
- Get access parameters to GitLab and SFTP server (
gitlab_login,gitlab_password,sftp_login,sftp_password) and the license key (LICENSE_KEY) from ApiDQ team - Download dictionaries - instruction
- Install and configure the database - instruction
- Install and configure ApiDQ services - instruction
Installing new versions and dictionaries is described in Update and rollback.
Server requirements #
The instructions in this section are written and verified for the following environment:
| Component | Version |
|---|---|
| Operating system | Ubuntu 24.04 LTS |
| PostgreSQL | 18 + PostGIS 3 |
| Docker | Docker Engine with the Docker Compose v2 plugin (docker compose command) |
Recommended resources for the address service for Russia (RU): 8 CPU, 8 GB RAM or more. The database with dictionaries takes about 40 GB; considering dictionary files and headroom for updates we recommend a disk of 100 GB or more (SSD).
We recommend deploy ApiDQ services and database on different virtual servers. Installing both on a single server is also possible - the differences are noted in the instructions.
Network access #
The following addresses must be reachable from the ApiDQ servers:
| Address | Purpose |
|---|---|
gitlab.apiship.ru:5050 | Docker Registry with service images |
storage.apidq.io:65110 | SFTP server with dictionaries |
api.apidq.io:443 | Automatic license key prolongation |