Skip to Content
Last modified by teamwire001 on 2024/12/12 14:44
From version 1.3
edited by teamwire001
on 2023/02/10 13:49
Change comment: reorder by title
To version 3.1
edited by teamwire001
on 2024/12/12 14:44
Change comment: DOC-390 + heading hierarchy fixes

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -4. Silent Installation
1 +4. Windows Install Options
Content
... ... @@ -1,9 +1,110 @@
1 -(% class="box warningmessage" %)
2 -(((
3 -These features are available on Teamwire for Windows only.
4 -)))
1 += Desktop 4.0.0 or newer =
5 5  
6 6  
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 +
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
... ... @@ -12,8 +12,6 @@
12 12  start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
13 13  {{/code}}
14 14  
15 -## ##
16 -
17 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 18  
19 19  Example:
... ... @@ -22,35 +22,24 @@
22 22  start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
23 23  {{/code}}
24 24  
25 -## ##
124 +An app shortcut will be created automatically and can be found in the Teamwire software directory.
26 26  
126 +The shortcut's target for the default installation is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
127 +
27 27  (% class="box infomessage" %)
28 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.
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.
30 30  )))
31 31  
32 -## ##
33 33  
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 -
48 48  {{id name="roamingdir"/}}
49 49  
50 -== Roaming User Directory ==
136 +=== Roaming user directory ===
51 51  
52 52  {{code language="plain"}}/APPDATA=TRUE{{/code}} ## ##
53 53  
140 +This is an optional parameter.
141 +
54 54  By default, the user's data is written to the ##%LOCALAPPDATA%## directory ( ##..\AppData\Local\## ).
55 55  
56 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.
... ... @@ -61,8 +61,6 @@
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 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}}
... ... @@ -70,10 +70,12 @@
70 70  
71 71  {{id name="customdir"/}}
72 72  
73 -== Custom User Directory ==
159 +=== Custom user directory ===
74 74  
75 75  {{code language="plain"}}/USERDATADIR=<path>{{/code}} ## ##
76 76  
163 +This is an optional parameter.
164 +
77 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.**
78 78  
79 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.
... ... @@ -84,8 +84,6 @@
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 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}}
... ... @@ -93,10 +93,12 @@
93 93  
94 94  {{id name="runonstartup"/}}
95 95  
96 -== Run on Startup ==
182 +=== Run on startup ===
97 97  
98 98  {{code language="plain"}}/STARTUP=TRUE{{/code}} ## ##
99 99  
186 +This is an optional parameter.
187 +
100 100  With this parameter you enable the feature to run Teamwire on Windows startup.
101 101  
102 102  Example:
... ... @@ -109,7 +109,7 @@
109 109  
110 110  {{id name="silentdeinstall"/}}
111 111  
112 -= Silent Deinstallation =
200 +== Silent deinstallation ==
113 113  
114 114  You can deinstall Teamwire in silent mode from a command line to avoid user interaction during the process.
115 115