2. Automated Sign-in
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.
Windows
To enable the automated sign-in process in Windows, provide the Mandatory parameters in the following registry hive:
Registry path: 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, e.g. proxyUrl.
Registry path: 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, e.g. ProxyURL.
macOS and Linux
To enable the automated sign-in process in macOS or Linux, provide the Mandatory parameters inside a JSON file in the user directory:
File path: ~/.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, e.g. proxyUrl.
File path: ~/.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, e.g. ProxyURL.
Mandatory parameters
The following parameters are always required for automated sign-in:
- firstName: User's first name
- lastName: User's last name
- email: User's email address
- registrationToken: One-time registration token from the Dashboard
- serverHost: Teamwire Server name as described in Advanced Configurations (optional but recommended)
- FirstName: User's first name
- LastName: User's last name
- Email: User's email address
- RegistrationToken: One-time registration token from the Dashboard
- BackendServerName: Teamwire Server name as described in Advanced Configurations (optional but recommended)
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 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 in the Dashboard manual.