How do I install the Rekor Scout™ Agent?

Choose your data destination and follow the appropriate steps given to you

Installation

Follow the appropriate directions for your operating system below. After completing the installation, you can choose between four data destination options depending on how you wish to use the Scout Agent.

  1. Scout Cloud: Send data to https://cloud.openalpr.com (a Scout web server hosted by Rekor).

  2. Scout On-Premise: Send data to an on-premise Scout web server (hosted by you on a Linux machine).

  3. Other HTTP Web Server: You wish to integrate Scout with your own application. Send data to your own HTTP endpoint.

  4. Local Queue: Store data locally in beanstalkd and drain the queue programmatically from your application.

If you intend to use the agent for surveillance purposes, you will most likely select Scout Cloud or Other HTTP Web Server. Options 3 and 4 are useful if you are a developer integrating Scout data into your own application.

 

 

Windows

  1. Download the Rekor Scout Windows Installer.

  2. Right-click the .exe file, run as administrator, and follow the install wizard.

Ubuntu Linux

Installation on Linux requires basic knowledge of using the terminal. If you do not already have Linux installed as an operating system, please complete these steps before continuing:

  1. Download the Ubuntu 20.04 64-bit install image and copy it to a bootable flash drive.

  2. Follow this installation guide.

If you already have Linux installed:

  1. Open a new terminal

  2. Ensure you have curl installed by running the following command from the terminal:

     
    sudo apt-get update && sudo apt-get install -y curl
  3. Run our installer script and choose install_agent

     
    sudo apt update && sudo apt install -y curl
    bash <(curl -s https://deb.openalpr.com/install) # select "install_agent"
  4. Select yes/no when prompted to connect the Agent to your cloud account

  5. If you are using a GUI, you can configure the agent using the alprdconfig utility by running the following command:

  6. If your server does not have a GUI and you wish to connect your software to a Scout web server, do the following:

    1. alprlink-register -w https://[ip_address_of_web_server]

    2. Enter the e-mail address and password for your Scout Cloud account, or the one you used when installing the on-premise webserver.

Docker

  1. Open a new terminal

  2. Pull the latest OpenALPR Docker image

     
    docker pull openalpr/agent:4.1.1
  3. Enable the license for the agent

     
    docker run -P -v openalpr-vol1-config:/etc/openalpr/ -v openalpr-vol1-images:/var/lib/openalpr/ -it openalpr/agent openalpr-licenseregister
  4. Configure it to point to a Scout web server (default is https://cloud.openalpr.com)

     
    docker run -P -v openalpr-vol1-config:/etc/openalpr/ -v openalpr-vol1-images:/var/lib/openalpr/ -it openalpr/agent alprlink-register
  5. Start the container

     
    docker run --restart always -d --cap-add SYS_NICE -P -v openalpr-vol1-config:/etc/openalpr/ -v openalpr-vol1-images:/var/lib/openalpr/ -it openalpr/agent

Jetson

The Scout Agent can be installed on NVIDIA Jetson devices such as the Nano, TX-1, and TX-2. These are excellent options for an edge device due to the power-efficient, embedded GPU. Native binaries are available for JetPack versions 4.4-4.6. The recommended package for other JetPack versions is the Jetson Docker image

  • JetPack >= 4.2.1: pull the Docker image for openalr/agent:4.1.1-jetson and follow Docker instructions above

  • JetPack 4.4.0-4.6.x : follow Linux install instructions above

Note that both native and Docker installations will automatically include the additional GPU packages. Therefore, you will not need to reference the GPU acceleration section of the documentation. When installing via Docker, make sure you have NVIDIA Docker Runtime available so that the container can access the host GPU. You will also need to modify any Docker run commands.

 
docker run --runtime nvidia -e NVIDIA_DRIVER_CAPABILITIES=compute,video [other_flags] [image_tag] [command]

Axis Cameras

Install the Scout Agent as an app on Axis cameras that sends video to the cloud for processing. The following prerequisites are required:

  • A Rekor Scout™ Commercial subscription on cloud.openalpr.com (on-premise web servers are not supported)

  • A supported Axis camera

  • An SD Card with at least 2GB of storage space

  • Internet Connectivity (minimum 2Mbps upload speed)

  • Accurate date/time. We recommend configuring NTP (See Setup > Date & Time)

  • DNS Configuration (See Setup > Advanced TCP/IP Settings)

  • The latest Axis firmware (minimum is 5.60.1.1)

After checking the perquisites, follow these steps for installation:

  1. Download the latest OpenALPR Axis App:

    1. For Axis ARTPEC-6, ARTPEC-7, and most Ambarella-based processors: OpenALPR Axis Agent

    2. For Axis ARTPEC-5 and earlier processors: OpenALPR Axis Agent

    3. For less common Axis cameras and or previous app releases check All Axis Camera Apps

  2. Login to your Axis Camera

  3. Click Setup in the top right corner

  4. Click Applications

  5. Click the Choose File button, select OpenALPR_cloud_latest_mipsisa32r2el.eap (downloaded above), and then click the Upload Package button

  6. Click OpenALPR Cloud and then Start (you will be prompted for your cloud.openalpr.com credentials)

As vehicles move past the camera, the video will be sent to Rekor Scout for archiving and processing. You can view video recorded in the past 60 days using the Video link on the left. As license plates are detected, they will appear on our cloud account dashboard.

Raspberry Pi

Even newer models of the Pi can only handle single-digit FPS loads from a live stream, so they are best reserved for processing still frames with the SDK or for enthusiasts to tinker with Scout Agent. For production deployments on edge devices, we strongly recommend one of the Jetson devices mentioned above.

Like Jetson, the preferred installation method for Raspberry Pi is Docker. Follow the instructions above using the Docker image for openalr/agent:2.8.101-jetson (since it is built for ARM-64 architectures). Unlike Jetson, the Pi does not have a GPU so you will need to turn off the default configuration. After starting the container:

  1. Get its ID from docker ps

  2. Open a terminal inside the container: docker exec -it [container_id] bash

  3. Open /etc/openalpr/alprd.conf with your text editor of choice

  4. Change hardware_acceleration from 1 to 0 and save the file

  5. Restart the agent to apply the changes: systemctl restart openalpr-daemon