Changes for page 2. Automated Sign-in
Last modified by teamwire001 on 2025/09/11 14:57
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -2. Automated Registration1 +2. Automated Sign-in - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.teamwire00 41 +XWiki.teamwire001 - Content
-
... ... @@ -1,4 +1,4 @@ 1 -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'registrationdetails 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.1 +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. 2 2 3 3 4 4 {{id name="windows"/}} ... ... @@ -5,87 +5,103 @@ 5 5 6 6 = Windows = 7 7 8 - When startingTeamwire forthefirst time,the application gets the informationfora user'sregistration(ifprovided)from the following registry hive:8 +To enable the automated sign-in process in Windows, provide the [[Mandatory parameters>>doc:||anchor="mandatory"]] in the following registry hive: 9 9 10 -|((( 11 -**Desktop 4.0.10 or later** 10 +{{tabs idsToLabels="registry1=Desktop 4, registry2=Until Desktop 3.4.3"/}} 12 12 13 -(% class="box infomessage" %)12 +(% id="registry1" %) 14 14 ((( 15 -**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. 16 -))) 14 +{{info}} 15 +Please ensure to always update your desktop app to the latest version to make sure that all available options of the template are supported. 16 +{{/info}} 17 17 18 -##HKEY_CURRENT_USER\SOFTWARE\teamwire\## 18 +Registry path: ##HKEY_CURRENT_USER\SOFTWARE\teamwire\## 19 19 20 20 A template for an executable registry entry incl. all possible configurations can be found at: 21 -[[https: ~~/~~/desktop.teamwire.eu/templates/teamwire-windows.reg>>https://desktop.teamwire.eu/templates/teamwire-windows.reg]]21 +[[url:https://desktop.teamwire.eu/templates/teamwire-windows.reg||rel="noopener noreferrer" target="_blank"]] 22 22 23 -Please comment out parameters that are not required for your users' registration, e.g.23 +Please comment out parameters that are not required, e.g. ##proxyUrl##. 24 24 ))) 25 -|((( 26 -**Until Desktop 3.4.2** 27 27 28 -##HKEY_CURRENT_USER\Software\Teamwire\UserRegistration\## 26 +(% id="registry2" %) 27 +((( 28 +Registry path: ##HKEY_CURRENT_USER\Software\Teamwire\UserRegistration\## 29 29 30 30 A template for an executable registry entry incl. all possible configurations can be found at 31 31 32 -[[http://desktop.teamwire.eu/templates/windows.reg||rel="noopener noreferrer" target="_blank"]] 32 +[[url:http://desktop.teamwire.eu/templates/windows.reg||rel="noopener noreferrer" target="_blank"]] 33 33 34 -Please comment out parameters that are not required for your users' registration, e.g.34 +Please comment out parameters that are not required, e.g. ##ProxyURL##. 35 35 ))) 36 36 37 + 37 37 {{id name="macosandlinux"/}} 38 38 39 39 = macOS and Linux = 40 40 41 -To enable automated registrationin macOS or Linux,a JSON file needsbeplacedin the user'sfolder:42 +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: 42 42 43 -|((( 44 -**Desktop 4.0.10 or later** 44 +{{tabs idsToLabels="config1=Desktop 4, config2=Until Desktop 3.4.3"/}} 45 45 46 -(% class="box infomessage" %)46 +(% id="config1" %) 47 47 ((( 48 -**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. 49 -))) 48 +{{info}} 49 +Please ensure to always update your desktop app to the latest version to make sure that all available options of the template are supported. 50 +{{/info}} 50 50 51 -##~~/.config/teamwire/teamwire.cfg## 52 +File path: ##~~/.config/teamwire/teamwire.cfg## 52 52 53 53 A template JSON file incl. all possible configurations can be found at 54 -[[https: ~~/~~/desktop.teamwire.eu/templates/teamwire.cfg>>https://desktop.teamwire.eu/templates/teamwire.cfg]]55 +[[url:https://desktop.teamwire.eu/templates/teamwire.cfg||rel="noopener noreferrer" target="_blank"]] 55 55 56 -Please delete the parameters that are not required for your users' registration, e.g.57 +Please delete the parameters that are not required, e.g. ##proxyUrl##. 57 57 ))) 58 -|((( 59 -**Until Desktop 3.4.2** 60 60 61 -##~~/.config/teamwire.cfg## 60 +(% id="config2" %) 61 +((( 62 +File path: ##~~/.config/teamwire.cfg## 62 62 63 63 A template JSON file incl. all possible configurations can be found at 64 64 65 65 [[http://desktop.teamwire.eu/templates/registration.json||rel="noopener noreferrer" target="_blank"]] 66 66 67 -Please delete the parameters that are not required for your users' registration, e.g.68 +Please delete the parameters that are not required, e.g. ##ProxyURL##. 68 68 ))) 69 69 71 + 70 70 {{id name="mandatory"/}} 71 71 72 -= Mandatory Parameters =74 += Mandatory parameters = 73 73 74 -The following parameters are always required for automated registration:76 +The following parameters are always required for automated sign-in: 75 75 76 -* ##firstName## 77 -* ##lastName## 78 -* ##email## 79 -* ##registrationToken## 78 +{{tabs idsToLabels="parameter1=Desktop 4, parameter2=Until Desktop 3.4.3"/}} 80 80 81 -## ## 80 +(% id="parameter1" %) 81 +((( 82 +* ##firstName##: User's first name 83 +* ##lastName##: User's last name 84 +* ##email##: User's email address 85 +* ##registrationToken##: One-time registration token from the Dashboard 86 +* ##serverHost##: Teamwire Server name as described in [[Advanced Configurations>>doc:Public.Applications.Desktop.Advanced-Configurations.WebHome||anchor="4-hostname"]] (optional but recommended) 87 +))) 82 82 89 +(% id="parameter2" %) 90 +((( 91 +* ##FirstName##: User's first name 92 +* ##LastName##: User's last name 93 +* ##Email##: User's email address 94 +* ##RegistrationToken##: One-time registration token from the Dashboard 95 +* ##BackendServerName##: Teamwire Server name as described in [[Advanced Configurations>>doc:Public.Applications.Desktop.Advanced-Configurations.WebHome||anchor="4-hostname"]] (optional but recommended) 96 +))) 97 + 98 + 83 83 {{id name="securityadvice"/}} 84 84 85 -= Security Advice =101 += Security advice = 86 86 87 87 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. 88 88 89 -Do not use your organisation's registration token to registerdesktop 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 andregisterany Teamwire user account. For details about the one-time registration token, please refer to the chapterabout [[UserOperations>>doc:Customer.Administration.Dashboard-User-Manual.Users.WebHome||anchor="users-useroperations"]] in the [[Dashboard manual>>doc:Customer.Administration.Dashboard-User-Manual.WebHome]].105 +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]]. 90 90 91 91 ## ##