Sign In
Sign Out

Tutorial: Using the License Service Client docker image

In this tutorial, we will guide you through the process of setting up the License Service Client to connect to Carmen Cloud's public license service. This client simplifies the use Adaptive Recognition's image recognition engines without the need for a hardware key.

Prerequisites​

  1. Register on the Carmen Cloud website to obtain an API key.
  2. Subscribe to the Carmen® License Service (for Carmen Go and Carmen Video SDK, use the "Carmen GO for video processing" option; for all other products (e.g. Carmen FreeFlow SDK) choose "Carmen FreeFlow"). The number of options you purchase determines the maximum number of license locks (image reads) in parallel.
  3. Make sure you have Docker installed on your machine.

Steps:​

1. Pull the Docker Image​

You can pull the Docker image using the following command:

docker pull public.ecr.aws/arcloud/license-service-client:[x86-64|arm64]

2. Set Up Environment Variables​

Before you run the Docker image, you need to configure a few environment variables:

  • ApiKey: This is the API key you obtained after registering on the Carmen Cloud website.

  • ServiceName: Optional; defaults to hosting computer's hostname. It can be helpful for troubleshooting as it will appear in the logs of the public service, providing a more descriptive way to identify the client compared to just the IP address.

  • ThreadCount: Optional; defaults to 2. The License Service Client puts all incoming requests into a thread safe queue and by default uses 2 worker threads to serve them. The number of workers can be increased if the Client proves to be a bottleneck in serving requests, provided that the underlying hardware allows it.

Set these environment variables using the following syntax:

export ApiKey=YOUR_API_KEY_HERE
export ServiceName="Carmen Cloud License Service Client" # Optional
export ThreadCount=2 # Optional

3. Run the Docker Container​

Once the environment variables are set, you can run the Docker container. By default, you can use the standard port, but if you wish to map it to a different port, you can use the -p option in the docker run command.

docker run -e ApiKey=$ApiKey \
    -e ServiceName=$ServiceName \
    -e ThreadCount=$ThreadCount \
    -p [YOUR_DESIRED_PORT]:8998 \
    public.ecr.aws/arcloud/license-service-client:[x86-64|arm64]

Note: Replace [YOUR_DESIRED_PORT] with the port number you want to use on your machine, and [x86-64|arm64] with your processor architecture.

4. Test the Setup​

Once the License Service Client is running, you can connect your software components to it depending on the product you are using:

  • Carmen FreeFlow: Refer to the CONFIGLSCLIENT section of the Carmen® User Manual for detailed instructions on configuring FreeFlow with the License Server.
  • Carmen OCR: Refer to the CONFIGLSCLIENT section of the Carmen® User Manual for detailed instructions on configuring Carmen OCR with the License Server.
  • Carmen Axis: Refer to CONFIGURING THE LICENSE SERVER section of the Carmen® Axis Video App User Manual for detailed instructions on configuring Carmen Axis with the License Server.
  • Carmen GO: Refer to CONTROL PANEL section of the Carmen® GO User Manual for detailed instructions on configuring Carmen GO with the License Server.

Conclusion​

With the License Service Client Docker image, it becomes very convenient to use the company's image recognition engines. Always remember to keep your API key confidential to ensure the security of your cloud resources.