Skip to Content
Last modified by teamwire001 on 2025/09/11 14:59
From version 4.2
edited by teamwire001
on 2025/09/11 14:59
Change comment: DOC-434
To version 1.4
edited by teamwire001
on 2023/11/07 11:37
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -4. Windows Install Options
1 +Windows-Install-Options
Content
... ... @@ -1,230 +1,132 @@
1 -{{id name="4-quietinstall"/}}
2 -
3 -= Quiet installation =
4 -
5 -{{tabs idsToLabels="install1=Desktop 4, install2=Until Desktop 3.4.3"/}}
6 -
7 -(% id="install1" %)
1 +(% class="box warningmessage" %)
8 8  (((
9 -Microsoft Windows Installer is an installation and configuration service provided with Windows. It allows to run processes with the Windows command {{code language="none"}}msiexec{{/code}} without any user interaction.
10 -
11 -The {{code language="none"}}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"]]
12 -
13 -
14 -To install the Teamwire app quietly, use the following command and parameters:
15 -
16 -{{code language="none"}}
17 -msiexec.exe /i <path_to_package> /qn
18 -{{/code}}
19 -
20 -Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
3 +These features are available on Teamwire for Windows only.
21 21  )))
22 22  
23 -(% id="install2" %)
24 -(((
6 +
25 25  You can install Teamwire in silent mode from a command line to avoid user interaction during the process.
26 26  
27 27  Therefore the command syntax is
28 28  
29 -{{code language="none"}}
11 +{{code language="plain"}}
30 30  start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
31 31  {{/code}}
32 32  
33 -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.
15 +## ##
34 34  
17 +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.
18 +
35 35  Example:
36 36  
37 -{{code language="none"}}
21 +{{code language="plain"}}
38 38  start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
39 39  {{/code}}
40 40  
41 -An app shortcut will be created automatically and can be found in the Teamwire software directory.
25 +## ##
42 42  
43 -The shortcut's target for the default installation is {{code language="none"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
44 -
45 -{{info}}
46 -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.
47 -{{/info}}
27 +(% class="box infomessage" %)
28 +(((
29 +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.
48 48  )))
49 49  
50 -(% style="border-color:var(--gili_blue_300)" %)
51 -----
32 +## ##
52 52  
34 +An app shortcut will be created automatically and can be found in the Teamwire software directory.
53 53  
54 -{{id name="4-installcontext"/}}
36 +The shortcut's target for the default installation is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
55 55  
56 -== Installation context ==
57 57  
58 -{{tabs idsToLabels="context1=Desktop 4, context2=Until Desktop 3.4.3"/}}
39 +{{id name="optional"/}}
59 59  
60 -(% id="context1" %)
61 -(((
62 -Microsoft Windows Installer is an installation and configuration service provided with Windows. It allows to run processes with the Windows command {{code language="none"}}msiexec{{/code}} without any user interaction.
41 += Optional parameters =
63 63  
64 -Windows Installer can install a package on a computer into two installation contexts: per-machine and per-user.
43 +The following parameters are optional and support additional settings to be enabled during the installation.
65 65  
66 -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"]]
45 +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.
67 67  
68 68  
69 -{{id name="4-context-user"/}}
70 -
71 -(% class="numbox" %)A(%%) (% class="numbox-title" %)Per user installation
72 -
73 -By default, the package is installed in the per-user installation context. The following command performs the per-user installation:
74 -
75 -{{code language="none"}}
76 -msiexec.exe /i <path_to_package>
77 -{{/code}}
78 -
79 -Teamwire will be installed to the following directory: ##%LOCALAPPDATA%\Programs\Teamwire##
80 -
81 -
82 -{{id name="4-context-machine"/}}
83 -
84 -(% class="numbox" %)B(%%) (% class="numbox-title" %)Per machine installation
85 -
86 -To install the package in the per-machine installation context, the ##ALLUSERS## parameter is required. The following command performs the per-machine installation:
87 -
88 -{{code language="none"}}
89 -msiexec.exe /i <path_to_package> ALLUSERS=1
90 -{{/code}}
91 -
92 -Teamwire will be installed to the following directory: ##C:\Program Files\Teamwire##
93 -
94 -
95 -{{id name="4-context-custom"/}}
96 -
97 -(% class="numbox" %)C(%%) (% class="numbox-title" %)Custom installation directory
98 -
99 -You can define a custom directory for the Teamwire app installation with the following parameters:
100 -
101 -{{code language="none"}}
102 -msiexec.exe /i <path_to_package> APPLICATIONFOLDER=<absolute_application_path>
103 -{{/code}}
104 -
105 -Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}
106 -)))
107 -
108 -(% id="context2" %)
109 -(((
110 110  {{id name="roamingdir"/}}
111 111  
112 -(% class="numbox" %)A(%%) (% class="numbox-title" %)Roaming user data directory
50 +== Roaming User Directory ==
113 113  
114 -{{code language="none"}}/APPDATA=TRUE{{/code}} ## ##
52 +{{code language="plain"}}/APPDATA=TRUE{{/code}} ## ##
115 115  
116 -This is an optional parameter.
54 +By default, the user's data is written to the ##%LOCALAPPDATA%## directory ( ##..\AppData\Local\## ).
117 117  
118 -By default, the user's data is written to the ##%LOCALAPPDATA%## directory (##..\AppData\Local\##).
56 +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.
119 119  
120 -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.
121 -
122 122  Example:
123 123  
124 -{{code language="none"}}
60 +{{code language="plain"}}
125 125  start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
126 126  {{/code}}
127 127  
64 +## ##
65 +
128 128  An app shortcut will be created automatically and can be found in the Teamwire software directory.
129 129  
130 -The shortcut's target incl. the roaming directory is {{code language="none"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app" --user-data-dir=%APPDATA%/Teamwire{{/code}}
68 +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}}
131 131  
132 132  
133 133  {{id name="customdir"/}}
134 134  
135 -(% class="numbox" %)B(%%) (% class="numbox-title" %)Custom user data directory
73 +== Custom User Directory ==
136 136  
137 -{{code language="none"}}/USERDATADIR=<path>{{/code}} ## ##
75 +{{code language="plain"}}/USERDATADIR=<path>{{/code}} ## ##
138 138  
139 -This is an optional parameter.
77 +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.**
140 140  
141 -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.**
79 +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.
142 142  
143 -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.
144 -
145 145  Example:
146 146  
147 -{{code language="none"}}
83 +{{code language="plain"}}
148 148  start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
149 149  {{/code}}
150 150  
87 +## ##
88 +
151 151  An app shortcut will be created automatically and can be found in the Teamwire software directory.
152 152  
153 -The shortcut's target incl. the customised directory is {{code language="none"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app" --user-data-dir="<userdata_directory>\Teamwire"{{/code}}
91 +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}}
154 154  
155 155  
156 -
157 157  {{id name="runonstartup"/}}
158 158  
159 -(% class="numbox" %)C(%%) (% class="numbox-title" %)Run on startup
96 +== Run on Startup ==
160 160  
161 -{{code language="none"}}/STARTUP=TRUE{{/code}} ## ##
98 +{{code language="plain"}}/STARTUP=TRUE{{/code}} ## ##
162 162  
163 -This is an optional parameter.
164 -
165 165  With this parameter you enable the feature to run Teamwire on Windows startup.
166 166  
167 167  Example:
168 168  
169 -{{code language="none"}}
104 +{{code language="plain"}}
170 170  start "" /WAIT Teamwire-setup_1.10.0.exe /S /STARTUP=TRUE /D=C:\Program Files (x86)\Teamwire\
171 171  {{/code}}
172 -)))
173 173  
174 -(% style="border-color:var(--gili_blue_300)" %)
175 -----
108 +## ##
176 176  
110 +{{id name="silentdeinstall"/}}
177 177  
178 -{{id name="4-quietdeinstall"/}}
112 += Silent Deinstallation =
179 179  
180 -= Quiet deinstallation =
181 -
182 -{{tabs idsToLabels="deinstall1=Desktop 4, deinstall2=Until Desktop 3.4.3"/}}
183 -
184 -(% id="deinstall1" %)
185 -(((
186 -Microsoft Windows Installer is an installation and configuration service provided with Windows. It allows to run processes with the Windows command {{code language="none"}}msiexec{{/code}} without any user interaction.
187 -
188 -The {{code language="none"}}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"]]
189 -
190 -
191 -To deinstall the Teamwire app quietly, use the following command and parameters:
192 -
193 -{{code language="none"}}
194 -msiexec.exe /x <path_to_package> /qn
195 -{{/code}}
196 -
197 -The MSI file path required for the deinstallation depends on your data management.
198 -
199 -
200 -**Example A:** {{code language="none"}}msiexec.exe /x "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
201 -The file which was also used during the installation has remained in its directory.
202 -
203 -
204 -**Example B:** {{code language="none"}}msiexec.exe /x "C:\Windows\Installer\34237a6a.msi" /qn{{/code}}
205 -You use the MSI file cached by the system. By default, it's stored under ##%SystemRoot%\Installer##.
206 -)))
207 -
208 -(% id="deinstall2" %)
209 -(((
210 210  You can deinstall Teamwire in silent mode from a command line to avoid user interaction during the process.
211 211  
212 212  Therefore the command syntax is
213 213  
214 -{{code language="none"}}
118 +{{code language="plain"}}
215 215  start "" /WAIT "<path>\uninstall.exe" /S
216 216  {{/code}}
217 217  
218 218  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.**
219 219  
220 -Example: {{code language="none"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
124 +Example: {{code language="plain"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
221 221  
222 -{{info}}
126 +
127 +(% class="box infomessage" %)
128 +(((
223 223  Please note, the user data is not being removed for all users but the user performing the local deinstallation.
224 -{{/info}}
225 225  )))
226 226  
227 -(% style="border-color:var(--gili_blue_300)" %)
228 -----
229 -
230 230  ## ##