LogoALPR Database Docs
Installation

Linux

Installation instructions for Linux systems.

Approximate setup time: 15 minutes

Prerequisites

You will need the following software installed on your system:

  • Docker
  • Docker Compose
  • Docker Engine enabled and running

If you don't have Docker installed, you can install it with one of the following guides

Installation

Choose a location on your machine with sufficient storage for ALPR recognitions (at least 50GB recommended), create a new directory, and run the installation script:

  1. Create and navigate to a new directory:
Terminal
mkdir ALPR_Database
cd ALPR_Database
  1. Run the installation script:
Terminal
curl -sSL https://raw.githubusercontent.com/algertc/ALPR-Database/main/install.sh | sudo bash

The script will automatically:

  • Set up the necessary directories
  • Download the Docker Compose configuration
  • Start the ALPR database containers

The application should now be running at

http://localhost:3000

Copy Your API Key

  1. Access the ALPR Database web interface at http://localhost:3000 (or your server's IP address)
  2. Click the gear icon in the bottom left corner and navigate to the security section
  3. Copy your API key from the bottom of the page API Key

Configure Blue Iris

We will now configure an alert action for the camera in Blue Iris to send the response from the AI to the database.

  1. Open the settings for your ALPR camera in Blue Iris
  2. Navigate to Alert tab and open your alert actions with the On Alert button at the bottom of the window
  3. Click on the + button to add a new alert and select type MQTT/Web Request
  • Configure the alert with the following payload, replacing [docker-ip] with the IP address of your docker machine:
Request Address
[docker-ip]:3000/api/plate-reads
Post/payload
{ "ai_dump":&JSON, "Image":"&ALERT_JPEG", "camera":"&CAM", "ALERT_PATH": "&ALERT_PATH", "ALERT_CLIP": "&ALERT_CLIP", "timestamp":"&ALERT_TIME" }
Add HTTP headers
x-api-key: YOUR_API_KEY

Your Alert should look like this: BlueIris Alert

Done!

You're now collecting and storing your ALPR data. New detections will appear in the live feed.

Next Steps

On this page