ncheckadmin/bioattendance repository overview

⁠Run the server

⁠1. Setup Docker

1. Windows https://docs.docker.com/desktop/install/windows-install/⁠
2. Linux https://docs.docker.com/desktop/install/linux-install/⁠
   
   

⁠2. Prepare the Program Data Directory

• Create a Directory <ProgramData>
• Copy License files to <ProgramData>/NCheck/License
  • license.lic
  • config.xml
    
    

⁠3. Run the Server

docker run -d -p <port>:8443 -v <ProgramData>:/ProgramData --name ncheck ncheckadmin/bioattendance:<version>

⁠Stop

docker stop ncheck

⁠Start

docker start ncheck

⁠Configurations

Additional Arguments can be passed as Environment variables

docker run -d -p <port>:8443 -v <ProgramData>:/ProgramData -e VARIABLE1=’value1’ -e VARIABLE2=’value2’ --name ncheck ncheckadmin/bioattendance:<version>

⁠Database Configuration Guide

⁠🔹 Database Configuration by Version

⁠✅ For versions 6.1.0.x and above (New Parameters):

⁠Example (MySQL)

docker run -d -p 8443:8443 -v /ProgramData:/ProgramData -e DB_TYPE=MYSQL -e DB_SERVER="database-server" -e DB_PORT="database-port" -e DB_NAME="ncheck_database" -e DB_USERNAME="db_user" -e DB_PASSWORD="db_password" --name ncheck ncheckadmin/bioattendance:6.1.0.x

⁠✅ For versions 6.0.1.x and below (Legacy Parameters):

⁠Database Type (Optional)

Database type can be selected to configure the database to connect to SQLite, MySQL, MSSQL, Oracle. If not specified SQLite will be used.

DB_TYPE
Values can be one of SQLITE, MYSQL, MSSQL, ORACLE

⁠1. SQLite

DB_FILE : Database File name
Database will be stored in <ProgramData>/NCheck/databases/server/sqlite

DB_PASSWORD : Database encryption password
If password not specified Database will not be encrypted. SqlCipher v3 Will be used for encryption.

⁠2. MySQL, MSSQL, Oracle

DB_URL : Database URL
DB_USER_NAME : Database username
DB_PASSWORD : Database Password
DB_MAX_CONNECTIONS : Maximum connections for the database. (Default value for connection count is 30)

⁠Example (MySQL)

docker run -d -p 8443:8443 -v /ProgramData:/ProgramData -e DB_TYPE=MYSQL -e DB_URL="jdbc:mysql://database-server:3306/ncheck_database" -e DB_USER_NAME="db_user" -e DB_PASSWORD="db_password" --name ncheck ncheckadmin/bioattendance:6.0.1.x

⁠🔹 Other Configurations (all versions)

⁠Keystore (Optional)

To setup SSL Certificate copy the keystore file (pfx) to <ProgramData>/NCheck/Keystore/<KeystoreFile>

KEYSTORE : Keystore file name
KEYSTORE_ALIAS : Keystore Alias
KEYSTORE_PASSWORD: Keystore Password

⁠Restore (Optional)

Copy the Backup file to <ProgramData>/NCheck/databases/server

DB_BACKUP_FILENAME : Backup File name
DB_BACKUP_PASSWORD : Backup file password

⁠NMatcher Configuration (Optional)

NMATCHER_HOST : NMatcher Host name
NMATCHER_PORT : NMatcher Port

⁠JVM Heap Size (Optional)

MAX_HEAP : Maximum Heap Size Eg: 6g