Teamwire Desktop Registration · let’s say the proxy is running on a host named your-proxy.com...

Teamwire Desktop Registration

Version 1.09 (20.09.2018)

grouptime GmbHTittmoninger Straße 11

81679 MünchenGermany

[email protected]

Teamwire Desktop Registration ii

Contents

1 Registration Steps 1

1.1 Accept terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.2 Phone Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.3 Name and Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.4 Advanced Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.4.1 Important Note in case of "Registration could not be completed" . . . . . . . . . . . . . . . . . . . . . . . 4

1.5 Confirm Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.6 Enter PIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.7 Synchronising . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2 Advanced Configurations 8

2.1 Backend Hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.2 Proxy URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.2.1 HTTPS Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.2.2 Socks5 Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.2.3 Socks4 Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.2.4 PAC Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.3 Proxy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.4 Custom Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3 Silent Installation on Windows 10

3.1 AppData Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

3.2 Custom AppData Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4 Automated Registration 12

4.1 Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.2 OS X and Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.3 Mandatory Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.4 Security Advice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

A Reporting Errors 14

A.1 Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

A.2 OS X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

A.3 Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Teamwire Desktop Registration iii

This document provides details on the registration of a new user on the Teamwire desktop apps. For most environments theregistration process is straightforward, but some corporate networks have more complex setups and this document aims to providethe answers to the questions, that might arise in those kind of installations.

Teamwire Desktop Registration 1 / 15

Chapter 1

Registration Steps

1.1 Accept terms

Please read and accept the Terms of Service and Privacy Policy before continuing.


1.2 Phone Number

First select your country in the drop-down menu and then enter your phone number without the country code.

e.g. Country Code: Germany (+49) and Phone Number: 017312345678


1.3 Name and Email

Enter your first and last name as well as your organisation email. Other users in Teamwire though will only see and find you byyour name.

If your system administrator has already created a user with your email address, first and last name will be automatically adjustedto your predefined profile.


1.4 Advanced Configuration

These configurations are most likely provided by your network or system administrator, as they provide support for advancedcorporate network configurations. Please consult Chapter 2 for details, if you need to enter some of these configurations.

1.4.1 Important Note in case of "Registration could not be completed"

Our backend determination mechanism relies on a proper DNS1 functionality. Some ISPs2 do not respond with correct DNS codeswhen a server is not found. This results in a "Registration could not be completed" message during the registration.If you receive such a message, please contact your system administrator to find out if your organisation uses a custom backendhostname. If your organisation does not have a custom backend, please try entering backend.teamwire.eu as the backendhostname in the Advanced options.

1 DNS: Domain Name System. An internet service that translates domain names into IP addresses.2 ISP: Internet Service Provider. A company that provides access to the internet.


1.5 Confirm Email

If yet not created by the system administrator, the server will be contacted to setup your new account after entering the previousinformation. In order to certify that you own the email entered, you will receive a mail with a confirmation link. Please click that linkto continue to the next step.


1.6 Enter PIN

You will also receive a SMS with a PIN code to verify the given phone number. Please enter the code and click "Next".


1.7 Synchronising

After confirming your email and phone number, Teamwire will proceed to login and synchronise your organisation’s colleagues,groups and messages. When this process is finished, the inbox view will open automatically.


Chapter 2

Advanced Configurations

2.1 Backend Hostname

In this field the custom backend hostname should be entered. Please enter the hostname only without protocol or path. Fillingthis field can speed up the process and prevent registration failures, so it is advisable to do it. If your organisation is using theTeamwire Public Cloud Backend, please enter backend.teamwire.eu.

2.2 Proxy URL

If there is a proxy server in the network and it is needed to access the backend, the complete URL1 should be entered, includingprotocol and port parts. The different types of proxies and their syntax are explained down below. For the following examples,let’s say the proxy is running on a host named your-proxy.com with port 9000. If the proxy needs basic HTTPS or socks5authentication, the credentials can be included in the URL as shown in the examples.

2.2.1 HTTPS Proxy

https://your-proxy.com:9000

https://username:[email protected]:9000

2.2.2 Socks5 Proxy

socks5://your-proxy.com:9000

socks5://username:[email protected]:9000

2.2.3 Socks4 Proxy

socks4://your-proxy.com:9000

2.2.4 PAC Proxy

pac+http://file-provider.com/proxy.pac

1 URL: Uniform Resource Locator. The address to a resource on the internet, e.g. website.


2.3 Proxy Configuration

In order to work properly with a proxy server, Teamwire needs the proxy to support the HTTP CONNECT method, the HTTPUpgrade mechanism and allow all Sec-Websocket-* headers.

2.4 Custom Certificate

If the backend server uses a self-signed certificate or if it is signed by a Certificate Authority (CA), that is not well known, youshould provide the path to the chained certificate, including any intermediate certificate in PEM2 format.

ImportantPlease make sure to use the unix line feed LF on your certificate. Any other control characters like CR orWindows’ CR LF will not be valid.Also note, that the path used to refer to your certificate must not contain any spaces.

2 PEM: Privacy Enhanced Mail (.pem), fileformat


Chapter 3

Silent Installation on Windows

You can install Teamwire in silent mode from a command line to avoid user interaction during the process. For silent mode, pleaseuse the following command line:

start "" /WAIT Teamwire-setup.exe /S /D=COMPLETE_PATH

Please replace COMPLETE_PATH with your preferred destination folder (i.e. "C:\Program Files\"). The application willget installed in its own folder, within the designated path.

NotePlease note that /D must be the last parameter used in the command line and must not contain any quotation markseven if the path contains spaces.

Furthermore, only absolute paths are supported, e.g.:

start "" /WAIT Teamwire-setup.exe /S /D=C:\Program Files (x86)\Teamwire

If the path of COMPLETE_PATH is not valid or it does not exist, the parameter will be ignored and Teamwire will be installed in itsdefault location ("C:\Program Files (x86)\Teamwire")

3.1 AppData Folder

By default, the user’s data is written to the %LOCALAPPDATA% folder. In some corporate and virtual systems, this folder’s contentis deleted when the session is closed. In order to write into the %APPDATA% folder, please add the argument /APPDATA=TRUEto your command.

Note, as parameter /D still has to be the last in the command line, to set /APPDATA=TRUE in front of it:

start "" /WAIT Teamwire-setup.exe /S /APPDATA=TRUE /D=COMPLETE_PATH

3.2 Custom AppData Folder

In case you need to store your user data to a different location due to your network environment or retention policies for local data,you are able to define a custom path with the parameter /USERDATADIR.

start "" /WAIT Teamwire-setup.exe /S /USERDATADIR=USERDATA_PATH /D=COMPLETE_PATH


You will need to put the path of /USERDATADIR in quotation marks. The Teamwire directory, as stated in USERDATADIR, willnot be created until the first run and registration. Despite the definition of the USERDATADIR, the original directories (%LOCALAPPDATA%\Teamwire\User Data\Default\) still will be created but not contain any data.

Note, that parameter /D still has to be the last in the command line. It must not contain any quotation marks.

start "" /WAIT Teamwire-setup.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program ←↩Files (x86)\Teamwire\


Chapter 4

Automated Registration

For large organisational environments registering users manually can be difficult to manage and scale. Teamwire includes away for system administrators to provide all users’ registration details to automatically configure the Teamwire desktop app. OnWindows desktops this is achieved by entering all information needed into the Windows Registry, and in OS X and Linux by savinga file in the users’ directory.

4.1 Windows

When starting Teamwire for the first time, the application gets the information for a user’s registration (if provided) from the followingregistry hive:HKEY_CURRENT_USER\Software\Teamwire\UserRegistration\

A template for an executable registry entry can be found at http://desktop.teamwire.eu/templates/windows.reg. Please commentout parameters that are not required for your users’ registration, e.g. CustomCAChain or ProxyURL.

4.2 OS X and Linux

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

~/.config/teamwire.cfg

A template JSON file can be found at http://desktop.teamwire.eu/templates/registration.json. Please delete the parameters thatare not required for your users’ registration, e.g. CustomCAChain or ProxyURL.

4.3 Mandatory Parameters

The following parameters are always required for automated registration:FirstName, LastName, Email, RegistrationToken

4.4 Security Advice

The registration token is a very sensible piece of information and needs to be protected against the access of unauthorisedpersons. 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.

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

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


Do not use your origanisation’s registration token to register desktop users. One-time registration tokens for each individualuser 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 Teamwire Administrator Portal Documentation and read thechapter about Bulk Operations.


Appendix A

Reporting Errors

In Teamwire we hope that you won’t have the need to report any errors, but if that happens we need your feedback in order tomake our product better. Usually when an error occurs, we will display a lot of technical content on your screen that providesus with enough information to solve the issue. If you want to send additional information, please have a look at our protocols.Teamwire generates two essential logs: Registration Issues and Critical Errors.

Depending on the platform, those files are stored in different places.

A.1 Windows

On some Windows systems, the folder of your log files can be found in

%LOCALAPPDATA%\Teamwire\User Data\Default\

while on others they’re stored to

%LOCALAPPDATA%\Teamwire\Default\

To open your folder, enter %LOCALAPPDATA% into your Windows Search search box or the Windows Explorer address bar.The %LOCALAPPDATA% folder is usually located at C:\Users\USERNAME\AppData\Local. Then open the folders"Teamwire", "User Data" (if exists) and finally "Default".

The files are called registration_failure.txt and log.txt.

On systems installed with the /APPDATA=TRUE parameter, change %LOCALAPPDATA% to %APPDATA% in the previousinstructions and then follow as described above. The %APPDATA% folder is usually located at C:\Users\USERNAME\AppData\Roaming.

A.2 OS X

The logs get stored to the following folders:

~/Library/Application Support/Teamwire/Default/registration_failure.txt

~/Library/Application Support/Teamwire/Default/log.txt


A.3 Linux

The logs get stored to the following folders:

~/.config/Teamwire/Default/registration_failure.txt

~/.config/Teamwire/Default/log.txt

Teamwire Desktop Registration · let’s say the proxy is running on a host named your-proxy.com...

Documents

Transcript of Teamwire Desktop Registration · let’s say the proxy is running on a host named your-proxy.com...