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