Skip to Content
Last modified by teamwire001 on 2024/12/12 14:44
From version 3.1
edited by teamwire001
on 2024/12/12 14:44
Change comment: DOC-390 + heading hierarchy fixes
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,110 +1,9 @@
1 -= Desktop 4.0.0 or newer =
1 +(% class="box warningmessage" %)
2 +(((
3 +These features are available on Teamwire for Windows only.
4 +)))
2 2  
3 3  
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 -
11 -== Quiet 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 -{{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 -
27 -== Quiet 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 -{{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 -
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"]]
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 -
101 -= Desktop 3.4.3 and previous versions =
102 -
103 -
104 -{{id name="quietinstall"/}}
105 -
106 -== Quiet installation ==
107 -
108 108  You can install Teamwire in silent mode from a command line to avoid user interaction during the process.
109 109  
110 110  Therefore the command syntax is
... ... @@ -113,6 +113,8 @@
113 113  start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
114 114  {{/code}}
115 115  
15 +## ##
16 +
116 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 117  
118 118  Example:
... ... @@ -121,24 +121,35 @@
121 121  start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
122 122  {{/code}}
123 123  
124 -An app shortcut will be created automatically and can be found in the Teamwire software directory.
25 +## ##
125 125  
126 -The shortcut's target for the default installation is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
127 -
128 128  (% class="box infomessage" %)
129 129  (((
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.
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.
131 131  )))
132 132  
32 +## ##
133 133  
34 +An app shortcut will be created automatically and can be found in the Teamwire software directory.
35 +
36 +The shortcut's target for the default installation is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
37 +
38 +
39 +{{id name="optional"/}}
40 +
41 += Optional parameters =
42 +
43 +The following parameters are optional and support additional settings to be enabled during the installation.
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 +
47 +
134 134  {{id name="roamingdir"/}}
135 135  
136 -=== Roaming user directory ===
50 +== Roaming User Directory ==
137 137  
138 138  {{code language="plain"}}/APPDATA=TRUE{{/code}} ## ##
139 139  
140 -This is an optional parameter.
141 -
142 142  By default, the user's data is written to the ##%LOCALAPPDATA%## directory ( ##..\AppData\Local\## ).
143 143  
144 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.
... ... @@ -149,6 +149,8 @@
149 149  start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
150 150  {{/code}}
151 151  
64 +## ##
65 +
152 152  An app shortcut will be created automatically and can be found in the Teamwire software directory.
153 153  
154 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}}
... ... @@ -156,12 +156,10 @@
156 156  
157 157  {{id name="customdir"/}}
158 158  
159 -=== Custom user directory ===
73 +== Custom User Directory ==
160 160  
161 161  {{code language="plain"}}/USERDATADIR=<path>{{/code}} ## ##
162 162  
163 -This is an optional parameter.
164 -
165 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 166  
167 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.
... ... @@ -172,6 +172,8 @@
172 172  start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
173 173  {{/code}}
174 174  
87 +## ##
88 +
175 175  An app shortcut will be created automatically and can be found in the Teamwire software directory.
176 176  
177 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}}
... ... @@ -179,12 +179,10 @@
179 179  
180 180  {{id name="runonstartup"/}}
181 181  
182 -=== Run on startup ===
96 +== Run on Startup ==
183 183  
184 184  {{code language="plain"}}/STARTUP=TRUE{{/code}} ## ##
185 185  
186 -This is an optional parameter.
187 -
188 188  With this parameter you enable the feature to run Teamwire on Windows startup.
189 189  
190 190  Example:
... ... @@ -197,7 +197,7 @@
197 197  
198 198  {{id name="silentdeinstall"/}}
199 199  
200 -== Silent deinstallation ==
112 += Silent Deinstallation =
201 201  
202 202  You can deinstall Teamwire in silent mode from a command line to avoid user interaction during the process.
203 203