LogoLogo
  • Introduction
  • Use Cases
  • Getting Started
    • Starting the server
    • Configuration
    • Licensing and Authorization
    • Using the Swagger Docs page
    • Authorization
  • OpenCV FR Server
    • Collection Management
    • Person Management
      • Bulk Enroll or Update Persons
    • Face Search
    • Face Compare
    • Liveness Detection
Powered by GitBook
On this page
Export as PDF
  1. Getting Started

Starting the server

How to start the Docker container

Our Docker image can run on x86-64 CPU.

Follow the instructions below to run the server docker.

As the first step, you need to load the Docker image from the provided file.

docker load -i opencv-fr-server.tar

After loading the image, you can start the server via the script below. This script will start a docker container with the Server image and copy the license and server-config information into that container:

./start-docker-with-license.sh

Once the server is running, you can access the API documentation/OpenAPI Swagger Docs page by going to a browser on the local machine via:

http://localhost:7777/docs

The Swagger Docs page is useful to test the web APIs from your browser. The Swagger framework allows developers to create interactive, machine and human-readable API documentation. It is the framework that REST API developers are most familiar with.

We also provide RapiDoc documentation that is better looking and easier to read:

http://localhost:7777/rapidoc

Every time a Docker container is restarted, it assumes a new ID. Since only 5 concurrent IDs are allowed (by default) in the license, you might encounter an error if you frequently start/stop the Docker images. Thus, it is recommended to start a Docker image only once and let it run.

PreviousGetting StartedNextConfiguration

Last updated 2 months ago