Changes for page 2. Automated Sign-in

Last modified by teamwire001 on 2025/09/11 14:57

From 5.2 to 5.1

From version 6.3

edited by teamwire001
on 2025/09/11 14:57

Change comment: DOC-434

To version 5.2

edited by teamwire003
on 2024/08/13 12:39

Change comment: 3.4.2 changed to 3.4.3

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--2. Automated Sign-in
++2. Automated Registration

Author

@@ -1,1 +1,1 @@
--XWiki.teamwire001
++XWiki.teamwire003

Content

@@ -1,4 +1,4 @@
--For large organisational environments signing in users manually can be difficult to manage and scale. Teamwire includes a way for system administrators to provide all users' details to automatically configure the Teamwire desktop app. On Windows desktops this is achieved by entering all information needed into the Windows Registry, and in macOS and Linux by saving a file in the users' directory.
++For large organisational environments registering users manually can be difficult to manage and scale. Teamwire includes a way for system administrators to provide all users' registration details to automatically configure the Teamwire desktop app. On Windows desktops this is achieved by entering all information needed into the Windows Registry, and in macOS and Linux by saving a file in the users' directory.
  {{id name="windows"/}}
@@ -5,112 +5,87 @@
  = Windows =
--To enable the automated sign-in process in Windows, provide the [[Mandatory parameters>>doc:||anchor="mandatory"]] in the following registry hive:
++When starting Teamwire for the first time, the application gets the information for a user's registration (if provided) from the following registry hive:
--{{tabs idsToLabels="registry1=Desktop 4, registry2=Until Desktop 3.4.3"/}}
++|(((
++**Desktop 4.0.10 or later**
--(% id="registry1" %)
++(% class="box infomessage" %)
  (((
--{{info}}
--Please ensure to always update your desktop app to the latest version to make sure that all available options of the template are supported.
--{{/info}}
++**Note:** Please ensure to always update your Desktop App to the latest version to make sure that all available options of the template are supported.
++)))
--Registry path: ##HKEY_CURRENT_USER\SOFTWARE\teamwire\##
++##HKEY_CURRENT_USER\SOFTWARE\teamwire\##
  A template for an executable registry entry incl. all possible configurations can be found at:
--[[url:https://desktop.teamwire.eu/templates/teamwire-windows.reg||rel="noopener noreferrer" target="_blank"]]
++[[https:~~/~~/desktop.teamwire.eu/templates/teamwire-windows.reg>>https://desktop.teamwire.eu/templates/teamwire-windows.reg]]
--Please comment out parameters that are not required, e.g. ##proxyUrl##.
++Please comment out parameters that are not required for your users' registration, e.g.  ##proxyUrl##.
  )))
++|(((
++**Until Desktop 3.4.3**
--(% id="registry2" %)
--(((
--Registry path: ##HKEY_CURRENT_USER\Software\Teamwire\UserRegistration\##
++##HKEY_CURRENT_USER\Software\Teamwire\UserRegistration\##
  A template for an executable registry entry incl. all possible configurations can be found at
--[[url:http://desktop.teamwire.eu/templates/windows.reg||rel="noopener noreferrer" target="_blank"]]
++[[http://desktop.teamwire.eu/templates/windows.reg||rel="noopener noreferrer" target="_blank"]]
--Please comment out parameters that are not required, e.g. ##ProxyURL##.
++Please comment out parameters that are not required for your users' registration, e.g.  ##ProxyURL##.
  )))
--(% style="border-color:var(--gili_blue_300)" %)
------
--
--
  {{id name="macosandlinux"/}}
  = macOS and Linux =
--To enable the automated sign-in process in macOS or Linux, provide the [[Mandatory parameters>>doc:||anchor="mandatory"]] inside a JSON file in the user directory:
++To enable automated registration in macOS or Linux, a JSON file needs to be placed in the user's folder:
--{{tabs idsToLabels="config1=Desktop 4, config2=Until Desktop 3.4.3"/}}
++|(((
++**Desktop 4.0.10 or later**
--(% id="config1" %)
++(% class="box infomessage" %)
  (((
--{{info}}
--Please ensure to always update your desktop app to the latest version to make sure that all available options of the template are supported.
--{{/info}}
++**Note:** Please ensure to always update your Desktop App to the latest version to make sure that all available options of the template are supported.
++)))
--File path: ##~~/.config/teamwire/teamwire.cfg##
++##~~/.config/teamwire/teamwire.cfg##
  A template JSON file incl. all possible configurations can be found at
--[[url:https://desktop.teamwire.eu/templates/teamwire.cfg||rel="noopener noreferrer" target="_blank"]]
++[[https:~~/~~/desktop.teamwire.eu/templates/teamwire.cfg>>https://desktop.teamwire.eu/templates/teamwire.cfg]]
--Please delete the parameters that are not required, e.g. ##proxyUrl##.
++Please delete the parameters that are not required for your users' registration, e.g.  ##proxyUrl##.
  )))
++|(((
++**Until Desktop 3.4.2**
--(% id="config2" %)
--(((
--File path: ##~~/.config/teamwire.cfg##
++##~~/.config/teamwire.cfg##
  A template JSON file incl. all possible configurations can be found at
  [[http://desktop.teamwire.eu/templates/registration.json||rel="noopener noreferrer" target="_blank"]]
--Please delete the parameters that are not required, e.g. ##ProxyURL##.
++Please delete the parameters that are not required for your users' registration, e.g.  ##ProxyURL##.
  )))
--(% style="border-color:var(--gili_blue_300)" %)
------
--
--
  {{id name="mandatory"/}}
--= Mandatory parameters =
++= Mandatory Parameters =
--The following parameters are always required for automated sign-in:
++The following parameters are always required for automated registration:
--{{tabs idsToLabels="parameter1=Desktop 4, parameter2=Until Desktop 3.4.3"/}}
++* ##firstName##
++* ##lastName##
++* ##email##
++* ##registrationToken##
--(% id="parameter1" %)
--(((
--* ##firstName##: User's first name
--* ##lastName##: User's last name
--* ##email##: User's email address
--* ##registrationToken##: One-time registration token from the Dashboard
--* ##serverHost##: Teamwire Server name as described in [[Advanced Configurations>>doc:Public.Applications.Desktop.Advanced-Configurations.WebHome||anchor="4-hostname"]] (optional but recommended)
--)))
++## ##
--(% id="parameter2" %)
--(((
--* ##FirstName##: User's first name
--* ##LastName##: User's last name
--* ##Email##: User's email address
--* ##RegistrationToken##: One-time registration token from the Dashboard
--* ##BackendServerName##: Teamwire Server name as described in [[Advanced Configurations>>doc:Public.Applications.Desktop.Advanced-Configurations.WebHome||anchor="4-hostname"]] (optional but recommended)
--)))
--
--(% style="border-color:var(--gili_blue_300)" %)
------
--
--
  {{id name="securityadvice"/}}
--= Security advice =
++= Security Advice =
  The registration token is a very sensible piece of information and needs to be protected against the access of unauthorised persons. We recommend to keep the channel you use, for transmitting the token to the desktop computers, as safe as possible. The file should be also saved with the most restrictive permissions.
--Do not use your organisation's registration token to sign in desktop users. One-time registration tokens for each individual user can be used in parallel, and are much safer since the Windows Registry and configuration files can be examined by users. Therefore the user may abuse the organisation's token and sign in any Teamwire user account. For details about the one-time registration token, please refer to the section about [[User operations>>doc:Customer.Administration.Dashboard-User-Manual.Users.WebHome||anchor="users-useroperations"]] in the [[Dashboard manual>>doc:Customer.Administration.Dashboard-User-Manual.WebHome]].
++Do not use your organisation's registration token to register desktop users. One-time registration tokens for each individual user can be used in parallel, and are much safer since the Windows Registry and configuration files can be examined by users. Therefore the user may abuse the organisation's token and register any Teamwire user account. For details about the one-time registration token, please refer to the chapter about [[User Operations>>doc:Customer.Administration.Dashboard-User-Manual.Users.WebHome||anchor="users-useroperations"]] in the [[Dashboard manual>>doc:Customer.Administration.Dashboard-User-Manual.WebHome]].
  ## ##

Changes for page 2. Automated Sign-in

Summary

Details

Last edited

Content