Wiki source code of Public Beta Guide

Version 2.1 by teamwire001 on 2023/08/31 14:44

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