Skip to Content

Changes for page 2. Automated Sign-in

Last modified by teamwire001 on 2026/07/08 06:27
From version 9.1
edited by teamwire001
on 2026/07/08 06:27
Change comment: DOC-573
To version 4.1
edited by teamwire003
on 2024/03/28 08:55
Change comment: Uploaded new attachment "registration-templates_v4.0.10_or_later.zip", version 1.1

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -2. Automated Sign-in
1 +2. Automated Registration
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.teamwire001
1 +XWiki.teamwire003
Content
... ... @@ -1,4 +1,4 @@
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.
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' 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.
2 2  
3 3  
4 4  {{id name="windows"/}}
... ... @@ -5,57 +5,75 @@
5 5  
6 6  = Windows =
7 7  
8 -To enable the automated sign-in process in Windows, provide the [[Mandatory parameters>>doc:||anchor="mandatory"]] in the following registry hive:
8 +When starting Teamwire for the first time, the application gets the information for a user's registration (if provided) from the following registry hive:
9 9  
10 -{{info}}
11 -Please ensure to always update your desktop app to the latest version to make sure that all available options of the template are supported.
12 -{{/info}}
10 +|(((
11 +**Desktop 4.0.0 or newer**
13 13  
14 -Registry path: ##HKEY_CURRENT_USER\SOFTWARE\teamwire\##
13 +##HKEY_CURRENT_USER\SOFTWARE\teamwire\##
15 15  
16 -A template for an executable registry entry incl. all possible configurations can be found at:
17 -[[url:https://desktop.teamwire.eu/templates/teamwire-windows.reg||rel="noopener noreferrer" target="_blank"]]
15 +A template for an executable registry entry incl. all possible configurations can be downloaded here: [[registration-templates.zip>>attach:Public.Applications.Desktop.Automated-Registration.WebHome@registration-templates.zip||download="Public.Applications.Desktop.Automated-Registration.WebHome@registration-templates.zip"]]
18 18  
19 -Please comment out parameters that are not required, e.g. ##proxyUrl##.
17 +Please comment out parameters that are not required for your users' registration, e.g.  ##ProxyURL##.
18 +)))
19 +|(((
20 +**Until Desktop 3.4.2**
20 20  
22 +##HKEY_CURRENT_USER\Software\Teamwire\UserRegistration\##
21 21  
24 +A template for an executable registry entry incl. all possible configurations can be found at
25 +
26 +[[http://desktop.teamwire.eu/templates/windows.reg||rel="noopener noreferrer" target="_blank"]]
27 +
28 +Please comment out parameters that are not required for your users' registration, e.g.  ##ProxyURL##.
29 +)))
30 +
22 22  {{id name="macosandlinux"/}}
23 23  
24 24  = macOS and Linux =
25 25  
26 -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:
35 +To enable automated registration in macOS or Linux, a JSON file needs to be placed in the user's folder:
27 27  
28 -{{info}}
29 -Please ensure to always update your desktop app to the latest version to make sure that all available options of the template are supported.
30 -{{/info}}
37 +|(((
38 +**Desktop 4.0.0 or newer**
31 31  
32 -File path: ##~~/.config/teamwire/teamwire.cfg##
40 +##~~/.config/teamwire/teamwire.cfg##
33 33  
42 +A template JSON file incl. all possible configurations can be downloaded here: [[registration-templates.zip>>attach:Public.Applications.Desktop.Automated-Registration.WebHome@registration-templates.zip||download="Public.Applications.Desktop.Automated-Registration.WebHome@registration-templates.zip"]]
43 +
44 +Please delete the parameters that are not required for your users' registration, e.g.  ##ProxyURL##.
45 +)))
46 +|(((
47 +**Until Desktop 3.4.2**
48 +
49 +##~~/.config/teamwire.cfg##
50 +
34 34  A template JSON file incl. all possible configurations can be found at
35 -[[url:https://desktop.teamwire.eu/templates/teamwire.cfg||rel="noopener noreferrer" target="_blank"]]
36 36  
37 -Please delete the parameters that are not required, e.g. ##proxyUrl##.
53 +[[http://desktop.teamwire.eu/templates/registration.json||rel="noopener noreferrer" target="_blank"]]
38 38  
55 +Please delete the parameters that are not required for your users' registration, e.g.  ##ProxyURL##.
56 +)))
39 39  
40 40  {{id name="mandatory"/}}
41 41  
42 -= Mandatory parameters =
60 += Mandatory Parameters =
43 43  
44 -The following parameters are always required for automated sign-in:
62 +The following parameters are always required for automated registration:
45 45  
46 -* ##firstName##: User's first name
47 -* ##lastName##: User's last name
48 -* ##email##: User's email address
49 -* ##registrationToken##: One-time registration token from the Dashboard
50 -* ##serverHost##: Teamwire Server name as described in [[Advanced Configurations>>doc:Public.Applications.Desktop.Advanced-Configurations.WebHome||anchor="4-hostname"]] (optional but recommended)
64 +* ##firstName##
65 +* ##lastName##
66 +* ##email##
67 +* ##registrationToken##
68 +
51 51  ## ##
52 52  
53 53  {{id name="securityadvice"/}}
54 54  
55 -= Security advice =
73 += Security Advice =
56 56  
57 57  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.
58 58  
59 -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 ( {{icon name="sign-in" size="1x" cssClass="fa-blue helpc" title="This document is only available to logged-in users"/}})>>doc:Customer.Administration.Dashboard-User-Manual.Users.WebHome||anchor="users-useroperations" title="This document is only available to logged-in users"]] in the Dashboard Manual.
77 +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]].
60 60  
61 61  ## ##
teamwire-windows.reg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.teamwire001
Size
... ... @@ -1,1 +1,0 @@
1 -3.3 KB
Content
... ... @@ -1,97 +1,0 @@
1 -��Windows Registry Editor Version 5.00
2 -
3 -
4 -
5 -[HKEY_CURRENT_USER\SOFTWARE\teamwire]
6 -
7 -
8 -
9 -; FIRST NAME
10 -
11 -; Mandatory for automated registration
12 -
13 -; The user's first name
14 -
15 -; Uncomment the following line to use this setting:
16 -
17 -;"firstName"="USER_FIRST_NAME"
18 -
19 -
20 -
21 -; LAST NAME
22 -
23 -; Mandatory for automated registration
24 -
25 -; The user's last name
26 -
27 -; Uncomment the following line to use this setting:
28 -
29 -;"lastName"="USER_LAST_NAME"
30 -
31 -
32 -
33 -; EMAIL ADDRESS
34 -
35 -; Mandatory for automated registration
36 -
37 -; The user's email address
38 -
39 -; Uncomment the following line to use this setting:
40 -
41 -;"email"="USER_EMAIL"
42 -
43 -
44 -
45 -; REGISTRATION TOKEN
46 -
47 -; Mandatory for automated registration
48 -
49 -; The user's one-time registration token
50 -
51 -; Uncomment the following line to use this setting:
52 -
53 -;"registrationToken"="TOKEN"
54 -
55 -
56 -
57 -; PHONE NUMBER (optional)
58 -
59 -; Phone number in the user's profile
60 -
61 -; Uncomment the following line to use this setting:
62 -
63 -;"phoneNumber"="PHONE_NUMBER"
64 -
65 -
66 -
67 -; TEAMWIRE SERVER HOSTNAME (optional)
68 -
69 -; Do not include protocol like https://
70 -
71 -; Default hostname is "backend.teamwire.eu"
72 -
73 -; Uncomment the following line to use this setting:
74 -
75 -;"serverHost"="CUSTOM_SERVER_HOSTNAME"
76 -
77 -
78 -
79 -; PROXY URL (optional)
80 -
81 -; The proxy URL should contain the protocol, user (if any), server name and port
82 -
83 -; Uncomment the following line to use this setting:
84 -
85 -;"proxyUrl"="COMPLETE_SERVER_PROXY_URL"
86 -
87 -
88 -
89 -; TRUSTED CERTIFICATES (optional)
90 -
91 -; Whitelist your self-signed certificate(s), separated by spaces. The certificates need to be base64-encoded SHA256 certificate fingerprints.
92 -
93 -; Uncomment the following line to use this setting:
94 -
95 -;"trustedCertificates"="FIRST_FINGERPRINT SECOND_FINGERPRINT"
96 -
97 -
teamwire.cfg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.teamwire001
Size
... ... @@ -1,1 +1,0 @@
1 -237 bytes
Content
... ... @@ -1,11 +1,0 @@
1 -{
2 -"firstName": "String",
3 -"lastName": "String",
4 -"email": "String",
5 -"registrationToken": "String",
6 -"phoneNumber": "String",
7 -"serverHost": "String",
8 -"proxyUrl": "String",
9 -"trustedCertificates": ["FIRST_FINGERPRINT", "SECOND_FINGERPRINT"]
10 -}
11 -