Quickstart

Load the image, run the container, and get the /validate-address endpoint online.

To get quickly up and running with AIQ Realtime Services, various PCI-compliant container tools may be used. If you aren't using any in particular, we recommend Docker, a popular option. Installation instructions may be found on the official Docker website.

Running the Docker Container

This project consists of a Docker image compressed in .tar.gz format. To load this file as a Docker image, run the following command:

Load the image
docker load -i addressiq-web-image.tar.gz

And to run the container once you have loaded the image:

Run the container
docker run -d \
  -e FL_USER="<username>" \
  -e FL_PASS="<password>" \
  -v fl_data:/fl_data \
  -p 8080:8080 \
  addressiq-web
Important: You will need at least 50 GB of space on your machine to store the postal directories. The container makes the /validate-address endpoint available once the initial postal directory installation is complete. Installation progress can be monitored via the Docker logs.

Setting the Postal Directories volume

Postal directories are data files containing address and geographic information, essential for precise geocoding and address validation. Our SDK software requires access to these files in order to run properly.

Postal directories are not included with the Docker container. Because they are very large files that need to be updated periodically, they should be managed outside of your Docker container. We recommend designating a place on your server where these files should reside and providing the filepath to your container(s) as a shared mounted volume. Using Docker, this is done by passing the filepath as an argument for the run command using the -v flag:

Mount the postal directories volume
docker run -v fl_data:/fl_data <image-name>

Using FL_USER and FL_PASS

FL_USER="<username>" and FL_PASS="<password>" refer to credentials for Firstlogic's file repository. When these credentials are provided as part of the docker run command, the container will install the postal directories required by your SDK server and place them in the shared volume specified.

Tip: Prefer to manage postal directories yourself, or running in a network without egress to Firstlogic's filehost? See Configuration for the FL_DISABLE_DIR_UPDATES option.
PreviousPre-Deployment ConsiderationsNext Configuration