Windows introduction

Introduction

For creating windows packages of the Trust1Connector for a specific environment you need a couple of assets and configuration files. Some of these are hosted on the Cloud and others are included in the packaging repository. This page will describe the difference between whats hosted in the cloud and whats hosted in the git repository.

Cloud assets

In our cloud storage where we host the released assets to create packages you will have 3 'folders'; mac, win and unix. These folders are used to differentiate between the 3 operating systems supported.

To create a Windows package all the necessary configs and assets are hosted in the win folder. In this folder you will find all the assets and configuration files for each version we've released. For example release 3.2.0 can be found in the folder v3.2.0

For each release you will find all necessary assets hosted on the cloud to create a package. These are;

  • t1c-api

  • t1c-sandbox-service

  • t1c-proxy-init

T1C-API

The t1c-api folder holds a zipfile with the complete Trust1Connector webserver. this includes a prepackaged & optimised JRE that is used to run the webserver.

The JRE included is Java 11LTS.

While packaging we create a copy of the java.exe file to a custom named executable. This is done because this will then show up with a proper name in the task manager and is easy to determine which process to kill while uninstalling

T1C-sandbox-service

The sandbox service is responsible for the Card communication. this executable needs to be signed with your own code signing certificate.

In this folder you can find a signed and non signed version of the sandbox-service. The signed version is signed with the Trust1Team code signing certificate.

While packaging we create a copy of the t1c-sandbox-service.exe file to a custom named executable. This is done because this will then show up with a proper name in the task manager and is easy to determine which process to kill while uninstalling

t1c-proxy-init

The t1c-proxy init holds a jar file which is executed at installation and runtime to detect wether the current network has a proxy available. When it detects a proxy it will update the configuration of the installation so that the installation will work in the shared environment.

Local assets

When changing name be aware this could break the installation or running of the Trust1Connector, adjust the places where this is used

In the packaging repository there are 2 different types of folders. You have the configuration folders which holds the configuration files per version and per environment and also the files needed to create the MSI and EXE packages.

The configuration files can be found in the configurations folder while the packager scripts for windows are saved in the windows folder.

Almost all of the configuration can be updated freely. The only exception to this are the application.conf file , the t1c_ks.p12 file and the transform.xslt file

For the windows API installer you can find the following assets;

  • 3.2.0 (version)

    • package.sh

    • package.bat

    • package-proxy.bat

    • dev (environment)

      • win (OS)

        • api

          • application.conf

          • Common.wxl

          • t1c_ks.p12

          • t1c.conf

          • assets

            • app.ico

            • banner.bmp

            • dialog.bmp

            • license.rtf

            • transform.xslt

          • scripts

            • t1c-api-launcher.vbs

            • t1c-api-sh-env-init.vbs

            • t1c-api.bat

            • t1c-kill-proc.vbs

            • t1c-sandbox-service.bat

        • proxy

          • application.conf

          • t1c_ks.p12

          • t1c.conf

          • scripts

            • nssm.exe

            • t1c-kill-proc.bat

            • t1c-proxy-launcher.vbs

            • t1c-proxy-uninstall.bat

            • t1c-proxy.bat

          • resources

            • logo.ico

            • t1c-info-after.txt

            • t1c-info-before.txt

            • t1c-license.txt

API assets

In this folder you can find all images and text assets to be located in the installer. The only file that must be untouched is the transform.xslt file, as this is used to update the wix package installation folders.

The logo should be of format 32x32 px and an valid ico file. We use png to icon maker.

The dialog.bmp is the background image of the installer. This is of size 493x312. Beware that not everything is visible. See example image below

The banner.bmp is the banner image of the installer. This is of size 493x58. Beware that not everything is visible. See example image below

You also have the Common.wxl file in the api folder this is a file that is used to place all text found in the installer. Update this accordingly.

API scripts

When creating the package you need to provide some parameter such as the application installation folder name and the application name etc. These need to be updated in the scripts files.

  • update java CMD variable to the proper java executable name

  • update sandbox executable to the proper name

  • update the installation folders to the proper folder name

  • in the Kill proc vbs update the correct names to be killed.

  • Update the domain name.

  • update the default proxy and API port in the sh-env-init file

Proxy assets/resources

For the proxy its a similar story as the API assets, you update the logo and the text files as you desire.

Proxy scripts

For the proxy scripts its similar, the difference is we use NSSM as a service manager. You will find in the proxy-launcher script statements where the service is created and started.

Update all the values depending on how you want to name everything

  • update java CMD variable to the proper java executable name

  • update the installation folders to the proper folder name

  • in the Kill proc vbs update the correct names to be killed.

  • Update the domain name.

  • update the service name

  • update the correct service to be stopped and removed in the uninstall script

Registry

The Trust1Connector relies on a registry key to be able to run on login/startup of the system. This registry key is located in Computer\HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Run

Key type: REG_SZ Key name: Trust1Connector API Key value: C:\Users\{{USERNAME}}\AppData\Local\Trust1Connector\t1c-api-sh-env-init.vbs

Make sure you replace {{USERNAME}} with the actual username of that user

Trust1Connector installation location

All the files of the Trust1Connector are located in %localappdata%\Trust1Connector

Last updated