Docker Deployment Patterns

Each new SmartFace release for the Docker environment is available on our Github, specifically on the SmartFace repository https://github.com/innovatrics/smartface. For ease of use, we have prepared pre-made Docker Deployment Patterns. These represent the most commonly used situations and use cases.

When you deploy the repository to your local directory, you can see each Deployment Pattern has its folder within the smartface/sf-docker/ directory.

Currently, we provide these sample Docker Deployment Patterns:

ℹ️ We support both the x86-64 and ARM architecture. Starting with version 5.4.26, we do not have a specific deployment pattern for ARM devices, such as the NVidia Jetson. ARM devices are designed for low power consumption - power efficiency, making them suitable for embedded and edge computing applications where power consumption is a critical factor. These devices can use the same deployment patterns, correct docker images will be provided automatically.

To enable hassle-free update between versions, please consider keeping the production deployment outside of the local repository clone. This way updating the local repository to the latest version will not overwrite your specific deployment configuration. Changes related to each update are available in the Table of Releases and the Upgrades section of the Releases.

You can find more information about the scaling of services and updating the environment variables.

all-in-one

The all-in-one is the most universal Deployment Pattern as it provides each type of SmartFace Platform service. On top of the SmartFace Platform services It also provides the SmartFace Station and the Access Controller module with sample configurations.

This pattern provides a scalable server platform for facial and pedestrian detection which can be easily integrated with third-party systems. It can process and analyze multiple real-time video streams in parallel.

SmartFace Platform covers most typical use cases when it comes to facial recognition and biometrics. It allows you to process video files, images or live video streams from RTSP cameras or smart embedded devices running SmartFace Embedded. Results of processing are stored into a database in the form of structured data together with images and can be accessed through an available REST API. Information is also provided through real-time notifications.

To find out how to alter this preset to better suit your project, please take a look at Maintenance for Docker guide. For information how to install this Deployment Pattern from the scratch, please read the Docker Installation steps.

Content

NameDescription
sf_dependenciesfolder that holds SmartFace PreRequisites' configuration
.enva file that holds general Environment variables
.env.sfaca file that holds Environment variables related to the Access Controller module
.env.sfstationa file that holds Environment variables related to the SmartFace Station
README.mda README file holding basic information and instructions
create-wl-stream-generation.sha script enabling the Edge Device watchlist synchronization
docker-compose.ymla docker compose definition file, setting up services for orchestration
run.shan installation and migration script to be run in a bash terminal

LFIS

The LFIS Deployment Patters represents the Lightweight Facial Identification Service.

The Lightweight Facial Identification Service is a lightweight, powerful, scalable, multi-platform and easy-to-deploy solution for facial biometrics use cases easily integrated to any third-party system via the REST API. Available for fast cloud and on premise deployment.

It supports advanced identity management, identities enrollment, verification, identification, and liveness check.

To find out how to alter this preset to better suit your project, please take a look at Maintenance for Docker guide. For information how to install this Deployment Pattern from the scratch, please read the Docker Installation steps.

Content

NameDescription
sf_dependenciesfolder that holds SmartFace PreRequisites' configuration
.enva file that holds general Environment variables
.env.sfstationa file that holds Environment variables related to the SmartFace Station
README.mda README file holding basic information and instructions
docker-compose.ymla docker compose definition file, setting up services for orchestration
run.shan installation and migration script to be run in a bash terminal