ftos-installer
CLI app to assist the installation process of FintechOS framework
- Installation
- Usage
- What it does
- Collecting installation information
- Know your
ftosin
- Examples
- Default template
- Template variables
Installation
Install the package globally. The global install provides the ftosin
CLI command, which is the only way to use this package.
npm install ftos-installer -g
Usage
Check ftosin
is available as a command:
ftosin -h
Usage: ftosin [options] Generate install.bat for FintechOS Framework. Provide your values or accept suggested values. Options: -V, --version output the version number -d, --defaults [file] Filename or full path to file with default values (default: "ftos-defaults.json") --no-pause skip creating pause command in install.bat --no-verify do not check paths are valid --no-database skip installing instance database --no-studio skip installing instance Studio --no-portal skip installing instance Portal -s, --save [file] save answers to default answers file (default: "ftos-defaults.json") -t, --template <file> install .bat template file with .handlebars extension (default: "C:\\Users\\ion.gireada\\Documents\\VSCodeProjects\\ftos-installer\\install.handlebars") -o, --output <file> full path to generated install file, or filename (default: "install.bat") -h, --help output usage information
Creating install.bat
ftosin --no-verify
ftosin
will prompt you for installation details, and creates the install.bat
in current folder.
What it does
ftosin collects information from the user, and then it generates an install.bat
file. The user will run the install.bat
file as Administrator to install the FintechOS Framework.
Collecting installation information
When you run ftosin
, you are asked to provide installation information such as path to installation kit, instance name, path to Studio and Portal applications, etc.
Most information items have a default value. To accept the default value, simply press Enter
. ftosin provides these default values using previous information.
Following the installation information questions, you will review the generated content, and asked to confirm it. If you confirm it, the content is saved in the install.bat
.
At the command prompt, type:
mkdir C:\Users\default\Documents\FintechOS-Installationscd C:\Users\default\Documents\FintechOS-Installationsftosin --no-verify --output ./v20-install/install-SheldonG20.bat
ftosin
Know your ftosin --version # or ftosin -V
Get current version
ftosin -h # or ftosin --help
Get usage information
Examples
Example 1
ftosin --no-verify
Ask installation details to create install.bat
in the local folder. Load default detail values from ftos0defaults.json
. The --no-verify
switch skips checking whether path/to/ftos/GOLD exists.
REMREM ================ FintechOS Installation ===================REMREM NOTE: To run this file, you MUST have Administrative rightsREMREM S U M M A R YREMREM Install kit path: C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLDREM Instance Name: AlexG20REMREM Instance Studio path: C:\AlexG20\StudioREM Studio IIS Application Name: AlexG20StudioREMREM Instance Portal path: C:\AlexG20\PortalREM Portal IIS Application Name: AlexG20PortalREMREM .bat file generated on: 2020-01-29 13:04:01REM Initialize instance database: trueREM Install instance Studio: trueREM Install instance Portal: trueREM IIS Parent Website: Default Web SiteREM Connection name: training0001REMREM ===========================================================REM IF NOT EXIST "C:\AlexG20" GOTO MKINSTANCERMDIR /S /Q C:\AlexG20:MKINSTANCEMKDIR C:\AlexG20MKDIR C:\AlexG20\EBS_DIRMKDIR C:\AlexG20\EBS_DIR CD "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\SQL"start BasicDbUpgrader.exe -i -s training0001 -d AlexG20 && BasicDbUpgrader.exe -w -s training0001 -d AlexG20 && BasicDbUpgrader.exe -g -s training0001 -d AlexG20pause powershell.exe -File "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\DesignerWebApp\DesignerWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "C:\AlexG20\Studio" -p_IisWebSite "Default Web Site" -p_IisApp AlexG20Studio -p_IisAppPool AlexG20Studio -p_DbConnServer "training0001" -p_DbConnSqlAuthUser host -p_DbConnSqlAuthPass host -p_DbConnDb AlexG20 C:\AlexG20\EBS_DIRpause powershell.exe -File "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\PortalWebApp\PortalWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "C:\AlexG20\Portal" -p_IisWebSite "Default Web Site" -p_IisApp AlexG20Portal -p_IisAppPool AlexG20Portal -p_DbConnServer "training0001" -p_DbConnSqlAuthUser host -p_DbConnSqlAuthPass host -p_DbConnDb AlexG20 -p_UploadEBSDir C:\AlexG20\EBS_DIR pause
Example 2
ftosin --no-verify -o another-install.bat
Same as above, except it creates the another-install.bat
instead of install.bat
.
The another-install.bat
has the same content as in Example 1.
Example 3
ftosin --no-verify -d another-defaults.json
Same as first example, except it uses default values in another-defaults.json
In another-defaults.json
:
Example 4
ftosin --no-verify -d another-defaults.json -s new-defaults.json
Same as above and save installation values as defaults in new-defaults.json
Example 5
ftosin --no-verify --no-database
Same as first example, except the install.bat
will not have commands related to initializing and updating the database.
In install.bat
:
REMREM ================ FintechOS Installation ===================REMREM NOTE: To run this file, you MUST have Administrative rightsREMREM S U M M A R YREMREM Install kit path: C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLDREM Instance Name: AlexG20REMREM Instance Studio path: C:\AlexG20\StudioREM Studio IIS Application Name: AlexG20StudioREMREM Instance Portal path: C:\AlexG20\PortalREM Portal IIS Application Name: AlexG20PortalREMREM .bat file generated on: 2020-01-29 13:11:05REM Initialize instance database: trueREM Install instance Studio: trueREM Install instance Portal: trueREM IIS Parent Website: Default Web SiteREM Connection name: training0001REMREM ===========================================================REM IF NOT EXIST "C:\AlexG20" GOTO MKINSTANCERMDIR /S /Q C:\AlexG20:MKINSTANCEMKDIR C:\AlexG20MKDIR C:\AlexG20\EBS_DIRMKDIR C:\AlexG20\EBS_DIR CD "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\SQL"start BasicDbUpgrader.exe -i -s training0001 -d AlexG20 && BasicDbUpgrader.exe -w -s training0001 -d AlexG20 && BasicDbUpgrader.exe -g -s training0001 -d AlexG20pause powershell.exe -File "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\DesignerWebApp\DesignerWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "C:\AlexG20\Studio" -p_IisWebSite "Default Web Site" -p_IisApp AlexG20Studio -p_IisAppPool AlexG20Studio -p_DbConnServer "training0001" -p_DbConnSqlAuthUser host -p_DbConnSqlAuthPass host -p_DbConnDb AlexG20 C:\AlexG20\EBS_DIRpause powershell.exe -File "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\PortalWebApp\PortalWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "C:\AlexG20\Portal" -p_IisWebSite "Default Web Site" -p_IisApp AlexG20Portal -p_IisAppPool AlexG20Portal -p_DbConnServer "training0001" -p_DbConnSqlAuthUser host -p_DbConnSqlAuthPass host -p_DbConnDb AlexG20 -p_UploadEBSDir C:\AlexG20\EBS_DIR pause
Example 6
ftosin --no-verify --no-studio
Same as first example, except the install.bat
will not have commands related to creating the Studio application.
In install.bat
:
REMREM ================ FintechOS Installation ===================REMREM NOTE: To run this file, you MUST have Administrative rightsREMREM S U M M A R YREMREM Install kit path: C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLDREM Instance Name: AlexG20REMREM Instance Studio path: C:\AlexG20\StudioREM Studio IIS Application Name: AlexG20StudioREMREM Instance Portal path: C:\AlexG20\PortalREM Portal IIS Application Name: AlexG20PortalREMREM .bat file generated on: 2020-01-29 13:13:05REM Initialize instance database: trueREM Install instance Studio: falseREM Install instance Portal: trueREM IIS Parent Website: Default Web SiteREM Connection name: training0001REMREM ===========================================================REM IF NOT EXIST "C:\AlexG20" GOTO MKINSTANCERMDIR /S /Q C:\AlexG20:MKINSTANCEMKDIR C:\AlexG20MKDIR C:\AlexG20\EBS_DIR CD "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\SQL"start BasicDbUpgrader.exe -i -s training0001 -d AlexG20 && BasicDbUpgrader.exe -w -s training0001 -d AlexG20 && BasicDbUpgrader.exe -g -s training0001 -d AlexG20pause powershell.exe -File "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\PortalWebApp\PortalWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "C:\AlexG20\Portal" -p_IisWebSite "Default Web Site" -p_IisApp AlexG20Portal -p_IisAppPool AlexG20Portal -p_DbConnServer "training0001" -p_DbConnSqlAuthUser host -p_DbConnSqlAuthPass host -p_DbConnDb AlexG20 -p_UploadEBSDir C:\AlexG20\EBS_DIR pause
Example 7
ftosin --no-verify --no-portal
Same as first example, except the install.bat
will not have commands related to creating the Portal application.
REMREM ================ FintechOS Installation ===================REMREM NOTE: To run this file, you MUST have Administrative rightsREMREM S U M M A R YREMREM Install kit path: C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLDREM Instance Name: AlexG20REMREM Instance Studio path: C:\AlexG20\StudioREM Studio IIS Application Name: AlexG20StudioREMREM Instance Portal path: C:\AlexG20\PortalREM Portal IIS Application Name: AlexG20PortalREMREM .bat file generated on: 2020-01-29 13:14:08REM Initialize instance database: trueREM Install instance Studio: trueREM Install instance Portal: falseREM IIS Parent Website: Default Web SiteREM Connection name: training0001REMREM ===========================================================REM IF NOT EXIST "C:\AlexG20" GOTO MKINSTANCERMDIR /S /Q C:\AlexG20:MKINSTANCEMKDIR C:\AlexG20MKDIR C:\AlexG20\EBS_DIR CD "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\SQL"start BasicDbUpgrader.exe -i -s training0001 -d AlexG20 && BasicDbUpgrader.exe -w -s training0001 -d AlexG20 && BasicDbUpgrader.exe -g -s training0001 -d AlexG20pause powershell.exe -File "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\DesignerWebApp\DesignerWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "C:\AlexG20\Studio" -p_IisWebSite "Default Web Site" -p_IisApp AlexG20Studio -p_IisAppPool AlexG20Studio -p_DbConnServer "training0001" -p_DbConnSqlAuthUser host -p_DbConnSqlAuthPass host -p_DbConnDb AlexG20 C:\AlexG20\EBS_DIRpause
Example 8
ftosin --no-verify --no-portal --no-database
Same as first example, except the install.bat
will not have commands related to neither initializing and updating the database, nor creating the Portal application.
In install.bat
:
REMREM ================ FintechOS Installation ===================REMREM NOTE: To run this file, you MUST have Administrative rightsREMREM S U M M A R YREMREM Install kit path: C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLDREM Instance Name: AlexG20REMREM Instance Studio path: C:\AlexG20\StudioREM Studio IIS Application Name: AlexG20StudioREMREM Instance Portal path: C:\AlexG20\PortalREM Portal IIS Application Name: AlexG20PortalREMREM .bat file generated on: 2020-01-29 13:15:24REM Initialize instance database: falseREM Install instance Studio: trueREM Install instance Portal: falseREM IIS Parent Website: Default Web SiteREM Connection name: training0001REMREM ===========================================================REM IF NOT EXIST "C:\AlexG20" GOTO MKINSTANCERMDIR /S /Q C:\AlexG20:MKINSTANCEMKDIR C:\AlexG20MKDIR C:\AlexG20\EBS_DIR powershell.exe -File "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\DesignerWebApp\DesignerWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "C:\AlexG20\Studio" -p_IisWebSite "Default Web Site" -p_IisApp AlexG20Studio -p_IisAppPool AlexG20Studio -p_DbConnServer "training0001" -p_DbConnSqlAuthUser host -p_DbConnSqlAuthPass host -p_DbConnDb AlexG20 C:\AlexG20\EBS_DIRpause
Example 9
ftosin --no-verify --no-studio --no-database
Same as first example, except the install.bat
will not have commands related to neither initializing and updating the database, nor creating the Studio application.
In install.bat
:
REMREM ================ FintechOS Installation ===================REMREM NOTE: To run this file, you MUST have Administrative rightsREMREM S U M M A R YREMREM Install kit path: C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLDREM Instance Name: AlexG20REMREM Instance Studio path: C:\AlexG20\StudioREM Studio IIS Application Name: AlexG20StudioREMREM Instance Portal path: C:\AlexG20\PortalREM Portal IIS Application Name: AlexG20PortalREMREM .bat file generated on: 2020-01-29 13:17:15REM Initialize instance database: falseREM Install instance Studio: falseREM Install instance Portal: trueREM IIS Parent Website: Default Web SiteREM Connection name: training0001REMREM ===========================================================REM IF NOT EXIST "C:\AlexG20" GOTO MKINSTANCERMDIR /S /Q C:\AlexG20:MKINSTANCEMKDIR C:\AlexG20MKDIR C:\AlexG20\EBS_DIR powershell.exe -File "C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLD\PortalWebApp\PortalWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "C:\AlexG20\Portal" -p_IisWebSite "Default Web Site" -p_IisApp AlexG20Portal -p_IisAppPool AlexG20Portal -p_DbConnServer "training0001" -p_DbConnSqlAuthUser host -p_DbConnSqlAuthPass host -p_DbConnDb AlexG20 -p_UploadEBSDir C:\AlexG20\EBS_DIR pause
Example 10
ftosin --no-verify --no-studio --no-database --no-portal
Same as first example, except the install.bat
will not have commands related to neither initializing and updating the database, creating the Studio application, nor creating the Portal application.
In install.bat
:
REMREM ================ FintechOS Installation ===================REMREM NOTE: To run this file, you MUST have Administrative rightsREMREM S U M M A R YREMREM Install kit path: C:\Users\ion.gireada\Downloads\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0\FTOS-CORE-RLS-v20.1.0.0-b197-GOLDREM Instance Name: AlexG20REMREM Instance Studio path: C:\AlexG20\StudioREM Studio IIS Application Name: AlexG20StudioREMREM Instance Portal path: C:\AlexG20\PortalREM Portal IIS Application Name: AlexG20PortalREMREM .bat file generated on: 2020-01-29 13:18:49REM Initialize instance database: falseREM Install instance Studio: falseREM Install instance Portal: falseREM IIS Parent Website: Default Web SiteREM Connection name: training0001REMREM ===========================================================REM IF NOT EXIST "C:\AlexG20" GOTO MKINSTANCERMDIR /S /Q C:\AlexG20:MKINSTANCEMKDIR C:\AlexG20
Default template
REMREM ================ FintechOS Installation ===================REMREM NOTE: To run this file, you MUST have Administrative rightsREMREM S U M M A R YREMREM Install kit path: {{kitPath}}REM Instance Name: {{instanceName}}REMREM Instance Studio path: {{studioPath}}REM Studio IIS Application Name: {{studioIisApp}}REMREM Instance Portal path: {{portalPath}}REM Portal IIS Application Name: {{portalIisApp}}REMREM .bat file generated on: {{dateTime}}REM Initialize instance database: {{database}}REM Install instance Studio: {{studio}}REM Install instance Portal: {{portal}}REM IIS Parent Website: {{iisWebSite}}REM Connection name: {{connectionName}}REMREM ===========================================================REM IF NOT EXIST "{{instancePath}}" GOTO MKINSTANCERMDIR /S /Q {{instancePath}}:MKINSTANCEMKDIR {{instancePath}}{{#if studio}}MKDIR {{instancePath}}\EBS_DIR{{/if}}{{#if portal}}MKDIR {{instancePath}}\EBS_DIR{{/if}} {{#if database}}CD "{{kitPath}}\SQL"start BasicDbUpgrader.exe -i -s {{connectionName}} -d {{dbName}} && BasicDbUpgrader.exe -w -s {{connectionName}} -d {{dbName}} && BasicDbUpgrader.exe -g -s {{connectionName}} -d {{dbName}}pause{{/if}} {{#if studio}}powershell.exe -File "{{kitPath}}\DesignerWebApp\DesignerWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "{{studioPath}}" -p_IisWebSite "{{iisWebSite}}" -p_IisApp {{studioIisApp}} -p_IisAppPool {{instanceName}}Studio -p_DbConnServer "{{connectionName}}" -p_DbConnSqlAuthUser {{dbSqlAuthUser}} -p_DbConnSqlAuthPass {{dbSqlAuthPass}} -p_DbConnDb {{dbName}} {{instancePath}}\EBS_DIRpause{{/if}} {{#if portal}}powershell.exe -File "{{kitPath}}\PortalWebApp\PortalWebAppInstaller.ps1" -p_MainCommand Install -p_InstallDir "{{portalPath}}" -p_IisWebSite "{{iisWebSite}}" -p_IisApp {{portalIisApp}} -p_IisAppPool {{instanceName}}Portal -p_DbConnServer "{{connectionName}}" -p_DbConnSqlAuthUser {{dbSqlAuthUser}} -p_DbConnSqlAuthPass {{dbSqlAuthPass}} -p_DbConnDb {{dbName}} -p_UploadEBSDir {{instancePath}}\EBS_DIRpause{{/if}}
Template variables
Name | Type | Description | Default |
---|---|---|---|
connectionName |
string | Connection name | "training0001" |
database |
boolean | Switch indicates to create .bat section to initialize and upgrade database |
true |
dbName |
string | Name of database to use | options.dbName |
dbSqlAuthPass |
string | Password of username for Microsoft SQL Server Manager | host |
dbSqlAuthUser |
string | Username for Microsoft SQL Server Manager | host |
dateTime |
DateTime | Date and time of install.bat generation |
application-provided value as yyyy-mm-dd hh:mm:ss |
iisWebSite |
string | Name of website on IIS. Studio and Portal apps will be hosted here. | "Default Web Site" |
instanceName |
string | Name of FintechOS installation -- used as base for several values | options.instanceName |
instancePath |
string | Instance applications root folder | C:{{instanceName}} |
kitPath |
string | Path to installation kit - folder ending in -GOLD | options.kitPath |
portal |
boolean | Switch to indicate portal application commands will be generated | true |
portalPath |
string | Path where portal application will be stored | options.portalPath |
studio |
boolean | Switch to indicate studio application commands will be generated | true |
studioPath |
string | Path where studio application will be stored | options.studioPath |