Sign In
Sign Out

Quick Start

Carmen® Worker can be hosted in any environment compatible with Docker container images (e.g. plain Docker, Docker Swarm, Kubernetes, hosted Docker in various cloud providers, etc.).

External internet connectivity is required to access the Carmen® Cloud public license service. This cloud-based server implements the same usage restrictions as the user's cloud subscription. You will need to have a Carmen® Recognition Service subscription as a prerequisite for this tutorial. Before continuing, make sure you have an account and find your API key in the Carmen® Cloud Dashboard.

As a quick demo, let's start an instance on your local machine.

note

This guide assumes that you already have Docker installed. If you don't already have Docker on your machine, please read this quick start guide.

Download the Image​

First, pull the docker image from our repository (currently only the x86-64 architecture is supported):

docker pull public.ecr.aws/arcloud/carmen-worker:x86-64

Create a Config File​

The container image is configured using environment variables. We are going to pass variable values to the container using a config file. Create a file called .env in a temporary directory (in our example, /path/to/.env) with the following content:

LogLevel=INFO
SslEnabled=false
CarmenWorkerNodeName=Private Carmen Worker #1
CarmenWorkerInitDefaultEngines=true
CarmenWorkerMaxFileSize=10485760
CarmenWorkerHandlerCount=1
CarmenWorkerBacklog=100
CarmenWorkerRequestTimeout=10
IpnncServers=[{"name":"ipnnc1","host":"server1.ipnnc.adaptiverecognition.com","port":8443,"ssl":true,"apiKey":"<YOUR_API_KEY>"},{"name":"ipnnc2","host":"server2.ipnnc.adaptiverecognition.com","port":8443,"ssl":true,"apiKey":"<YOUR_API_KEY>"}]

ApiKey=<YOUR_API_KEY>

The only variable you'll need to modify is IpnncServers; please use your real Carmen® Cloud API key instead of the <YOUR_API_KEY> placeholders.

Start the Container​

Start the container with the following command:

docker run \
    --env-file /path/to/.env \
    -p 8080:8080 \
    --name carmen-worker\
    public.ecr.aws/arcloud/carmen-worker:x86-64

Try the API​

If everything went well, the Vehicle API should now be available at the address:

http://localhost:8080/vehicle

Transportation&Cargo API can be accessed at the address:

http://localhost:8080/transport