Skip to main content

Manual Installation Steps

If for some reason, you prefer not to use Plate Recognizer Installer, you can go through the steps below to manually install Stream with Docker.

danger

For the commands below, make sure to change XXXXX with your License Key and YYYYY with your Plate Recognizer Token. Get your token and license key.

List of Docker Images#

If you want to use a specific version of the software, set a tag. The tag structure is 

platerecognizer/alpr-stream:<country>-<architecture>-<version>
  • <country>: leave blank for global engine, thailand, germany, korea, japan, egypt
  • <architecture>: leave blank for x86, raspberry, jetson, no-avx
    • For the Jetson image, we support 2 Jetpack versions: jetson-r35.1.0 and jetson-r32.6.1.
  • <version>: leave blank for latest.
  • To see all the tags, open on our Docker Hub and then click "Tags".

Here are a couple of examples:

  • Intel x86 (with AVX instructions)
    • Global platerecognizer/alpr-stream
    • Thailand platerecognizer/alpr-stream:thailand
  • Raspberry Pi (LattePanda, Orange Pi)
    • Global platerecognizer/alpr-stream:raspberry
  • Apple Silicon M1/M1 Pro use the Raspberry Pi image
  • Nvidia Jetson (with GPU)
    • Global platerecognizer/alpr-stream:jetson
    • Specific version platerecognizer/alpr-stream:jetson-1.28.1-r32.6.1

STEP 1#

Please have a look at Before Run for installation prerequisites then create a Stream folder. For example:

c:\users\kyt\documents\stream

STEP 2#

Install Docker and confirm that it's running.

Docker Desktop on Windows

If using Docker Desktop on Windows with the legacy Hyper-V backend and not WSL2, make sure to check this box (next to C) for Resource File Sharing and the click “Apply & Restart”. Step 2

STEP 3#

caution

For the following commands:

  • Update directory bound to /user-data to your local directory. -v /path/to/my/folder:/user-data
  • --restart="unless-stopped" is included so Stream automatically restarts(upon system reboot or Docker restart) unless explicitly stopped. This works great when combined with the -d option so Stream runs in the background.

Starting Stream on Linux#

In a terminal, run the following command:

docker pull platerecognizer/alpr-stream

To start the program, use docker run. If you are using Linux (Intel x86):

docker run --restart="unless-stopped" -t --name stream \  -v /home/kyt/documents/stream:/user-data --user `id -u`:`id -g` \  -e LICENSE_KEY=XXXXX -e TOKEN=YYYYY \  platerecognizer/alpr-stream

Having problems? Make sure to read the docker run checklist.

Starting Stream on Windows#

Open up CMD Command Prompt Step 3

In Command Prompt, run the following command:

docker pull platerecognizer/alpr-stream

If you are using Linux on Windows (e.g. Ubuntu): then run in Command Line:

docker run --restart="unless-stopped" -t --name stream -v c:\users\kyt\documents\stream:/user-data -e LICENSE_KEY=XXXXX -e TOKEN=YYYYY platerecognizer/alpr-stream

Having problems? Make sure to read the docker run checklist.

Starting Stream on Nvidia Jetson#

note

Need some help? See our Jetson FAQ for technical questions and advanced configuration options.

In Command Prompt, run the following command.

docker pull platerecognizer/alpr-stream:jetson

If you are using a Jetson device, make sure to include --runtime nvidia --group-add video. The latest image is built for Jetpack 4.6 using it with another version may trigger errors. Otherwise, you can use older images.

docker run --restart="unless-stopped" --runtime nvidia -t --name stream \  -v /home/kyt/documents/stream:/user-data --privileged \  --group-add video --user `id -u`:`id -g` \  -e LICENSE_KEY=XXXXX -e TOKEN=YYYYY \  platerecognizer/alpr-stream:jetson

Having problems? Make sure to read the docker run checklist.

Starting Stream on Raspberry Pi#

In Command Prompt, run the following command.

docker pull platerecognizer/alpr-stream:raspberrydocker run --restart="unless-stopped" -t --name stream \  -v /home/kyt/documents/stream:/user-data --privileged \  --group-add video --user `id -u`:`id -g` \  -e LICENSE_KEY=XXXXX -e TOKEN=YYYYY \  platerecognizer/alpr-stream:raspberry

Having problems? Make sure to read the docker run checklist.

STEP 4: First Run#

  • The first time you start Stream (Step 3), a config.ini file is created in your Stream folder.
  • Now edit config.ini and change the url field. This can either be a video or an RTSP camera.
  • Run the container again. Here's the expected output.