Dashboard SDK Initial Integration Guide
Learn how to integrate the FaceTec Dashboard into Your System.
Prerequisites
Running the FaceTec Dashboard
MongoDB
- Download and extract “Server Dashboard” from Download SDKs.
- Open a terminal in the root of the Server Dashboard Directory.
- In config.yaml, set
mongodb: uri:to the MongoDB connection string. - Run
docker compose build facetec_server_prebuilt_with_usage_log_server. - Run
docker compose up facetec_server_prebuilt_with_usage_log_server. - On success, http://localhost:3002 will open the Dashboard for Your MongoDB Instance.
PostgreSQL
- Download and extract “Server Dashboard” from Download SDKs.
- Open a terminal in the root of the Server Dashboard Directory.
- In config.yaml, set
databasetopostgresql. - In config.yaml, make the following changes underneath
postgresql:- Set the URL to Your PostgreSQL.
- Set the Port to the one being connected to.
- Set the username that the Dashboard will use to connect to Your Database.
- Set the password for the user.
- Set the database name you want to connect to.
- Run
docker compose build facetec_server_prebuilt_with_usage_log_server. - Run
docker compose up facetec_server_prebuilt_with_usage_log_server. - On success, http://localhost:3002 will open the Dashboard for Your PostgreSQL Instance.
# REQUIRED If using database == "postgresql".
postgresql:
# The SQL Connection URL. This UR: *must be* accessible from your container and/or host.
# Example SQL URL for running locally - localhost
url: "<DATABASE_URL>"
# The Port that your Database exposes. Default Port is 5432
port: 5432
# The User that Dashboard will use to connect to your Database.
username: "<USERNAME>"
# The Password of the User that Dashboard will use to connect to your Database.
password: "<PASSWORD>"
# The the name of your PostgreSQL Database.
databaseName: "facetec_sdk_data"Important Note: Please ensure that all deployed Dashboard SDKs are not open to the public internet, utilize Basic Authentication, and have SSL configured.
Additional Step - Configuring SSL
FaceTec Dashboard SDK displays sensitive information like photos and other Personal Identifiable Information (PII). For these reasons, the FaceTec Dashboard SDK should be accessible only to approved personnel and not open to public traffic. This is usually handled by configuring the Dashboard SDK to only be reachable via HTTPS calls within an internal or private network. To make HTTPS calls with the Dashboard SDK, you need to first establish a Secure Socket Layer (SSL) Certificate. There are numerous ways to do this, depending on your architecture and whether you are using a Cloud Provider or not.
On AWS, you can use a Classic Load Balancer and connect it to Amazon Certificate Manager. After the Classic Load Balancer is connected, you can finish the SSL Configuration by following the remaining steps in the AWS Documentation. These steps should be similar to those used in other Cloud Services.
Important Note: Configuring specific web servers is outside the scope of our support. Adding an SSL to a web server is a task usually handled by a Network Administrator.