4. Windows Install Options - Teamwire Knowledge Base

= Desktop 4.0.0 or newer =

Microsoft Windows Installer is an installation and configuration service provided with Windows. It allows to run processes with the Windows command {{code}}msiexec{{/code}}.

5

6

This command can be used, for example, to install Teamwire without any user interaction in [[quiet mode>>doc:||anchor="4-quietinstall"]]. Or to define the [[installation contexts>>doc:||anchor="4-installcontext"]].

== Silent installation ==

12

13

The {{code}}msiexec{{/code}} **display options** allow a quiet installation. All available parameters can be found here: [[Microsoft ~> msiexec ~> Display options>>url:https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec#display-options||rel="noopener noreferrer" target="_blank"]]

14

15

16

To install the Teamwire app quietly, use the following command and parameters:

17

18

19

msiexec.exe /i <path_to_package> /qn

20

21

22

Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}

== Silent deinstallation ==

28

29

The {{code}}msiexec{{/code}} **display options** allow a quiet deinstallation. All available parameters can be found here: [[Microsoft ~> msiexec ~> Display options>>url:https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec#display-options||rel="noopener noreferrer" target="_blank"]]

30

31

32

To deinstall the Teamwire app quietly, use the following command and parameters:

33

34

35

msiexec.exe /x <path_to_package> /qn

36

37

38

The MSI file path required for the deinstallation depends on your data management.

39

40

41

Example A: {{code language="shell"}}msiexec.exe /x "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}

42

The file which was also used during the installation has remained in its directory.

43

44

Example B: {{code language="shell"}}msiexec.exe /x "C:\Windows\Installer\34237a6a.msi" /qn{{/code}}

45

You use the MSI file cached by the system. By default, it's stored under ##%SystemRoot%\Installer##.

== Installation context ==

51

52

Windows Installer can install a package on a computer into two installation contexts: per-machine and per-user.

53

54

A per-machine installation of the package is required to enable **all users** of the computer to access and use the application. Because a per-machine installation makes changes to the system that affect all users, administrative permissions are required. Further information available here: [[Microsoft ~> Windows Installer ~> Installation context>>https://learn.microsoft.com/en-us/windows/win32/msi/installation-context||rel="noopener noreferrer" target="_blank"]]

=== Per user ===

By default, the package is installed in the per-user installation context. The following command performs the per-user installation:

62

63

64

msiexec.exe /i <path_to_package>

65

66

67

Teamwire will be installed to the following directory: ##%LOCALAPPDATA%\Programs\Teamwire##

=== Per machine ===

To install the package in the per-machine installation context, the ##ALLUSERS## parameter is required. The following command performs the per-machine installation:

75

76

77

msiexec.exe /i <path_to_package> ALLUSERS=1

78

79

80

Teamwire will be installed to the following directory: ##C:\Program Files\Teamwire##

=== Custom installation directory ===

86

87

You can define a custom directory for the Teamwire app installation with the following parameters:

88

89

90

msiexec.exe /i <path_to_package> APPLICATIONFOLDER=<absolute_application_path>

91

92

93

Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}

----

= Until Desktop 3.4.2 =

102

103

104

You can install Teamwire in silent mode from a command line to avoid user interaction during the process.

105

106

Therefore the command syntax is

107

108

109

start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>

## ##

Please enter the path to the Teamwire setup file and use the option ##/D## to define a directory in which Teamwire is going to install its further contents.

Example:

start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\

## ##

(% class="box infomessage" %)

125

(((

126

Please note, ##/D## must be the **last parameter used** in the command line and **must not contain any quotation marks** even if the path contains spaces.

)))

## ##

An app shortcut will be created automatically and can be found in the Teamwire software directory.

132

133

The shortcut's target for the default installation is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}

== Optional parameters ==

139

140

The following parameters are optional and support additional settings to be enabled during the installation.

141

142

Furthermore, please note that the ##/D## option must be the last parameter used in the command line and must not contain any quotation marks even if the path contains spaces.

=== Roaming User Directory ===

148

149

{{code language="plain"}}/APPDATA=TRUE{{/code}} ## ##

150

151

By default, the user's data is written to the ##%LOCALAPPDATA%## directory ( ##..\AppData\Local\## ).

152

153

In some corporate and virtual environments, a folder's content is deleted when the session is closed. In order to write into ##%APPDATA%## directory ( ##..\AppData\Roaming\## ) , please add the ##/APPDATA=TRUE## argument to your command.

Example:

start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\

## ##

An app shortcut will be created automatically and can be found in the Teamwire software directory.

164

165

The shortcut's target incl. the roaming directory is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app" --user-data-dir=%APPDATA%/Teamwire{{/code}}

=== Custom User Directory ===

171

172

{{code language="plain"}}/USERDATADIR=<path>{{/code}} ## ##

173

174

In case you need to store your user data to a different location due to your network environment or retention policies for local data, you are able to define a custom path (e.g. mapped home directory for your users) with the parameter ##/USERDATADIR##. **You will have to put the path in quotation marks.**

175

176

The customised directories will not be created until the first run and registration. Please note, that despite the custom path of user data the original directories ( ##%LOCALAPPDATA%\Teamwire\User Data\Default\## ) will still be created but do not contain any data.

Example:

start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\

## ##

An app shortcut will be created automatically and can be found in the Teamwire software directory.

187

188

The shortcut's target incl. the customised directory is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app" --user-data-dir="<userdata_directory>\Teamwire"{{/code}}

=== Run on Startup ===

194

195

{{code language="plain"}}/STARTUP=TRUE{{/code}} ## ##

196

197

With this parameter you enable the feature to run Teamwire on Windows startup.