wireshark/packaging/wix
João Valverde c66fc43e5b GUI: Ship authors as a Qt resource file 2023-01-20 13:35:03 +00:00
..
CMakeLists.txt Windows: Use SpeexDSP binary package 2022-12-16 11:11:28 +00:00
COPYING.rtf
ComponentGroups.wxi GUI: Ship authors as a Qt resource file 2023-01-20 13:35:03 +00:00
DirectoryStructure.wxi Windows: Switch from HTML Help to plain HTML. 2021-06-04 08:57:32 +00:00
Features.wxi Wix: Remove stale reference to dftest 2023-01-19 09:15:13 +00:00
InputPaths.wxi Add SparkplugB dissector 2021-05-14 12:11:03 +01:00
Plugins.wxi Windows: fix WiX installer 2020-10-04 16:40:15 +02:00
Prerequisites.wxi Windows: Update target version info 2018-03-02 10:53:29 +00:00
README.adoc CMake: Update WiX and PortableApps target names. 2022-06-08 18:12:46 +00:00
StringOverrides.wxl WiX: Add a warning and increase compression. 2016-09-11 04:35:20 +00:00
UserInterface.wxi WiX: Set the "Programs and Features" icon. 2016-07-29 20:19:22 +00:00
Wireshark.wxs WiX: Update the README. 2021-01-14 10:36:48 +00:00
WiresharkOptionsDlg.wxs HTTPS In Still More Places, update more URLs. 2019-07-27 22:56:35 +00:00
WiresharkWixUI.wxs WiX: Options dialog updates. 2018-05-03 04:08:40 +00:00
banner.bmp Remove executable bit, from not executable files. 2017-02-26 17:49:34 +00:00
banner.svg WiX banner and dialog images. 2016-05-12 12:34:56 +00:00
dialog.bmp Remove executable bit, from not executable files. 2017-02-26 17:49:34 +00:00
dialog.svg WiX banner and dialog images. 2016-05-12 12:34:56 +00:00
windeployqt-to-wix.ps1 NSIS: Don't package .pdb files. 2020-01-06 19:50:50 +00:00

README.adoc

= WiX (.msi) Installer For Wireshark

This is an experimental feature to provide Wireshark with an .msi installer as requested in https://gitlab.com/wireshark/wireshark/-/issues/8814[issue 8814].
It might one day replace the NSIS installer, but needs to be a little more complete before doing so.

== Differences/Notes Compared To The NSIS Installer

. You need the https://wixtoolset.org/[WiX toolset] to build the .msi installer.
Version 3.10 or later is recommended.

. The User's Guide, SNMP, Radius, Diameter, and Qt translations files are harvested to
be included in the installer.  Any custom/additional files just need to be written to the
appropriate build output directory and the installer will pick them up.  NSIS required
modifying a file (custom_mibs.txt, etc) for inclusion

. Plugin DLLs are not automatically harvested. To include your DLL, modify Plugins.wxi.

. To build the WiX installer run:
----
> msbuild /m /p:Configuration=RelWithDebInfo wireshark_wix_prep.vcxproj
> msbuild /m /p:Configuration=RelWithDebInfo wireshark_wix.vcxproj
----

== Known Issues

. The .msi installer does not include and install Npcap or USBPcap like the NSIS installer does.
These currently come as NSIS-generated .exe installers.
We might be able to bundle them as https://wixtoolset.org/documentation/manual/v3/xsd/wix/exepackage.html[ExePackage elements].

// This appears to be fixed in the MERGE_MODULE_DIR code in CMakeLists.txt?
// . Needs more flexible handling of VC CRT Merge module (need build script to provide appropriate macros).
// Something like (or modifying existing) FindMSVC_REDIST.cmake.
// Currently only VS2013 / CRT120 and VS 2015 / CRT140 are supported.

. Transitioning, upgrading, downgrading, and reinstalling is more tricky.
The NSIS-based installer handles previously-installed versions by running any existing uninstaller prior to installation, which empties the installation directory and removes registry entries.
These are subsequently filled back in by the installer.
The Windows Installer architecture keeps track of installed items in a https://docs.microsoft.com/en-us/windows/win32/msi/installer-database[database] and uses the https://docs.microsoft.com/en-us/windows/win32/msi/upgradecode[UpgradeCode property] to identify installed products and the https://wixtoolset.org/documentation/manual/v3/xsd/wix/majorupgrade.html[MajorUpgrade property] to control upgrade behavior.
As a result,
  * We can't easily upgrade from an NSIS-based installation to a .msi installation, and vice versa.
  * We have to be careful about setting things like UpgradeCode, MajorUpgrade, and REINSTALLMODE in our WiX configuration.

. The lax behavior of the NSIS-based installer lets you install more than one copy of Wireshark if you specify different installation directories.
(The most recently installed version "wins" as far as registry entries and file associations go).
The .msi installer doesn't allow this.

Patches welcome to address any of the issues above or improvements you think can be made.