Merge pull request #429 from setlog/feature-msi-settings

Feature msi settings

CHANGES.md

@@ -1,5 +1,9 @@
 # Release-Changelog
 
+## v1.8.2 (2023-12-21)
+### Features
+* MSI property `ADDROAMINGARGUMENT` can be provided with value `true` to have installed shortcuts provided with the `--roaming` argument.
+
 ## v1.8.1 (2023-12-21)
 ### Fixes
 * MSI Build will no longer deny installation into network drive.

build/launcher.wxs.template

@@ -41,9 +41,15 @@
     <!-- Link the UI for install directory selection -->
     <UI>
       <UIRef Id="WixUI_InstallDir"/>
+      <!-- <Dialog Id="TrivrostSettingsDlg" Title="Settings" Width="640" Height="200">
+        <Control Id="CheckBoxAddRoamingArgument" Property="ADDROAMINGARGUMENT" Type="CheckBox" X="20" Y="20" Width="600" Height="30" Default="no" CheckBoxValue="true" Text="Create shortcuts with the -roaming argument. This causes persistent files to be stored in %APPDATA% instead of %LOCALAPPDATA%. \n Useful for some Citrix setups. If you do not know what this means, leave this unchecked." />
+      </Dialog>
+      -->
       <Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="InstallDirDlg" Order="2">1</Publish>
+      <!--<Publish Dialog="TrivrostSettingsDlg" Control="Next" Event="NewDialog" Value="InstallDirDlg" Order="2">1</Publish>-->
       <Publish Dialog="InstallDirDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg" Order="2">1</Publish>
     </UI>
+
     <!-- UI Options - Add this to allow user to select the install directory -->
     <!-- Define the property to tell WIX to use the folder given in WIXUI_INSTALLDIR -->
     <Property Id="WIXUI_INSTALLDIR" Value="APPLICATIONROOTDIRECTORY"/>
@@ -76,8 +82,16 @@
               <Shortcut Id="desktop" Directory="DesktopFolder" Name="{{.BrandingName}}" WorkingDirectory='APPLICATIONROOTDIRECTORY'
                         Target="[APPLICATIONROOTDIRECTORY]{{.BinaryName}}" Icon="MainExecutable.exe"/>
               <RegistryValue Root='HKCU' Key='Software\{{.VendorName}}\{{.ProductName}}' Type='string' Name="Desktop" Value='' KeyPath='yes'/>
+              <Condition><![CDATA[ADDROAMINGARGUMENT<>"true"]]></Condition>
+            </Component>
+            <Component Id="MainExecutableDesktopShortcutRoaming" Guid="*">
+              <Shortcut Id="startmenuRoaming" Directory="ProgramMenuDir" Name="{{.BrandingName}}" WorkingDirectory='APPLICATIONROOTDIRECTORY'
+                        Target="[APPLICATIONROOTDIRECTORY]{{.BinaryName}}" Arguments="--roaming" Icon="MainExecutable.exe"/>
+              <Shortcut Id="desktopRoaming" Directory="DesktopFolder" Name="{{.BrandingName}}" WorkingDirectory='APPLICATIONROOTDIRECTORY'
+                        Target="[APPLICATIONROOTDIRECTORY]{{.BinaryName}}" Arguments="--roaming" Icon="MainExecutable.exe"/>
+              <RegistryValue Root='HKCU' Key='Software\{{.VendorName}}\{{.ProductName}}' Type='string' Name="Desktop" Value='' KeyPath='yes'/>
+              <Condition><![CDATA[ADDROAMINGARGUMENT="true"]]></Condition>
             </Component>
-
           </Directory>
         </Directory>
       </Directory>
@@ -97,6 +111,7 @@
     <Feature Id="DefaultFeature" Title="Application" Level="1">
       <ComponentRef Id="MainExecutable"/>
       <ComponentRef Id="MainExecutableDesktopShortcut"/>
+      <ComponentRef Id="MainExecutableDesktopShortcutRoaming"/>
       <ComponentRef Id='ProgramMenuDir'/>
       <ComponentGroupRef Id="{{.ComponentGroupId}}"/>
     </Feature>

docs/msi_properties.md

@@ -0,0 +1,5 @@
+## MSI Properties
+
+The Windows .msi can be invoked with `misexec`, where additional properties can be provided:
+
+* `ADDROAMINGARGUMENT=true`: If set, shortcuts will be installed such that they run trivrost with the `--roaming` argument, which is of interest to some Citrix environments.