mirror of
https://github.com/finos/SymphonyElectron.git
synced 2025-02-25 18:55:29 -06:00
SDA-2650 Added documentation for installation parameters
This commit is contained in:
Mattias Gustavsson
@@ -3,21 +3,369 @@ Windows Installer Instructions
|
|||||||
|
|
||||||
Install parameters
|
Install parameters
|
||||||
------------------
|
------------------
|
||||||
ALLUSERS", "1"
|
|
||||||
ALWAYS_ON_TOP", "DISABLED"
|
|
||||||
AUTO_LAUNCH_PATH", ""
|
|
||||||
AUTO_START", "ENABLED"
|
|
||||||
BRING_TO_FRONT", "DISABLED"
|
-------------------------------------------------------------------
|
||||||
CUSTOM_TITLE_BAR", "ENABLED"
|
### ALLUSERS
|
||||||
DEV_TOOLS_ENABLED", "true"
|
|
||||||
FULL_SCREEN", "true"
|
Expected values:
|
||||||
LOCATION", "true"
|
|
||||||
MEDIA", "true"
|
* "1"
|
||||||
MIDI_SYSEX", "true"
|
Install *For all users* (default)
|
||||||
MINIMIZE_ON_CLOSE", "ENABLED"
|
* ""
|
||||||
NOTIFICATIONS", "true"
|
Install *Only for me*
|
||||||
OPEN_EXTERNAL", "true"
|
|
||||||
POD_URL", "https://my.symphony.com"
|
#### Example, install *For all users*
|
||||||
POINTER_LOCK", "true"
|
|
||||||
MSIINSTALLPERUSER", "1"
|
msiexec /i Symphony.msi /q ALLUSERS="1"
|
||||||
PROGRAMSFOLDER", System.Environment.ExpandEnvironmentVariables(@"%PROGRAMFILES%")
|
|
||||||
|
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"
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -114,5 +114,4 @@ if ERRORLEVEL 1 (
|
|||||||
)
|
)
|
||||||
echo Generating install instructions
|
echo Generating install instructions
|
||||||
call %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"
|
copy install_instructions_win.pdf "%targetsDir%\Install-Instructions-Experimental-%archiveName%.pdf"
|
||||||
|
|||||||
Reference in New Issue
Block a user