Skip to Content

Wiki source code of 2. Automated Sign-in

Last modified by teamwire001 on 2025/09/11 14:57
Show last authors
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
3
4 {{id name="windows"/}}
5
6 = Windows =
7
8 To enable the automated sign-in process in Windows, provide the [[Mandatory parameters>>doc:||anchor="mandatory"]] in the following registry hive:
9
10 {{tabs idsToLabels="registry1=Desktop 4, registry2=Until Desktop 3.4.3"/}}
11
12 (% id="registry1" %)
13 (((
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
18 Registry path: ##HKEY_CURRENT_USER\SOFTWARE\teamwire\##
19
20 A template for an executable registry entry incl. all possible configurations can be found at:
21 [[url:https://desktop.teamwire.eu/templates/teamwire-windows.reg||rel="noopener noreferrer" target="_blank"]]
22
23 Please comment out parameters that are not required, e.g. ##proxyUrl##.
24 )))
25
26 (% id="registry2" %)
27 (((
28 Registry path: ##HKEY_CURRENT_USER\Software\Teamwire\UserRegistration\##
29
30 A template for an executable registry entry incl. all possible configurations can be found at
31
32 [[url:http://desktop.teamwire.eu/templates/windows.reg||rel="noopener noreferrer" target="_blank"]]
33
34 Please comment out parameters that are not required, e.g. ##ProxyURL##.
35 )))
36
37 (% style="border-color:var(--gili_blue_300)" %)
38 ----
39
40
41 {{id name="macosandlinux"/}}
42
43 = macOS and Linux =
44
45 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:
46
47 {{tabs idsToLabels="config1=Desktop 4, config2=Until Desktop 3.4.3"/}}
48
49 (% id="config1" %)
50 (((
51 {{info}}
52 Please ensure to always update your desktop app to the latest version to make sure that all available options of the template are supported.
53 {{/info}}
54
55 File path: ##~~/.config/teamwire/teamwire.cfg##
56
57 A template JSON file incl. all possible configurations can be found at
58 [[url:https://desktop.teamwire.eu/templates/teamwire.cfg||rel="noopener noreferrer" target="_blank"]]
59
60 Please delete the parameters that are not required, e.g. ##proxyUrl##.
61 )))
62
63 (% id="config2" %)
64 (((
65 File path: ##~~/.config/teamwire.cfg##
66
67 A template JSON file incl. all possible configurations can be found at
68
69 [[http://desktop.teamwire.eu/templates/registration.json||rel="noopener noreferrer" target="_blank"]]
70
71 Please delete the parameters that are not required, e.g. ##ProxyURL##.
72 )))
73
74 (% style="border-color:var(--gili_blue_300)" %)
75 ----
76
77
78 {{id name="mandatory"/}}
79
80 = Mandatory parameters =
81
82 The following parameters are always required for automated sign-in:
83
84 {{tabs idsToLabels="parameter1=Desktop 4, parameter2=Until Desktop 3.4.3"/}}
85
86 (% id="parameter1" %)
87 (((
88 * ##firstName##: User's first name
89 * ##lastName##: User's last name
90 * ##email##: User's email address
91 * ##registrationToken##: One-time registration token from the Dashboard
92 * ##serverHost##: Teamwire Server name as described in [[Advanced Configurations>>doc:Public.Applications.Desktop.Advanced-Configurations.WebHome||anchor="4-hostname"]] (optional but recommended)
93 )))
94
95 (% id="parameter2" %)
96 (((
97 * ##FirstName##: User's first name
98 * ##LastName##: User's last name
99 * ##Email##: User's email address
100 * ##RegistrationToken##: One-time registration token from the Dashboard
101 * ##BackendServerName##: Teamwire Server name as described in [[Advanced Configurations>>doc:Public.Applications.Desktop.Advanced-Configurations.WebHome||anchor="4-hostname"]] (optional but recommended)
102 )))
103
104 (% style="border-color:var(--gili_blue_300)" %)
105 ----
106
107
108 {{id name="securityadvice"/}}
109
110 = Security advice =
111
112 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.
113
114 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]].
115
116 ## ##