2. Automated Registration

Last modified by teamwire003 on 2024/08/13 12:50

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.

Windows

When starting Teamwire for the first time, the application gets the information for a user's registration (if provided) from the following registry hive:

Desktop 4.0.10 or later

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. 

HKEY_CURRENT_USER\SOFTWARE\teamwire\

A template for an executable registry entry incl. all possible configurations can be found at:
https://desktop.teamwire.eu/templates/teamwire-windows.reg

Please comment out parameters that are not required for your users' registration, e.g.  proxyUrl.

Until Desktop 3.4.3

HKEY_CURRENT_USER\Software\Teamwire\UserRegistration\

A template for an executable registry entry incl. all possible configurations can be found at

http://desktop.teamwire.eu/templates/windows.reg

Please comment out parameters that are not required for your users' registration, e.g.  ProxyURL.

macOS and Linux

To enable automated registration in macOS or Linux, a JSON file needs to be placed in the user's folder:

Desktop 4.0.10 or later

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. 

~/.config/teamwire/teamwire.cfg

A template JSON file incl. all possible configurations can be found at
https://desktop.teamwire.eu/templates/teamwire.cfg

Please delete the parameters that are not required for your users' registration, e.g.  proxyUrl.

Until Desktop 3.4.3

~/.config/teamwire.cfg

A template JSON file incl. all possible configurations can be found at

http://desktop.teamwire.eu/templates/registration.json

Please delete the parameters that are not required for your users' registration, e.g.  ProxyURL.

Mandatory Parameters

The following parameters are always required for automated registration:

  • firstName
  • lastName
  • email
  • registrationToken

 

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 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 in the Dashboard manual.