IDV Installation Example

This installation example is for demonstration purposes only. Do not use it in production!

Minimum System Requirements

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:

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

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: Use your server's public IP address or domain name.

For Local Development: Use your computer's local IP address.

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

6. Start services:

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

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:

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 HTTP for it.

If you want to run Face API in GPU mode: