Changes for page 4. Windows Install Options

Last modified by teamwire001 on 2025/08/19 08:19

From 3.1 to 2.3

From version 4.1

edited by teamwire001
on 2025/08/19 08:19

Change comment: DOC-434

To version 3.1

edited by teamwire001
on 2024/12/12 14:44

Change comment: DOC-390 + heading hierarchy fixes

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,63 +1,54 @@
--{{id name="4-quietinstall"/}}
++= Desktop 4.0.0 or newer =
--= Quiet installation =
--{{tabs idsToLabels="install1=Desktop 4, install2=Until Desktop 3.4.3"/}}
++Microsoft Windows Installer is an installation and configuration service provided with Windows. It allows to run processes with the Windows command {{code}}msiexec{{/code}}.
--(% id="install1" %)
--(((
--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.
++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"]].
--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"]]
++{{id name="4-quietinstall"/}}
++== Quiet installation ==
++
++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"]]
++
++
  To install the Teamwire app quietly, use the following command and parameters:
--{{code language="none"}}
++{{code language="shell"}}
  msiexec.exe /i <path_to_package> /qn
  {{/code}}
--Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
--)))
++Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
--(% id="install2" %)
--(((
--You can install Teamwire in silent mode from a command line to avoid user interaction during the process.
--Therefore the command syntax is
++{{id name="4-quietdeinstall"/}}
--{{code language="none"}}
--start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
--{{/code}}
++== Quiet deinstallation ==
--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.
++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"]]
--Example:
--{{code language="none"}}
--start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
++To deinstall the Teamwire app quietly, use the following command and parameters:
++
++{{code language="shell"}}
++msiexec.exe /x <path_to_package> /qn
  {{/code}}
--An app shortcut will be created automatically and can be found in the Teamwire software directory.
++The MSI file path required for the deinstallation depends on your data management.
--The shortcut's target for the default installation is {{code language="none"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
--{{info}}
--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.
--{{/info}}
--)))
++Example A: {{code language="shell"}}msiexec.exe /x "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
++The file which was also used during the installation has remained in its directory.
++Example B: {{code language="shell"}}msiexec.exe /x "C:\Windows\Installer\34237a6a.msi" /qn{{/code}}
++You use the MSI file cached by the system. By default, it's stored under ##%SystemRoot%\Installer##.
++
  {{id name="4-installcontext"/}}
  == Installation context ==
--{{tabs idsToLabels="context1=Desktop 4, context2=Until Desktop 3.4.3"/}}
--
--(% id="context1" %)
--(((
--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.
--
  Windows Installer can install a package on a computer into two installation contexts: per-machine and per-user.
  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"]]
@@ -65,11 +65,11 @@
  {{id name="4-context-user"/}}
--(% class="numbox" %)A(%%) (% class="numbox-title" %)Per user installation
++=== Per user ===
  By default, the package is installed in the per-user installation context. The following command performs the per-user installation:
--{{code language="none"}}
++{{code language="shell"}}
  msiexec.exe /i <path_to_package>
  {{/code}}
@@ -78,11 +78,11 @@
  {{id name="4-context-machine"/}}
--(% class="numbox" %)B(%%) (% class="numbox-title" %)Per machine installation
++=== Per machine ===
  To install the package in the per-machine installation context, the ##ALLUSERS## parameter is required. The following command performs the per-machine installation:
--{{code language="none"}}
++{{code language="shell"}}
  msiexec.exe /i <path_to_package> ALLUSERS=1
  {{/code}}
@@ -91,131 +91,139 @@
  {{id name="4-context-custom"/}}
--(% class="numbox" %)C(%%) (% class="numbox-title" %)Custom installation directory
++=== Custom installation directory ===
  You can define a custom directory for the Teamwire app installation with the following parameters:
--{{code language="none"}}
++{{code language="shell"}}
  msiexec.exe /i <path_to_package> APPLICATIONFOLDER=<absolute_application_path>
  {{/code}}
--Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}
--)))
++Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}
--(% id="context2" %)
--(((
--{{id name="roamingdir"/}}
--(% class="numbox" %)A(%%) (% class="numbox-title" %)Roaming user data directory
--{{code language="none"}}/APPDATA=TRUE{{/code}} ## ##
++----
--This is an optional parameter.
++{{id name="desktop-previous"/}}
--By default, the user's data is written to the ##%LOCALAPPDATA%## directory (##..\AppData\Local\##).
++= Desktop 3.4.3 and previous versions =
--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.
++{{id name="quietinstall"/}}
++
++== Quiet installation ==
++
++You can install Teamwire in silent mode from a command line to avoid user interaction during the process.
++
++Therefore the command syntax is
++
++{{code language="plain"}}
++start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
++{{/code}}
++
++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.
++
  Example:
--{{code language="none"}}
--start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
++{{code language="plain"}}
++start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
  {{/code}}
  An app shortcut will be created automatically and can be found in the Teamwire software directory.
--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}}
++The shortcut's target for the default installation is  {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
++(% class="box infomessage" %)
++(((
++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.
++)))
--{{id name="customdir"/}}
--(% class="numbox" %)B(%%) (% class="numbox-title" %)Custom user data directory
++{{id name="roamingdir"/}}
--{{code language="none"}}/USERDATADIR=<path>{{/code}} ## ##
++=== Roaming user directory ===
++{{code language="plain"}}/APPDATA=TRUE{{/code}} ## ##
++
  This is an optional parameter.
--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.**
++By default, the user's data is written to the  ##%LOCALAPPDATA%##  directory ( ##..\AppData\Local\## ).
--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.
++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.
  Example:
--{{code language="none"}}
--start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
++{{code language="plain"}}
++start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
  {{/code}}
  An app shortcut will be created automatically and can be found in the Teamwire software directory.
--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}}
++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}}
++{{id name="customdir"/}}
--{{id name="runonstartup"/}}
++=== Custom user directory ===
--(% class="numbox" %)C(%%) (% class="numbox-title" %)Run on startup
++{{code language="plain"}}/USERDATADIR=<path>{{/code}} ## ##
--{{code language="none"}}/STARTUP=TRUE{{/code}} ## ##
--
  This is an optional parameter.
--With this parameter you enable the feature to run Teamwire on Windows startup.
++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.**
++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.
++
  Example:
--{{code language="none"}}
--start "" /WAIT Teamwire-setup_1.10.0.exe /S /STARTUP=TRUE /D=C:\Program Files (x86)\Teamwire\
++{{code language="plain"}}
++start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
  {{/code}}
--)))
++An app shortcut will be created automatically and can be found in the Teamwire software directory.
--{{id name="4-quietdeinstall"/}}
++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}}
--= Quiet deinstallation =
--{{tabs idsToLabels="deinstall1=Desktop 4, deinstall2=Until Desktop 3.4.3"/}}
++{{id name="runonstartup"/}}
--(% id="deinstall1" %)
--(((
--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.
++=== Run on startup ===
--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"]]
++{{code language="plain"}}/STARTUP=TRUE{{/code}} ## ##
++This is an optional parameter.
--To deinstall the Teamwire app quietly, use the following command and parameters:
++With this parameter you enable the feature to run Teamwire on Windows startup.
--{{code language="none"}}
--msiexec.exe /x <path_to_package> /qn
++Example:
++
++{{code language="plain"}}
++start "" /WAIT Teamwire-setup_1.10.0.exe /S /STARTUP=TRUE /D=C:\Program Files (x86)\Teamwire\
  {{/code}}
--The MSI file path required for the deinstallation depends on your data management.
++## ##
++{{id name="silentdeinstall"/}}
--**Example A:** {{code language="none"}}msiexec.exe /x "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
--The file which was also used during the installation has remained in its directory.
++== Silent deinstallation ==
--
--**Example B:** {{code language="none"}}msiexec.exe /x "C:\Windows\Installer\34237a6a.msi" /qn{{/code}}
--You use the MSI file cached by the system. By default, it's stored under ##%SystemRoot%\Installer##.
--)))
--
--(% id="deinstall2" %)
--(((
  You can deinstall Teamwire in silent mode from a command line to avoid user interaction during the process.
  Therefore the command syntax is
--{{code language="none"}}
++{{code language="plain"}}
  start "" /WAIT "<path>\uninstall.exe" /S
  {{/code}}
  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.**
--Example: {{code language="none"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
++Example:  {{code language="plain"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
--{{info}}
++
++(% class="box infomessage" %)
++(((
  Please note, the user data is not being removed for all users but the user performing the local deinstallation.
--{{/info}}
  )))
  ## ##

Changes for page 4. Windows Install Options

Summary

Details

Last edited

Content