From 164a041f3bd603bc7de3717ad3b5153a1ab51579 Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Tue, 1 Dec 2020 15:58:09 +0100 Subject: [PATCH 01/12] SDA-2650 Generate pdf with install instructions --- installer/win/install_instructions_win.md | 23 +++++++++++++++++++++++ scripts/jenkins-win64.bat | 6 ++++++ 2 files changed, 29 insertions(+) create mode 100644 installer/win/install_instructions_win.md diff --git a/installer/win/install_instructions_win.md b/installer/win/install_instructions_win.md new file mode 100644 index 00000000..59f52839 --- /dev/null +++ b/installer/win/install_instructions_win.md @@ -0,0 +1,23 @@ +Windows Installer Instructions +============================== + +Install parameters +------------------ +ALLUSERS", "1" +ALWAYS_ON_TOP", "DISABLED" +AUTO_LAUNCH_PATH", "" +AUTO_START", "ENABLED" +BRING_TO_FRONT", "DISABLED" +CUSTOM_TITLE_BAR", "ENABLED" +DEV_TOOLS_ENABLED", "true" +FULL_SCREEN", "true" +LOCATION", "true" +MEDIA", "true" +MIDI_SYSEX", "true" +MINIMIZE_ON_CLOSE", "ENABLED" +NOTIFICATIONS", "true" +OPEN_EXTERNAL", "true" +POD_URL", "https://my.symphony.com" +POINTER_LOCK", "true" +MSIINSTALLPERUSER", "1" +PROGRAMSFOLDER", System.Environment.ExpandEnvironmentVariables(@"%PROGRAMFILES%") diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index c16b1551..fc52baf6 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -106,3 +106,9 @@ if NOT EXIST c:\electron-installer\signing.bat ( call c:\electron-installer\signing.bat copy "WixSharpInstaller\Symphony.msi" "%targetsDir%\Experimental-%archiveName%.msi" + +where /q markdown-pdf +if NOT ERRORLEVEL 0 ( + npm install -g markdown-pdf +) +markdown-pdf install_instructions_win.md -o "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" From 39c1d83f90428d4c2b63f24f2877e5e1e0817019 Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Wed, 2 Dec 2020 08:20:11 +0100 Subject: [PATCH 02/12] SDA-2650 Explicit path for where.exe --- scripts/jenkins-win64.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index fc52baf6..fc7648ea 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -107,7 +107,7 @@ if NOT EXIST c:\electron-installer\signing.bat ( call c:\electron-installer\signing.bat copy "WixSharpInstaller\Symphony.msi" "%targetsDir%\Experimental-%archiveName%.msi" -where /q markdown-pdf +%SystemRoot%\System32\where.exe /q markdown-pdf if NOT ERRORLEVEL 0 ( npm install -g markdown-pdf ) From 85f14ca3bb3b923fcb3e40ed94fd1148dbd5ce80 Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Wed, 2 Dec 2020 08:43:20 +0100 Subject: [PATCH 03/12] SDA-2650 Debugging use of where.exe --- scripts/jenkins-win64.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index fc7648ea..35cb4491 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -107,7 +107,7 @@ if NOT EXIST c:\electron-installer\signing.bat ( call c:\electron-installer\signing.bat copy "WixSharpInstaller\Symphony.msi" "%targetsDir%\Experimental-%archiveName%.msi" -%SystemRoot%\System32\where.exe /q markdown-pdf +%SystemRoot%\System32\where.exe markdown-pdf if NOT ERRORLEVEL 0 ( npm install -g markdown-pdf ) From dcf24a51dcde82fa722ac107b42cc043b49de7c9 Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Wed, 2 Dec 2020 09:35:27 +0100 Subject: [PATCH 04/12] SDA-2650 Fixed detection/install of markdown-pdf --- scripts/jenkins-win64.bat | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index 35cb4491..3e61588d 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -107,8 +107,8 @@ if NOT EXIST c:\electron-installer\signing.bat ( call c:\electron-installer\signing.bat copy "WixSharpInstaller\Symphony.msi" "%targetsDir%\Experimental-%archiveName%.msi" -%SystemRoot%\System32\where.exe markdown-pdf -if NOT ERRORLEVEL 0 ( - npm install -g markdown-pdf +%SystemRoot%\System32\where.exe /q markdown-pdf +if ERRORLEVEL 1 ( + call npm install -g markdown-pdf ) markdown-pdf install_instructions_win.md -o "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" From 32d2abeaf616d3f98746b6f503b70f6ac0abe029 Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Wed, 2 Dec 2020 12:40:11 +0100 Subject: [PATCH 05/12] SDA-2650 Debugging use of markdown-pdf call --- scripts/jenkins-win64.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index 3e61588d..d82b90c1 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -107,7 +107,7 @@ if NOT EXIST c:\electron-installer\signing.bat ( call c:\electron-installer\signing.bat copy "WixSharpInstaller\Symphony.msi" "%targetsDir%\Experimental-%archiveName%.msi" -%SystemRoot%\System32\where.exe /q markdown-pdf +%SystemRoot%\System32\where.exe markdown-pdf if ERRORLEVEL 1 ( call npm install -g markdown-pdf ) From 90d8a174a8939fd54a57d1d678e65f0489d804c2 Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Wed, 2 Dec 2020 13:32:49 +0100 Subject: [PATCH 06/12] SDA-2650 Fixed call to markdown-pdf --- scripts/jenkins-win64.bat | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index d82b90c1..85778f0f 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -107,8 +107,8 @@ if NOT EXIST c:\electron-installer\signing.bat ( call c:\electron-installer\signing.bat copy "WixSharpInstaller\Symphony.msi" "%targetsDir%\Experimental-%archiveName%.msi" -%SystemRoot%\System32\where.exe markdown-pdf +%SystemRoot%\System32\where.exe /q markdown-pdf if ERRORLEVEL 1 ( call npm install -g markdown-pdf ) -markdown-pdf install_instructions_win.md -o "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" +%appdata%\npm\markdown-pdf install_instructions_win.md -o "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" From d76f1250f94f0dd244f02a9860f32dd5d0e67bc3 Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Wed, 2 Dec 2020 13:58:48 +0100 Subject: [PATCH 07/12] SDA-2650 Fixed path param for markdown-pdf --- scripts/jenkins-win64.bat | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index 85778f0f..07cb2baf 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -111,4 +111,5 @@ copy "WixSharpInstaller\Symphony.msi" "%targetsDir%\Experimental-%archiveName%.m if ERRORLEVEL 1 ( call npm install -g markdown-pdf ) -%appdata%\npm\markdown-pdf install_instructions_win.md -o "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" +%appdata%\npm\markdown-pdf install_instructions_win.md + From fdb487fb17c352a2f3ec886abb8ccc91306fa19f Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Wed, 2 Dec 2020 15:17:01 +0100 Subject: [PATCH 08/12] SDA-2650 Copy generated pdf --- scripts/jenkins-win64.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index 07cb2baf..015beae7 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -112,4 +112,4 @@ if ERRORLEVEL 1 ( call npm install -g markdown-pdf ) %appdata%\npm\markdown-pdf install_instructions_win.md - +copy install_instructions_win.pdf %targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf From 5d5f7ab4d6025c171079e3ed2081ef709a656c6f Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Wed, 2 Dec 2020 15:44:28 +0100 Subject: [PATCH 09/12] SDA-2650 Fixing targets path --- scripts/jenkins-win64.bat | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index 015beae7..bd34161e 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -112,4 +112,5 @@ if ERRORLEVEL 1 ( call npm install -g markdown-pdf ) %appdata%\npm\markdown-pdf install_instructions_win.md -copy install_instructions_win.pdf %targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf +echo "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" +copy install_instructions_win.pdf "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" From 2ccf384e974910422de263232e6f35292a2300ca Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Wed, 2 Dec 2020 16:37:32 +0100 Subject: [PATCH 10/12] SDA-2650 Added debug prints --- scripts/jenkins-win64.bat | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index bd34161e..9106a4ff 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -107,10 +107,12 @@ if NOT EXIST c:\electron-installer\signing.bat ( call c:\electron-installer\signing.bat copy "WixSharpInstaller\Symphony.msi" "%targetsDir%\Experimental-%archiveName%.msi" +echo Setup for install instructions %SystemRoot%\System32\where.exe /q markdown-pdf if ERRORLEVEL 1 ( call npm install -g markdown-pdf ) +echo Generating install instructions %appdata%\npm\markdown-pdf install_instructions_win.md -echo "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" +echo Install instructions generated: %targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf copy install_instructions_win.pdf "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" From 7d84eade9b2263729f47080204cda60e84243566 Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Thu, 3 Dec 2020 08:30:52 +0100 Subject: [PATCH 11/12] SDA-2650 Fixed call to markdown-pdf --- scripts/jenkins-win64.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index 9106a4ff..3d141069 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -113,6 +113,6 @@ if ERRORLEVEL 1 ( call npm install -g markdown-pdf ) echo Generating install instructions -%appdata%\npm\markdown-pdf install_instructions_win.md +call %appdata%\npm\markdown-pdf install_instructions_win.md echo Install instructions generated: %targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf copy install_instructions_win.pdf "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf" From 09a9956b984bf54cee600d32a3e91219d06d7516 Mon Sep 17 00:00:00 2001 From: Mattias Gustavsson Date: Thu, 3 Dec 2020 13:21:00 +0100 Subject: [PATCH 12/12] SDA-2650 Added documentation for installation parameters --- installer/win/install_instructions_win.md | 384 +++++++++++++++++++++- scripts/jenkins-win64.bat | 1 - 2 files changed, 366 insertions(+), 19 deletions(-) diff --git a/installer/win/install_instructions_win.md b/installer/win/install_instructions_win.md index 59f52839..abc9d544 100644 --- a/installer/win/install_instructions_win.md +++ b/installer/win/install_instructions_win.md @@ -3,21 +3,369 @@ Windows Installer Instructions Install parameters ------------------ -ALLUSERS", "1" -ALWAYS_ON_TOP", "DISABLED" -AUTO_LAUNCH_PATH", "" -AUTO_START", "ENABLED" -BRING_TO_FRONT", "DISABLED" -CUSTOM_TITLE_BAR", "ENABLED" -DEV_TOOLS_ENABLED", "true" -FULL_SCREEN", "true" -LOCATION", "true" -MEDIA", "true" -MIDI_SYSEX", "true" -MINIMIZE_ON_CLOSE", "ENABLED" -NOTIFICATIONS", "true" -OPEN_EXTERNAL", "true" -POD_URL", "https://my.symphony.com" -POINTER_LOCK", "true" -MSIINSTALLPERUSER", "1" -PROGRAMSFOLDER", System.Environment.ExpandEnvironmentVariables(@"%PROGRAMFILES%") + + + + +------------------------------------------------------------------- +### ALLUSERS + +Expected values: + +* "1" + Install *For all users* (default) +* "" + Install *Only for me* + +#### Example, install *For all users* + + msiexec /i Symphony.msi /q ALLUSERS="1" + +or + + msiexec /i Symphony.msi + + +#### Example, install *Only for me* + + msiexec /i Symphony.msi /q ALLUSERS="" + + +------------------------------------------------------------------- +### ALWAYS_ON_TOP + +Expected values: + +* "DISABLED" + Always-on-top disabled (default) +* "ENABLED" + Always-on-top enabled + +#### Example, install with always-on-top disabled + + msiexec /i Symphony.msi /q ALWAYS_ON_TOP="DISABLED" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with always-on-top enabled + + msiexec /i Symphony.msi /q ALWAYS_ON_TOP="ENABLED" + + + +------------------------------------------------------------------- +### AUTO_LAUNCH_PATH + +Expected values: + +* Full file path for custom auto launch path + +#### Example + + msiexec /i Symphony.msi /q AUTO_LAUNCH_PATH="C:\Program Files\internet explorer\iexplore.exe" + + + +------------------------------------------------------------------- +### AUTO_START + +Expected values: + +* "ENABLED" + Auto start enabled (default) +* "DISABLED" + Auto start disabled + +#### Example, install with auto start enabled + + msiexec /i Symphony.msi /q AUTO_START="ENABLED" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with auto start disabled + + msiexec /i Symphony.msi /q AUTO_START="DISABLED" + + + +------------------------------------------------------------------- +### BRING_TO_FRONT + +Expected values: + +* "DISABLED" + Bring-to-front disabled (default) +* "ENABLED" + Bring-to-front enabled + +#### Example, install with bring-to-front disabled + + msiexec /i Symphony.msi /q BRING_TO_FRONT="DISABLED" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with bring-to-front enabled + + msiexec /i Symphony.msi /q BRING_TO_FRONT="ENABLED" + + + +------------------------------------------------------------------- +### CUSTOM_TITLE_BAR + +Expected values: + +* "ENABLED" + Custom title bar enabled (default) +* "DISABLED" + Custom title bar disabled + +#### Example, install with custom title bar enabled + + msiexec /i Symphony.msi /q CUSTOM_TITLE_BAR="ENABLED" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with custom title bar disabled + + msiexec /i Symphony.msi /q CUSTOM_TITLE_BAR="DISABLED" + + + +------------------------------------------------------------------- +### DEV_TOOLS_ENABLED + +Expected values: + +* "true" + Dev tools enabled (default) +* "false" + Dev tools disabled + +#### Example, install with dev tools enabled + + msiexec /i Symphony.msi /q DEV_TOOLS_ENABLED="true" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with dev tools disabled + + msiexec /i Symphony.msi /q DEV_TOOLS_ENABLED="false" + + + +------------------------------------------------------------------- +### FULL_SCREEN + +Expected values: + +* "true" + Full screen enabled (default) +* "false" + Full screen disabled + +#### Example, install with full screen enabled + + msiexec /i Symphony.msi /q FULL_SCREEN="true" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with full screen disabled + + msiexec /i Symphony.msi /q FULL_SCREEN="false" + + + +------------------------------------------------------------------- +### LOCATION + +Expected values: + +* "true" + Location enabled (default) +* "false" + Location disabled + +#### Example, install with location enabled + + msiexec /i Symphony.msi /q LOCATION="true" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with location disabled + + msiexec /i Symphony.msi /q LOCATION="false" + + + +------------------------------------------------------------------- +### MEDIA + +Expected values: + +* "true" + Media enabled (default) +* "false" + Media disabled + +#### Example, install with media enabled + + msiexec /i Symphony.msi /q MEDIA="true" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with media disabled + + msiexec /i Symphony.msi /q MEDIA="false" + + + +------------------------------------------------------------------- +### MIDI_SYSEX + +Expected values: + +* "true" + Midi SysEx enabled (default) +* "false" + Midi SysEx disabled + +#### Example, install with Midi SysEx enabled + + msiexec /i Symphony.msi /q MIDI_SYSEX="true" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with Midi SysEx disabled + + msiexec /i Symphony.msi /q MIDI_SYSEX="false" + + + +------------------------------------------------------------------- +### MINIMIZE_ON_CLOSE + +Expected values: + +* "ENABLED" + Minimize-on-close enabled (default) +* "DISABLED" + Minimize-on-close disabled + +#### Example, install with minimize-on-close enabled + + msiexec /i Symphony.msi /q MINIMIZE_ON_CLOSE="ENABLED" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with minimize-on-close disabled + + msiexec /i Symphony.msi /q MINIMIZE_ON_CLOSE="DISABLED" + + + +------------------------------------------------------------------- +### NOTIFICATIONS + +Expected values: + +* "true" + Notifications enabled (default) +* "false" + Notifications disabled + +#### Example, install with notifications enabled + + msiexec /i Symphony.msi /q NOTIFICATIONS="true" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with notifications disabled + + msiexec /i Symphony.msi /q NOTIFICATIONS="false" + + + +------------------------------------------------------------------- +### OPEN_EXTERNAL + +Expected values: + +* "true" + Open external enabled (default) +* "false" + Open external disabled + +#### Example, install with open external enabled + + msiexec /i Symphony.msi /q OPEN_EXTERNAL="true" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with open external disabled + + msiexec /i Symphony.msi /q OPEN_EXTERNAL="false" + + + +------------------------------------------------------------------- +### POD_URL + +Expected values: + +* Full url to POD + (default is "https://my.symphony.com" ) + +#### Example + + msiexec /i Symphony.msi /q POD_URL="https://my.symphony.com" + + + +------------------------------------------------------------------- +### POINTER_LOCK + +Expected values: + +* "true" + Pointer lock enabled (default) +* "false" + Pointer lock disabled + +#### Example, install with pointer lock enabled + + msiexec /i Symphony.msi /q POINTER_LOCK="true" + +or + + msiexec /i Symphony.msi /q + +#### Example, install with pointer lock disabled + + msiexec /i Symphony.msi /q POINTER_LOCK="false" + + diff --git a/scripts/jenkins-win64.bat b/scripts/jenkins-win64.bat index 3d141069..76b26e7b 100644 --- a/scripts/jenkins-win64.bat +++ b/scripts/jenkins-win64.bat @@ -114,5 +114,4 @@ if ERRORLEVEL 1 ( ) echo Generating install instructions call %appdata%\npm\markdown-pdf install_instructions_win.md -echo Install instructions generated: %targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf copy install_instructions_win.pdf "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf"