Installation - Verilock

Prerequisites

Before you begin, ensure you have:

Docker installed

Docker Engine 24+ and Docker Compose v2+ are required.

docker --version   # Docker version 24.0+
docker compose version  # Docker Compose version v2.20+

Ubuntu/Debian
RHEL/CentOS
macOS

curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER

sudo dnf install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
sudo systemctl enable --now docker

brew install --cask docker

License key

A valid Verilock license key (vrl_...). Get one from the Portal.

Quick Install

1. Download the bundle

Download from the Portal Downloads page, or manually:

mkdir verilock && cd verilock

2. Configure environment

Copy and edit the environment file:

cp .env.selfhost .env
nano .env

Change all default passwords before deploying to production. At minimum, update:

DB_PASSWORD
REDIS_PASSWORD
MINIO_SECRET_KEY and AWS_SECRET_ACCESS_KEY (must match)

Required settings:

Variable	Description	Example
`VERILOCK_LICENSE_KEY`	Your license key	`vrl_a6cd48bd...`
`APP_URL`	Public URL of your instance	`https://kyc.company.com`
`DB_PASSWORD`	PostgreSQL password	Use a strong password
`REDIS_PASSWORD`	Redis password	Use a strong password

Optional settings:

Variable	Description	Default
`APP_PORT`	Port to expose the app	`8080`
`MAIL_MAILER`	Mail driver (smtp, ses, mailgun)	`smtp`

3. Start the services

docker compose up -d

This will:

Pull all required Docker images
Start PostgreSQL, Redis, MinIO, and the AML engine
Run database migrations automatically
Cache configuration
Start the application with queue workers

First startup takes 2-5 minutes as images are downloaded and the database is initialized.

4. Verify the deployment

# Check all containers are running
docker compose ps

# Check application health
curl http://localhost:8080/up

# View application logs
docker compose logs app -f

You should see:

==========================================
 Verilock Identity — Ready
 Version: 1.0.0
==========================================

5. Access the application

Open http://localhost:8080 (or your configured APP_URL) in your browser.

Dashboard: /dashboard — Create your first admin account
API: /api/v1/ — Ready to accept API calls
Developer Docs: /developer — Built-in API documentation

Post-Install

Create API Keys

Generate API keys to start integrating

Configure Mail

Set up email for OTP and notifications

Set Up SSL

Configure HTTPS with a reverse proxy

Configure Storage

Set up document storage

​Prerequisites

​Quick Install

​1. Download the bundle

​2. Configure environment

​3. Start the services

​4. Verify the deployment

​5. Access the application

​Post-Install

Create API Keys

Configure Mail

Set Up SSL

Configure Storage

Prerequisites

Quick Install

1. Download the bundle

2. Configure environment

3. Start the services

4. Verify the deployment

5. Access the application

Post-Install