Skip to Content

Wiki source code of 4. Windows Install Options

Last modified by teamwire001 on 2024/12/12 14:44
Hide last authors
teamwire001 2.1 1 = Desktop 4.0.0 or newer =
teamwire001 1.1 2
3
teamwire001 2.1 4 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"]].
7
8
9 {{id name="4-quietinstall"/}}
10
teamwire001 3.1 11 == Quiet installation ==
teamwire001 2.1 12
teamwire003 2.2 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"]]
teamwire001 2.1 14
15
16 To install the Teamwire app quietly, use the following command and parameters:
17
18 {{code language="shell"}}
19 msiexec.exe /i <path_to_package> /qn
20 {{/code}}
21
22 Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
23
24
25 {{id name="4-quietdeinstall"/}}
26
teamwire001 3.1 27 == Quiet deinstallation ==
teamwire001 2.1 28
teamwire003 2.2 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"]]
teamwire001 2.1 30
31
32 To deinstall the Teamwire app quietly, use the following command and parameters:
33
34 {{code language="shell"}}
35 msiexec.exe /x <path_to_package> /qn
36 {{/code}}
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##.
46
47
48 {{id name="4-installcontext"/}}
49
50 == Installation context ==
51
52 Windows Installer can install a package on a computer into two installation contexts: per-machine and per-user.
53
teamwire003 2.2 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"]]
teamwire001 2.1 55
56
57 {{id name="4-context-user"/}}
58
59 === Per user ===
60
61 By default, the package is installed in the per-user installation context. The following command performs the per-user installation:
62
63 {{code language="shell"}}
64 msiexec.exe /i <path_to_package>
65 {{/code}}
66
67 Teamwire will be installed to the following directory: ##%LOCALAPPDATA%\Programs\Teamwire##
68
69
70 {{id name="4-context-machine"/}}
71
72 === Per machine ===
73
74 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 {{code language="shell"}}
77 msiexec.exe /i <path_to_package> ALLUSERS=1
78 {{/code}}
79
80 Teamwire will be installed to the following directory: ##C:\Program Files\Teamwire##
81
82
83 {{id name="4-context-custom"/}}
84
85 === Custom installation directory ===
86
87 You can define a custom directory for the Teamwire app installation with the following parameters:
88
89 {{code language="shell"}}
90 msiexec.exe /i <path_to_package> APPLICATIONFOLDER=<absolute_application_path>
91 {{/code}}
92
93 Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}
94
95
96
97 ----
98
99 {{id name="desktop-previous"/}}
100
teamwire001 3.1 101 = Desktop 3.4.3 and previous versions =
teamwire001 2.1 102
103
teamwire001 3.1 104 {{id name="quietinstall"/}}
105
106 == Quiet installation ==
107
teamwire001 1.1 108 You can install Teamwire in silent mode from a command line to avoid user interaction during the process.
109
110 Therefore the command syntax is
111
112 {{code language="plain"}}
113 start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
114 {{/code}}
115
116 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.
117
118 Example:
119
120 {{code language="plain"}}
121 start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
122 {{/code}}
123
teamwire001 3.1 124 An app shortcut will be created automatically and can be found in the Teamwire software directory.
teamwire001 1.1 125
teamwire001 3.1 126 The shortcut's target for the default installation is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
127
teamwire001 1.1 128 (% class="box infomessage" %)
129 (((
teamwire001 3.1 130 Please note, 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.
teamwire001 1.1 131 )))
132
133
134 {{id name="roamingdir"/}}
135
teamwire001 3.1 136 === Roaming user directory ===
teamwire001 1.1 137
138 {{code language="plain"}}/APPDATA=TRUE{{/code}} ## ##
139
teamwire001 3.1 140 This is an optional parameter.
141
teamwire001 1.1 142 By default, the user's data is written to the ##%LOCALAPPDATA%## directory ( ##..\AppData\Local\## ).
143
144 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.
145
146 Example:
147
148 {{code language="plain"}}
149 start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
150 {{/code}}
151
152 An app shortcut will be created automatically and can be found in the Teamwire software directory.
153
154 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}}
155
156
157 {{id name="customdir"/}}
158
teamwire001 3.1 159 === Custom user directory ===
teamwire001 1.1 160
161 {{code language="plain"}}/USERDATADIR=<path>{{/code}} ## ##
162
teamwire001 3.1 163 This is an optional parameter.
164
teamwire001 1.1 165 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.**
166
167 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.
168
169 Example:
170
171 {{code language="plain"}}
172 start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
173 {{/code}}
174
175 An app shortcut will be created automatically and can be found in the Teamwire software directory.
176
teamwire003 1.2 177 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}}
teamwire001 1.1 178
179
180 {{id name="runonstartup"/}}
181
teamwire001 3.1 182 === Run on startup ===
teamwire001 1.1 183
184 {{code language="plain"}}/STARTUP=TRUE{{/code}} ## ##
185
teamwire001 3.1 186 This is an optional parameter.
187
teamwire001 1.1 188 With this parameter you enable the feature to run Teamwire on Windows startup.
189
190 Example:
191
192 {{code language="plain"}}
193 start "" /WAIT Teamwire-setup_1.10.0.exe /S /STARTUP=TRUE /D=C:\Program Files (x86)\Teamwire\
194 {{/code}}
195
196 ## ##
197
198 {{id name="silentdeinstall"/}}
teamwire003 1.2 199
teamwire001 3.1 200 == Silent deinstallation ==
teamwire001 1.1 201
202 You can deinstall Teamwire in silent mode from a command line to avoid user interaction during the process.
203
204 Therefore the command syntax is
205
206 {{code language="plain"}}
207 start "" /WAIT "<path>\uninstall.exe" /S
208 {{/code}}
209
210 Enter the path to the uninstalling file, which is located in the Teamwire root directory. **You will have to put the path in quotation marks.**
211
212 Example: {{code language="plain"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
213
214
215 (% class="box infomessage" %)
216 (((
217 Please note, the user data is not being removed for all users but the user performing the local deinstallation.
218 )))
219
220 ## ##