Digipass S3 is now DigipassONE. This section is currently being updated to reflect our new name.

Step 6. Install the Server and its Components

Prev Next

Run the nnl-install.sh script to install your configured Server node. nnl-install.sh Syntax details the parameters you can use with nnl-install.sh, while Results from nnl-install-sh covers the directories and files that are installed.

If you have a production installation, the required order to perform installation is as follows:

  1. Install the command line tools on a server.

  2. Install the Authentication Server and the API Server on each runtime node.

  3. Install the Admin Server on each admin node.

If you use remote databases, ensure that they are running in the same time zone as the servers running the Authentication Server, Admin Server, and API Server.

If you run into any problems, check Troubleshooting for common errors.

nnl-install.sh Syntax

./nnl-install.sh [-auth-server] [-admin-server] [-api-server] [-command-line-tools [‑no-imports]] [-db-schema-only] [-as-root [-no-imports]] [-no-imports] [-deploy <path>]

You can control which server components are installed using the first five parameters listed in the table below. You can enter one or more parameters for nnl-install.sh, the order doesn't matter. If you don't pass in any parameters, nnl-install.sh installs all components. Nok Nok only recommends doing this for evaluations.

Parameter

Description

If no parameters

Install all components.

admin-server

Installs the administrative server. Deploys nnladmin and nnlauthsvc.

auth-server

Installs the authentication (runtime) server. Deploys nnl.

command-line-tools

Creates and configures the database schema for the Operational database and then installs the command-line tools.

no-imports

Must be used with the command-line-tools parameter. Optional. Installs the command-line tools without importing configurations to the database. Command-line tools must be installed at least once without this parameter.

db-schema-only

Creates and configures the database schema for the Operational database for the runtime and administrative servers.

api-server

Installs the API Server. Deploys nnlgateway, facets, and nnlappsdk. In non-production mode, deploys gwtutorial.

as-root

Forces installation as the root user.

deploy <path>

Deploys and configures one or more Nok Nok web applications. Each Nok Nok web application is specified by a path. Multiple paths are separated by spaces. You can deploy the following Nok Nok web applications using the deploy parameter:

  • nnl - Authentication Server

  • nnlgateway - API Server

  • nnlappsdk - Web AppSDK

  • gwtutorial - Tutorial Web App

  • nnladmin - Admin Server

  • nnlauthsvc - Admin User Manager

  • facets - Facet ID file

The example below shows the required order to install the product.

# Switch to the node where you want the command-line tools installed
cd <NNL_HOME>/install/
./nnl-install.sh -command-line-tools
# Switch to the runtime node, use the same nnl-install.properties file
# Install the Auth Server first separately, then the API Server
./nnl-install.sh -auth-server
./nnl-install.sh -api-server
# Switch to the admin node, use the same nnl-install.properties file
./nnl-install.sh -admin-server

Results from nnl-install-sh

After the script finishes executing, you should see the following directories in <TOMCAT_HOME>, depending on the parameters you used for nnl-install.sh:

Parameter Used for nnl-install.sh

Directory Structure

Any of them

<TOMCAT_HOME>/bin/setenv.sh

<TOMCAT_HOME>/conf/nnl

<TOMCAT_HOME>/conf/nnl/log4j2-nnl.xml

<TOMCAT_HOME>/conf/nnl/log4j2-xinclude-hist-appender.xml

<TOMCAT_HOME>/conf/nnl/nnl-java-security.properties

auth-server

<TOMCAT_HOME>/webapps/nnl

<TOMCAT_HOME>/conf/nnl/conn-pool-config/nnl-conn-pool.sh

api-server

<TOMCAT_HOME>/webapps/nnlgateway

<TOMCAT_HOME>/webapps/nnlappsdk-9.3.0

<TOMCAT_HOME>/webapps/facets

<TOMCAT_HOME>/conf/Catalina/localhost/nnlgateway.xml

<TOMCAT_HOME>/conf/nnl/conn-pool-config/nnlgateway-conn-pool.sh

admin-server

<TOMCAT_HOME>/webapps/nnladmin

<TOMCAT_HOME>/webapps/nnlauthsvc

<TOMCAT_HOME>/conf/Catalina/localhost/nnladmin.xml

<TOMCAT_HOME>/conf/nnl/conn-pool-config/nnladmin-conn-pool.sh

<TOMCAT_HOME>/conf/nnl/conn-pool-config/nnlauthsvc-conn-pool.sh