3DS Server Admin Installation Manual

System requirements

Operating system

The 3DS Server Admin is recommended to be run on a Linux/Unix based operating system. E.g.

  • a GNU/Linux distribution (Example: CentOS)
  • a BSD derivative (Example: OpenBSD)
  • Mac OS X
  • Solaris

It's possible to run the 3DS Server Admin on Windows. However, you will have to write your own scripts to control (i.e . start/stop) the 3DS Server Admin. Alternatively you can install Bash and additional tools (rm, dirname, tail, less) on Windows (e.g. via Cygwin) to run the 3dssadminuictl script shipped with the 3DS Server.

Prerequisites

Software Requirements

To run the 3DS Server Admin application the following software installations are needed:

  • Java Development Kit (JDK) 1.8
  • Bash shell (to run the scripts)
  • Unix utilities used in the scripts: cat, curl, grep, less, sed, tail, tr

Installation guide

The 3DS Server Admin application is shipped together with the 3DS Server. Unzip the 3DS Server package (nca-3dss-package-<version>.zip) to a directory of your choice.

This will create the following directory structure rooted at $THREEDS_HOME:

Directory structure
-------------------
 
$THREEDS_HOME/                                                  <-- The unzipped directory contained in the nca-3dss-package zip file (nca-3dss-package-<version>).
  |
  +-- docs/                                                     <-- 3DS Server documentation
  |     |     |
  |     +-- ...
  |     |     |
  +-- 3ds-server/
  |     +-- bin/
  |     |     |
  |     |     +-- 3dsctl.sh                                     <-- Script to start/stop 3DS Server nodes.
  |     |     |
  |     |     +-- 3dstool.sh                                     <-- Script to generate encrypted content from plain-text input
  |     |
  |     +-- conf/                                               <-- Sample (default) configurations used by the 3dsctl script and the 3DS Server application.
  |     |     |
  |     |     +-- application.properties                        <-- Sample configuration settings
  |     |     |
  |     |     +-- ehcache.xml                                   <-- Sample session Ehcache configuration (without replication)
  |     |     |
  |     |     +-- 3dss-configuration.xml                        <-- Template 3DS Server 3-D Secure entities configuration
  |     |
  |     |
  |     +-- lib/
  |     |     |
  |     |     +-- nca-3ds-server.jar                            <-- The 3DS Server jar file.
  |     |     |
  |     |     +-- nca-3ds-web-sdk.js                            <-- The Netcetera 3DS Web SDK JavaScript that contains 3DS Method and Challenge Request helpers
  |     |     |
  |     |     +-- json-schema/                                  <-- JSON Schema files to help generate initial POJO classes for 3DS Server APIs
  |     |
  |     +-- node-<node-ID>/                                     <-- Extract directory created by starting an 3DS Server node via the 3dsctl script.
  |     |     |
  |     |     +-- logs/
  |     |     |
  |     |     +-- out/                                          <-- Directory where the Server startup logs are written to.
  |     |     |     |
  |     |           +-- catalina.out
  |     |     |
  |     |     +-- pid/                                          <-- Directory where the 3dsctl script stores PIDs of running 3DS Server nodes.
  |     |     |     |
  |     |     |     +-- node.pid
  |     |
  |     +-- xsd/                                                <-- XML schemas used by the 3DS Server for your reference.
  |           |
  |           +-- ...
  +-- 3dss-admin-ui/
  |     |
  |     +-- bin/
  |     |     |
  |     |     +-- 3dssadminuictl.sh                             <-- Script to start/stop 3DS Server Admin UI.
  |     |
  |     +-- lib/
  |     |     |
  |     |     +-- nca-3dss-admin-ui.jar                         <-- The 3DS Server Admin UI jar file.
 
-------------------

Configuration of the 3DS Server Admin

3DS Server Admin configuration properties can be set via $THREEDS_HOME/3ds-admin-ui/conf/application.properties. For details on the available configuration properties refer to the 3DS Server Admin Configuration Properties documentation.

Startup the 3DS Server Admin

You can start the 3DS Server Admin using the 3dssadminuictl script:

$ $THREEDS_HOME/3dss-admin-ui/bin/3dssadminuictl.sh start

Optionally, java parameters can be passed.

Similarly you can stop the 3DS Server using the following command:

$ $THREEDS_HOME/3dss-admin-ui/bin/3dssadminuictl.sh -c $THREEDS_CONFIG_HOME stop

Testing the installation

To check whether the 3DS Server Admin application is up and running, navigate to http(s)://<host>:<port>. If everything went fine, you should see the 3DS Server Admin. Otherwise, check the log files under $THREEDS_HOME/3dss-admin-ui/logs for errors.