Control Panel Web Server Configuration

Introduction

This manual describes the configuration of the server-side components of the application GBS Control Panel. The Control Panel provides a visual interface where the user controls the parameter values of the GBDS and compares the values between different versions.

The configuration procedure should be done only after the installation step. For more information, consult the GBS Apps Installation Manual.

Configuration

The configuration steps are:

1. Configure Tomcat;

2. Configure the Certificates;

3. Generate the encrypted password;

4. Finalize the configurations in the config.properties file.

All steps are described below. An example of the file config.properties can be seen in the section Configuration File Example.

All lines must be present in the configuration file. Commenting out or deleting lines may cause unexpected behavior. For additional information, contact the Griaule Support Team.

Tomcat Configuration

Edit Tomcat's configuration file to configure the certificates and the port the application will use.

vi /var/lib/tomcats/control-panel/conf/server.xml

To change the port, search for connector port=. This is the port for backend operations.

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 -->, then adjust the following parameters:

port="58194"
keystoreFile="/home/griaule/keystore"
keystorePass="password"
keyAlias="1"
clientAuth="true"
truststoreFile="/home/griaule/keystore"
truststorePass="password"

The parameter port must be the desired network port for the application.

Change the path of the keystoreFile and the truststoreFile to the appropriate values. Do the same for the keystorePass and the truststorePass.

The parameter clientAuth="true" will require server authentication to the client and client authentication to the server. This means the client will need to import the certificate into the browser to be able to access the application.

When clientAuth is set to true, the system administrator must provide the file certificate.pfx to end users.

Database Password Encryption

In the file config.properties, the parameter jdbc.password is an encrypted password. To generate the encrypted password, follow these steps:

1. Go to the following directory:

   cd /var/lib/tomcats/control-panel/webapps/gbs-control-panel-server/WEB-INF/lib

2. Run the command:

   java -cp gbs-common-db-<version>.jar com.griaule.commons.util.EncryptUtil <desiredPassword>

3. The encrypted password will appear after the message: "Encrypted password is:"

Save the encrypted password. It will be used in later configurations.

Application Configuration File

To configure the file, open it with:

vi /var/lib/tomcats/control-panel/conf/config.properties

The most important changes in this file are the parameters jdbc.url, jdbc.username, jdbc.password and gbds.url. Configure them according to your environment.

The complete configuration file is shown in the section Configuration File Example

Remember to replace the encrypted password generated in the section Database Password Encryption in this file.

Control Panel Settings

The last step is to configure the IP and port of the application that the end user will access. It must be the same IP and port configured in the section Tomcat Configuration.

control-panel.ip=<ip>
control-panel.port=<port>
control-panel.protocol=<protocol>

Make sure the configuration parameters control-panel.ip, control-panel.port and control-panel.protocol are correctly specified in the file config.properties. In many cases, the IP will be the same for several applications. However, each application will have a different and unique port.

Finishing the Configurations

After completing all configuration steps, return to the GBS Apps Installation Manual - Configuration Section.

Configuration File Example

This section shows an example of the file config.properties.

# GBS Control Panel Server

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://192.168.0.189:3306/controlpanel?useSSL=false
jdbc.username=root
jdbc.password=CDrt8vbewA2YAubPNOLZkw==
jdbc.dialect=org.hibernate.dialect.MySQLDialect
jdbc.showSql=true

locale=en_us

gbds.url=http://192.168.0.189:8085
gbds.user=gbds.authenticate
gbds.key=Griaule.123
gbds.logLevel=INFO
gbds.timeout=300

fingerprint.useSDK=false

gbds.controlPanelUser=control_panel_server
sync.logLevel=INFO
same.user.simultaneous.login=false
notification.delay=5

server.standalone.port=8185

control-panel.ip=127.0.0.1
control-panel.port=8121
control-panel.protocol=http