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

Summary

Details

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