1. Introduction¶
This manual describes the configuration of the server-side components of the GBS MIR application. GBS MIR is an application designed to help examiners treat biometric enrollment transactions that require manual review.
The configuration procedure should be done only after the installation step. For more information, refer to GBS Apps Setup Manual.
2. Configuration¶
The configurations steps are:
- Configure Tomcat;
- Configure Certificates;
- Generate encrypted password;
- Configure the config.properties file and MIR ip and port;
All steps are described below. An example config.properties
file is found in the Configuration File Example section.
Danger
All lines must be present in the configuration file. Commenting or deleting lines may cause unexpected behavior. For further information, contact Griaule Support Team.
2.1. Tomcat Configuration¶
Edit the Tomcat configuration file to configure the certificates and port that the application will use.
vi /var/lib/tomcats/mir/conf/server.xml
To change the port, look for Connector port=
. This is the port for the backend operations.
2.2. Certificates Configuration¶
To enable SSL authentication, search for connector port=
in the file /conf/server.xml
.
There are two entries. The commented one is the configuration for SSL. Remove the comment delimiters <!--
and -->
, and adjust these settings:
port="58194"
keystoreFile="/home/griaule/keystore"
keystorePass="password"
keyAlias="1"
clientAuth="true"
truststoreFile="/home/griaule/keystore"
truststorePass="password"
The parameter port
should be the desired network port for the application.
Change the path of keystoreFile
and truststoreFile
to the proper values. Do the same for keystorePass
and truststorePass
.
The parameter clientAuth="true"
will require authentication from server-side to client-side and from client-side to server-side. This means that the client will need to import the certificate in the browser to be able to access the application.
Warning
When clientAuth is set to true, the system administrator must provide the certificate.pfx file for the end-users.
2.3. Database password encryption¶
In the config.properties
file, the jdbc.password
parameter is an encrypted password. To generate the encrypted password, perform the following steps:
Go to the following directory:
cd /var/lib/tomcats/mir/webapps/gbs-mir-server/WEB-INF/lib
Execute the command:
java -cp gbs-common-db-<version>.jar com.griaule.commons.util.EncryptUtil <desiredPassword>
The encrypted password will be displayed after the message: “Encrypted password is:”
Note
Store this encrypted password. It will be used in the next step.
2.4. Application properties file¶
To configure the application properties file, open with:
vi /var/lib/tomcats/mir/conf/config.properties
The most important changes in this configuration file are the jdbc.url
, jdbc.username
, jdbc.password
and gbds.url
properties. Configure the parameters according to the environment.
The complete configuration file is shown in the Configuration File Example section.
Note
Remember to substitute the correct encrypted password generated in the Database password encryption section in the file.
2.4.1. MIR Configuration¶
The last step is configuring IP and port of the application that the end-user will access. It must be the same IP and port configured in the Tomcat Configuration section.
mir.ip=<ip>
mir.port=<port>
mir.protocol=<protocol>
Important
Make sure that the mir.ip
, mir.port
, and mir.protocol
configuration parameters are correctly specified in the config.properties
file. In many cases, the IP will be the same for various applications. However, each application will have a different and unique port.
3. Finish Configuration¶
After all configuration steps are complete, go back to the GBS Apps Setup Manual - Configuration Section.
4. Configuration File Example¶
This section shows an example of the config.properties
file.
# GBS MIR Server
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://192.168.0.200:3306/etr?useSSL=false
jdbc.username=root
jdbc.password=CDrt8vbewA2YAubPNOLZkw==
jdbc.dialect=org.hibernate.dialect.MySQLDialect
jdbc.showSql=false
locale=en_us
gbds.url=http://192.168.0.200:8085
gbds.user=gbds.authenticate
gbds.key=Griaule.123
gbds.logLevel=INFO
gbds.timeout=300
gbds.listExceptions.label=
fingerprint.useSDK=true
listFields=KEY:RG
gbds.mirUser=mir_server
sync.logLevel=INFO
same.user.simultaneous.login=false
server.standalone.port=8185
biometric.modules=FINGERPRINT,FACE
highlight.labels=
profile.cacheSize=100
mir.ip=127.0.0.1
mir.port=8120
mir.protocol=http