Wiki source code of Public Beta Guide
Version 3.2 by teamwire001 on 2023/09/11 08:43
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | Thank you for participating in the Teamwire Desktop Public Beta testing. | ||
2 | |||
3 | This document provides basic information about the functionality of the new desktop app and how to report any bugs you find. | ||
4 | |||
5 | |||
6 | {{id name="requirements"/}} | ||
7 | |||
8 | = System requirements = | ||
9 | |||
10 | Supported Operating Systems: | ||
11 | |||
12 | * Microsoft Windows 10 or later | ||
13 | ## ## | ||
14 | |||
15 | {{id name="bugreport"/}} | ||
16 | |||
17 | = Bug reporting = | ||
18 | |||
19 | Do you want to report a problem? Go ahead! | ||
20 | |||
21 | If certain types of behavior or errors occur repeatedly, please share your experience with us! The following information is extremely helpful for the further development and improvement of the app: | ||
22 | |||
23 | * Can the problem be repeatedly reproduced? Yes / No / Sometimes | ||
24 | * Go to View > Toggle Developer Tools and open the "Console" tab in the new screen. Reproduce the behaviour and export the data you see. | ||
25 | * Describe how to reproduce the behaviour step by step | ||
26 | * Your logfile (see [[Logfile location>>doc:||anchor="logfile"]]) | ||
27 | * A screenshot, if necessary | ||
28 | * The version of your Teamwire Desktop Beta app | ||
29 | * The version of your operating system (e.g. Windows 10 Pro) | ||
30 | |||
31 | If you miss a particular feature, please check the current [[list of features>>doc:||anchor="appfeatures"]] to see if it has already been implemented. | ||
32 | |||
33 | |||
34 | {{id name="installdir"/}} | ||
35 | |||
36 | = Installation directory = | ||
37 | |||
38 | The installation directory is currently not customizable. By default, the app is installed here: | ||
39 | |||
40 | * **Windows:** ##%LOCALAPPDATA%\Programs\teamwire-beta\## | ||
41 | * **macOS:** ##/Applications/Teamwire Beta.app## | ||
42 | * **Linux:** ##/bin/Teamwire Beta## | ||
43 | ## ## | ||
44 | |||
45 | {{id name="userdatadir"/}} | ||
46 | |||
47 | = User data directory = | ||
48 | |||
49 | The location of your user data is currently not customizable. By default, your data is stored here: | ||
50 | |||
51 | * **Windows:** ##%APPDATA%\teamwire-beta\## | ||
52 | * **macOS:** ##/Users/[username]/Library/Application Support/teamwire-beta## | ||
53 | * **Linux:** ##/home/[username]/.config/teamwire-beta## | ||
54 | ## ## | ||
55 | |||
56 | {{id name="logfile"/}} | ||
57 | |||
58 | = Logfile location = | ||
59 | |||
60 | The log file with the file name "logs" is saved in your user data directory. | ||
61 | |||
62 | * **Windows:** ##%APPDATA%\teamwire-beta\logs## | ||
63 | * **macOS:** ##/Users/[username]/Library/Application Support/teamwire-beta/logs## | ||
64 | * **Linux:** ##/home/[username]/.config/teamwire-beta/logs## | ||
65 | ## ## | ||
66 | |||
67 | {{id name="troubleshooting"/}} | ||
68 | |||
69 | = Error: "Sorry. Something went wrong" = | ||
70 | |||
71 | The error message "Sorry. Something went wrong" is a generic message, since not all exceptions are specifically caught yet. | ||
72 | |||
73 | In case of sporadic occurrence, you can bypass this message with the **Reload **button. | ||
74 | |||
75 | If the **Reload **button does not work, you can try one of the following options: | ||
76 | |||
77 | * Close the app completely (via the task manager if necessary) and restart Teamwire Beta. | ||
78 | * Delete all the data in your user data directory. | ||
79 | * Uninstall the app completely and install it again. | ||
80 | ## ## | ||
81 | |||
82 | {{id name="config"/}} | ||
83 | |||
84 | = Configuration / Registry file = | ||
85 | |||
86 | Some settings and user data can be distributed with a configuration file. | ||
87 | |||
88 | **Windows** | ||
89 | |||
90 | * The registry hive is at ##HKEY_CURRENT_USER\SOFTWARE\teamwire-beta\## | ||
91 | ## ## | ||
92 | |||
93 | **macOS and Linux** | ||
94 | |||
95 | * The configuration file needs to be stored to ##~~/.config/teamwire-beta/teamwire-beta.cfg## | ||
96 | * In addition, the JSON schema has been simplified to {{code language="plain text"}}"configurationName": "propertyValue",{{/code}} | ||
97 | ## ## | ||
98 | |||
99 | (% class="lead" %) | ||
100 | Supported parameters | ||
101 | |||
102 | Desktop App **4.0.0-beta.2** supports the following configuration parameters: | ||
103 | |||
104 | * ##serverHost## (String), previously BackendServerName | ||
105 | * ##proxyURL## (String) | ||
106 | ## ## | ||
107 | |||
108 | Desktop App **4.0.0-beta.3** supports the auto-registration process and the following configuration parameters: | ||
109 | |||
110 | * ##serverHost## (String), previously BackendServerName | ||
111 | * ##proxyURL## (String) | ||
112 | * ##firstName## (String) | ||
113 | * ##lastName## (String) | ||
114 | * ##email## (String) | ||
115 | * ##registrationToken## (String) | ||
116 | * ##phoneNumber## (String) | ||
117 | * ##trustedCertificates## (Array) | ||
118 | This new parameter has been added to solve the problems when connecting to the Backend API through a TLS-protected HTTPS with a self-signed certificate. "trustedCertificates" is a certificates whitelist. It is an array of Base64-encoded SHA256 certificate fingerprints. | ||
119 | ## ## | ||
120 | |||
121 | You can download a template for Windows registry and the JSON config here: [[configuration-templates.zip>>attach:Public.Applications.Desktop.Public-Beta-Guide.WebHome@configuration-templates-beta3.zip||download="configuration-templates-beta3.zip"]] | ||
122 | |||
123 | |||
124 | {{id name="appfeatures"/}} | ||
125 | |||
126 | = App Features = | ||
127 | |||
128 | |||
129 | (% style="text-align:center; width:100%" %) | ||
130 | |=(% style="width: 25%;" %) |=(% style="text-align: center; width: 15%; background-color: rgb(155, 207, 239);" %)Desktop App (4.0.0) Beta |=(% style="text-align:center; width: 15%;" %)**Desktop App (3.4.2)** | ||
131 | |(% colspan="3" style="text-align:left" %)((( | ||
132 | == Login and Registration == | ||
133 | ))) | ||
134 | |(% style="text-align:left" %)Registeration via email and SMS|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
135 | |(% style="text-align:left" %)Login via password|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
136 | |(% style="text-align:left" %)Automated registration|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
137 | |(% style="text-align:left" %)Restrict registration via token|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
138 | |(% style="text-align:left" %)Logout|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
139 | |(% colspan="3" style="text-align:left" %)((( | ||
140 | == Inbox == | ||
141 | ))) | ||
142 | |(% style="text-align:left" %)Search for chat title / message / contact|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
143 | |(% style="text-align:left" %)Show / Hide archived chat|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
144 | |(% style="text-align:left" %)Set and use Push-to-Talk|(% style="background-color:#9bcfef" %) | | ||
145 | |(% colspan="3" style="text-align:left" %)((( | ||
146 | == Chats == | ||
147 | ))) | ||
148 | |(% style="text-align:left" %)1:1 chat / Group chat / Broadcast chat|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
149 | |(% style="text-align:left" %)Federated chats|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
150 | |(% style="text-align:left" %)Federated chats: Support for attention messages and Location Feature|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
151 | |(% style="text-align:left" %)Voice and video calls|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
152 | |(% style="text-align:left" %)Voice and video calls: Share screen / Raise hand / Join ongoing calls / Change background|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
153 | |(% style="text-align:left" %)Emergency Alert|(% style="background-color:#9bcfef" %) | | ||
154 | |(% style="text-align:left" %)Attention messages|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
155 | |(% style="text-align:left" %)Search for message|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
156 | |(% style="text-align:left" %)Delete message|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
157 | |(% style="text-align:left" %)Attachment: Image / Video / File / Voice message / Interactive (poll)|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
158 | |(% style="text-align:left" %)Attachment: Location / Live location|(% style="background-color:#9bcfef" %) | | ||
159 | |(% style="text-align:left" %)Viewing a live location: Enable / Disable to show a user’s name in the map view|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
160 | |(% style="text-align:left" %)Viewing a live location: Enable / Disable to show a user’s role in the map view |(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
161 | |(% style="text-align:left" %)Viewing a live location: Select a user to focus in the map view|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
162 | |(% style="text-align:left" %)Attachment: Calendar|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}} | ||
163 | will be attached as file|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
164 | will be attached as file | ||
165 | |(% style="text-align:left" %)Attachment: Share via Dracoon|(% style="background-color:#9bcfef" %) | | ||
166 | |(% style="text-align:left" %)Edit image before sending (incl. auto-blur)|(% style="background-color:#9bcfef" %) | | ||
167 | |(% style="text-align:left" %)Download and save attachment|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
168 | |(% style="text-align:left" %)Restrict saving attachment|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
169 | |(% style="text-align:left" %)Reply to message or attachment|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
170 | |(% style="text-align:left" %)Forward message or attachments to new or existing chat|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
171 | |(% style="text-align:left" %)Leave / Close / Mute / Archive chat|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
172 | |(% style="text-align:left" %)Show chat admins and members|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
173 | |(% style="text-align:left" %)Edit chat avatar / title / mode / members|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}} | ||
174 | edit chat avatar will follow|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
175 | |(% style="text-align:left" %)Promote members to chat admins|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
176 | |(% style="text-align:left" %)Media overview|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
177 | |(% style="text-align:left" %)Send chat by email|(% style="background-color:#9bcfef" %) | | ||
178 | |(% style="text-align:left" %)Print chat to PDF|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
179 | |(% style="text-align:left" %)System messages with time stamps|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
180 | |(% colspan="3" style="text-align:left" %)((( | ||
181 | == Directory == | ||
182 | ))) | ||
183 | |(% style="text-align:left" %)View contacts / lists / circles / bots|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}} | ||
184 | contact details will follow|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
185 | |(% style="text-align:left" %)View federated contacts / circles|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
186 | |(% style="text-align:left" %)Create / Manage / Delete lists|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
187 | |(% style="text-align:left" %)Search for users of other organisations|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
188 | |(% style="text-align:left" %)Create chat via a user's profile|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
189 | |(% style="text-align:left" %)Phone contact (external) via a user's profile|(% style="background-color:#9bcfef" %) | | ||
190 | |(% style="text-align:left" %)Start Teamwire voice and video calls via user's profile|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
191 | |(% style="text-align:left" %)Email contact (external) via a user's profile|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
192 | |(% colspan="3" style="text-align:left" %)((( | ||
193 | == Profile and Settings == | ||
194 | ))) | ||
195 | |(% style="text-align:left" %)Edit profile info and picture|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
196 | |(% style="text-align:left" %)Edit contact details (email and phone number)|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
197 | |(% style="text-align:left" %)Change password|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
198 | |(% style="text-align:left" %)Manage sessions|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
199 | |(% style="text-align:left" %)Enable auto-save received media|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
200 | |(% style="text-align:left" %)Manage read receipts|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
201 | |(% style="text-align:left" %)Manage notifications (sound, volume, pop-up)|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
202 | |(% style="text-align:left" %)Manage notification preview to others|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
203 | |(% style="text-align:left" %)Manage "Send message with Enter"|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
204 | |(% style="text-align:left" %)Configure proxy settings|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}} | ||
205 | during login only|{{velocity}}$services.icon.render('check'){{/velocity}} | ||
206 | |(% style="text-align:left" %)Configure custom certificate|(% style="background-color:#9bcfef" %) |{{velocity}}$services.icon.render('check'){{/velocity}} | ||
207 | |(% style="text-align:left" %)Passcode konfigurieren|(% style="background-color:#9bcfef" %) | | ||
208 | |(% style="text-align:left" %)Auto-close session after failing access code 3 times|(% style="background-color:#9bcfef" %){{velocity}}$services.icon.render('check'){{/velocity}}| | ||
209 | |(% style="text-align:left" %)Diagnose connection option|(% style="background-color:#9bcfef" %) | | ||
210 | |(% style="text-align:left" %)In-App delete account option (Public Cloud only)|(% style="background-color:#9bcfef" %) | | ||
211 | |||
212 | ## ## |