# connectforlife/vxnaid-biometric-server architecture

> Architecture diagram of the GitHub repository connectforlife/vxnaid-biometric-server, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/connectforlife/vxnaid-biometric-server
- Repository: https://github.com/connectforlife/vxnaid-biometric-server

## Overview

##### Project type and purpose
- This is a Docker‐based, full‐stack biometric server packaging the Neurotechnology Iris matcher SDK and a MySQL database.
- Its purpose is to stand up an Iris‐matching service in containers, expose matching APIs, and persist results in MySQL via ODBC.

##### File structure
Top level:
- .env.sample, .gitignore – environment and VCS ignore rules
- Dockerfile – builds the biometric‐server image
- docker-compose.yml – orchestrates the biometric container and the MySQL container
- README.md – usage and setup instructions
biometric/
- config/NServer.conf – server ports, database queries, and service parameters
- config/pgd.conf.sample – license configuration for Neurotechnology products
- neurotech_iris.tar.gz – packaged Neurotechnology Iris SDK
- startServer.sh – entrypoint script to initialize the SDK and launch the Iris server
mysql/
- drivers/… – MySQL ODBC driver binaries for Linux
- mysql_template – ODBC DSN template for MySQL connectivity
- vmp_table_create_script.sql – database schema for storing and querying templates

##### README for additional insights
- Two required licenses (Iris matcher and server) must live under biometric/config/Licenses and be referenced in pgd.conf.
- docker-compose is the one-step installation mechanism.
- You monitor logs on the iris service container to troubleshoot.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Project Root Files
    subgraph "Project Root"
        Env[".env.sample"]:::config
        Gitignore[".gitignore"]:::config
        Readme["README.md"]:::doc
        Dockerfile["Dockerfile"]:::artifact
        Compose["docker-compose.yml"]:::artifact
        BiometricContext["biometric/"]:::artifact
    end

    %% External Clients
    Client["Client Apps"]:::external

    %% Biometric Server Container
    subgraph "Biometric Server Container"
        IrisServer["Iris API Server"]:::container
        StartScript["startServer.sh"]:::script
        NServerConf["NServer.conf"]:::config
        pgdConf["pgd.conf.sample"]:::config
        SDKArchive["neurotech_iris.tar.gz"]:::artifact
        LicenseStore["License Store"]:::artifact
    end

    %% MySQL Container
    subgraph "MySQL Container"
        MySQLDB["MySQL DB"]:::db
        ODBCDir["ODBC Driver Directory"]:::drivers
        ODBCBinary["mysql-connector-odbc-8.0.25-linux-glibc2.12-x86-64bit.tar.gz"]:::drivers
        DSNTemplate["mysql_template"]:::config
        SchemaScript["vmp_table_create_script.sql"]:::config
    end

    %% Connections
    Client -->|"HTTP/REST"| IrisServer
    IrisServer -->|"entrypoint"| StartScript
    IrisServer -->|"uses config"| NServerConf
    IrisServer -->|"uses license config"| pgdConf
    IrisServer -->|"loads SDK"| SDKArchive
    IrisServer -->|"reads license files"| LicenseStore
    IrisServer -->|"ODBC queries"| MySQLDB
    MySQLDB -->|"driver files in"| ODBCDir
    ODBCDir -->|"contains binary"| ODBCBinary
    MySQLDB -->|"DSN from"| DSNTemplate
    MySQLDB -->|"initial schema"| SchemaScript
    Dockerfile -->|"builds image for"| IrisServer
    Compose -->|"orchestrates"| IrisServer
    Compose -->|"orchestrates"| MySQLDB
    BiometricContext -->|"context for build"| Dockerfile

    %% Click Events
    click Env "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/.env.sample"
    click Gitignore "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/.gitignore"
    click Readme "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/README.md"
    click Dockerfile "https://github.com/connectforlife/vxnaid-biometric-server/tree/main/Dockerfile"
    click Compose "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/docker-compose.yml"
    click BiometricContext "https://github.com/connectforlife/vxnaid-biometric-server/tree/main/biometric/"
    click StartScript "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/biometric/startServer.sh"
    click NServerConf "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/biometric/config/NServer.conf"
    click pgdConf "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/biometric/config/pgd.conf.sample"
    click SDKArchive "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/biometric/neurotech_iris.tar.gz"
    click ODBCDir "https://github.com/connectforlife/vxnaid-biometric-server/tree/main/mysql/drivers/"
    click ODBCBinary "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/mysql/drivers/mysql-connector-odbc-8.0.25-linux-glibc2.12-x86-64bit.tar.gz"
    click DSNTemplate "https://github.com/connectforlife/vxnaid-biometric-server/tree/main/mysql/mysql_template"
    click SchemaScript "https://github.com/connectforlife/vxnaid-biometric-server/blob/main/mysql/vmp_table_create_script.sql"

    %% Styles
    classDef container fill:#d0e6f6,stroke:#036,stroke-width:2px
    classDef db fill:#ffe599,stroke:#b58500,stroke-width:2px
    classDef config fill:#f4cccc,stroke:#b85450,stroke-width:2px
    classDef script fill:#c9daf8,stroke:#1155cc,stroke-width:2px
    classDef artifact fill:#d9ead3,stroke:#6aa84f,stroke-width:2px
    classDef drivers fill:#ead1dc,stroke:#a64d79,stroke-width:2px
    classDef external fill:#fff2cc,stroke:#bf9000,stroke-width:2px
    classDef doc fill:#fce5cd,stroke:#cc6600,stroke-width:2px
```
