Using the images with Docker Compose

You can use the example contained in the package (see Package overview) to set up a deployment using Docker Compose.

The example files are for evaluation purposes only. They are a good starting point for your own deployment, but should not be used in productive environments "as is" without proper configuration.

In particular, you need to do the following:

• Update the pre-installed certificates.

• Change the pre-defined credentials.

To run the images with Docker Compose

1. If required, extract the package archive:

   tar -zxvf docker-<release_version>.tar.gz

   Replace the following:

   • release_version. The specific version of the package archive, for example, 3.29.0.1234.

   This extracts the package content to a release_version folder, for example, 3.29.0.1234.

2. Import the image bundle archive into the local Docker registry:

   docker load ‑i images.tar

3. Change to the example deployment folder:

   cd <package_folder>/examples/docker-compose

   Replace the following:

   • package_folder. The absolute path to the folder that contains the extracted package content.

4. Review and adapt the deployment configuration file, i.e. docker-compose.yml. In particular, note the following:

   • OneSpan Authentication Server and MDC log files are stored in the ./logs folder.

   • The database files are stored in the ./db folder.

5. Allow write access for the containers to the db and logs folders:

   chmod ‑R 777 db logs

6. Review and adapt the configuration for OneSpan Authentication Server and Message Delivery Component (MDC) using the GUI configuration image (see Using the GUI configuration image):

   sudo xhost +local:docker
   
   docker run --rm --user $(id -u) \
              -v $(pwd)/config:/mnt \
              -e DISPLAY=$DISPLAY \
              -v /tmp/.X11-unix/:/tmp/.X11-unix/ \
              onespan_config:<release_version>

   Replace the following:

   • release_version. The specific version of the images distributed in the package, for example, 3.29.0.1234.

7. Run the images:

   docker compose up ‑d

   Safe container start

   You can add the --wait option to block the command-line interface and wait until all containers are running and ready for requests (healthy):

   docker compose up -d --wait

To stop running containers

• Run the following command:

  docker compose down

To restart running containers

• To restart a locally running service, delete the container and re-create it. Run the following commands:

  docker compose down <service_name>
  docker compose up ‑d <service_name>

  Replace the following:

  • service_name. The name of a service as it is defined in the services section of the used deployment configuration file, for example, ias.

  Restarting the containers with docker compose restart or docker restart is currently unsupported.