Skip to content

Quick Setup with Docker Compose

This example is for demonstration only and is not intended for production deployments. For a complete list of available configuration parameters and environment variables, see Regula IDV Deployment Guide

Prerequisites

  • Linux OS
  • CPU: 4 cores
  • RAM: 16 GB

Installation Steps

1. Download the idv-setup.zip file and save it as idv-setup.zip:

wget https://docs.regulaforensics.com/develop/idv/overview/files/idv-setup.zip -O idv-setup.zip

2. Make a separate directory and unzip the contents:

mkdir -p idv-setup && unzip idv-setup.zip -d idv-setup && cd idv-setup

3. Add a license file. Place the required license file (regula.license) at the same level as the docker-compose.yaml file.

4. Add permissions for the data folder and license:

sudo chown -R 1001:$(id -g) data regula.license && sudo chmod -R 770 data regula.license

5. Modify IDV_CONFIG__BASEURL. In .env-example, find IDV_CONFIG__BASEURL and set the value to the base URL of your application.

For a Public Server: Set it to your server's public IP address or domain name.

For Local Development: Set it to your computer's local IP address.

This allows mobile devices on the same local network to access the application.

For an exhaustive list of all available enterprise configuration parameters and environment flags, check the main IDV Deployment Details

6. Start services. Run the following command from your idv-setup directory:

docker compose --env-file .env-example up -d

Access Application

1. Open your web browser and navigate to the application's URL. The correct address depends on your installation type:

  • Local Installation: Go to http://0.0.0.0:8000 or http://localhost:8000 on the machine where the application is running.
  • Public Installation: Go to http://<YOUR_PUBLIC_IP>:8000, replacing <YOUR_PUBLIC_IP> with your server's actual public IP address.

2. Use the following default credentials to log in:

  • Username: regula-idv
  • Password: t3stP@ss

3. Start the verification process:

  • Download the iOS or Android Regula IDV mobile app.
  • Click New Verification in the browser and scan the QR code using the mobile app.
  • Proceed with verification in the mobile app.

Warning

Verification through the web app won't work as-is. To make it work, you have to set up your domain and enable HTTPS for it.

Run Face API in GPU Mode

If you want to run Face API in GPU mode:

  1. Select a GPU-enabled Face API image using the FACEAPI_TAG variable.
  2. Set the driver by setting GPU_DRIVER and GPU count by GPU_COUNT.
  3. Uncomment the deploy section in the docker-compose.yaml file.