Wiki source code of 2. Automated Registration

Last modified by teamwire003 on 2024/03/28 08:56
Show last authors
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
3
4 {{id name="windows"/}}
5
6 = Windows =
7
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
10 |(((
11 **Desktop 4.0.10 or later**
12
13 ##HKEY_CURRENT_USER\SOFTWARE\teamwire\##
14
15 A template for an executable registry entry incl. all possible configurations can be downloaded here: [[registration-templates_v4.0.10_or_later.zip>>attach:Public.Applications.Desktop.Automated-Registration.WebHome@registration-templates_v4.0.10_or_later.zip||download="Public.Applications.Desktop.Automated-Registration.WebHome@registration-templates_v4.0.10_or_later.zip"]]
16
17 Please comment out parameters that are not required for your users' registration, e.g.  ##proxyUrl##.
18 )))
19 |(((
20 **Until Desktop 3.4.2**
21
22 ##HKEY_CURRENT_USER\Software\Teamwire\UserRegistration\##
23
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
31 {{id name="macosandlinux"/}}
32
33 = macOS and Linux =
34
35 To enable automated registration in macOS or Linux, a JSON file needs to be placed in the user's folder:
36
37 |(((
38 **Desktop 4.0.10 or later**
39
40 ##~~/.config/teamwire/teamwire.cfg##
41
42 A template JSON file incl. all possible configurations can be downloaded here: [[registration-templates_v4.0.10_or_later.zip>>attach:Public.Applications.Desktop.Automated-Registration.WebHome@registration-templates_v4.0.10_or_later.zip||download="Public.Applications.Desktop.Automated-Registration.WebHome@registration-templates_v4.0.10_or_later.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
51 A template JSON file incl. all possible configurations can be found at
52
53 [[http://desktop.teamwire.eu/templates/registration.json||rel="noopener noreferrer" target="_blank"]]
54
55 Please delete the parameters that are not required for your users' registration, e.g.  ##ProxyURL##.
56 )))
57
58 {{id name="mandatory"/}}
59
60 = Mandatory Parameters =
61
62 The following parameters are always required for automated registration:
63
64 * ##firstName##
65 * ##lastName##
66 * ##email##
67 * ##registrationToken##
68
69 ## ##
70
71 {{id name="securityadvice"/}}
72
73 = Security Advice =
74
75 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.
76
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]].
78
79 ## ##

Getting Started

Applications

Teamwire GmbH