1<h1 align="center">Conversations</h1>
2
3<p align="center">Conversations: the very last word in instant messaging</p>
4
5<p align="center">
6 <a href="https://conversations.im/j/conversations@conference.siacs.eu">
7 <img src="https://inverse.chat/badge.svg?room=conversations@conference.siacs.eu"
8 alt="chat on our conference room">
9 </a>
10 <a href="https://travis-ci.org/siacs/Conversations">
11 <img src="https://travis-ci.org/siacs/Conversations.svg?branch=master"
12 alt="build status">
13 </a>
14 <a href="https://bountysource.com/teams/siacs">
15 <img src="https://api.bountysource.com/badge/tracker?tracker_id=519483" alt="Bountysource">
16 </a>
17</p>
18
19<p align="center">
20 <a href="https://play.google.com/store/apps/details?id=eu.siacs.conversations&referrer=utm_source%3Dgithub">
21 <img src="https://conversations.im/images/en-play-badge.png"
22 alt="Google Play">
23 </a>
24 <a href="http://www.amazon.com/dp/B00WD35AAC/">
25 <img src="https://images-na.ssl-images-amazon.com/images/G/01/AmazonMobileApps/amazon-apps-store-us-black.png"
26 alt="Amazon App Store">
27 </a>
28</p>
29
30
31
32## Design principles
33
34* Be as beautiful and easy to use as possible without sacrificing security or
35 privacy
36* Rely on existing, well established protocols (XMPP)
37* Do not require a Google Account or specifically Google Cloud Messaging (GCM)
38
39## Features
40
41* End-to-end encryption with [OMEMO](http://conversations.im/omemo/) or [OpenPGP](http://openpgp.org/about/)
42* Send and receive images as well as other kind of files
43* Share your location
44* Send voice messages
45* Indication when your contact has read your message
46* Intuitive UI that follows Android Design guidelines
47* Pictures / Avatars for your Contacts
48* Synchronizes with desktop client
49* Conferences (with support for bookmarks)
50* Address book integration
51* Multiple accounts / unified inbox
52* Very low impact on battery life
53
54
55### XMPP Features
56
57Conversations works with every XMPP server out there. However XMPP is an
58extensible protocol. These extensions are standardized as well in so called
59XEP's. Conversations supports a couple of these to make the overall user
60experience better. There is a chance that your current XMPP server does not
61support these extensions; therefore to get the most out of Conversations you
62should consider either switching to an XMPP server that does or — even better —
63run your own XMPP server for you and your friends. These XEP's are:
64
65* [XEP-0065: SOCKS5 Bytestreams](http://xmpp.org/extensions/xep-0065.html) (or mod_proxy65). Will be used to transfer
66 files if both parties are behind a firewall (NAT).
67* [XEP-0163: Personal Eventing Protocol](http://xmpp.org/extensions/xep-0163.html) for avatars and OMEMO.
68* [XEP-0191: Blocking command](http://xmpp.org/extensions/xep-0191.html) lets you blacklist spammers or block contacts
69 without removing them from your roster.
70* [XEP-0198: Stream Management](http://xmpp.org/extensions/xep-0198.html) allows XMPP to survive small network outages and
71 changes of the underlying TCP connection.
72* [XEP-0280: Message Carbons](http://xmpp.org/extensions/xep-0280.html) which automatically syncs the messages you send to
73 your desktop client and thus allows you to switch seamlessly from your mobile
74 client to your desktop client and back within one conversation.
75* [XEP-0237: Roster Versioning](http://xmpp.org/extensions/xep-0237.html) mainly to save bandwidth on poor mobile connections
76* [XEP-0313: Message Archive Management](http://xmpp.org/extensions/xep-0313.html) synchronize message history with the
77 server. Catch up with messages that were sent while Conversations was
78 offline.
79* [XEP-0352: Client State Indication](http://xmpp.org/extensions/xep-0352.html) lets the server know whether or not
80 Conversations is in the background. Allows the server to save bandwidth by
81 withholding unimportant packages.
82* [XEP-0363: HTTP File Upload](http://xmpp.org/extensions/xep-0363.html) allows you to share files in conferences
83 and with offline contacts.
84
85## FAQ
86
87### General
88
89#### How do I install Conversations?
90
91Conversations is entirely open source and licensed under GPLv3. So if you are a
92software developer you can check out the sources from GitHub and use Gradle to
93build your apk file.
94
95The more convenient way — which not only gives you automatic updates but also
96supports the further development of Conversations — is to buy the App in the
97Google [Play Store](https://play.google.com/store/apps/details?id=eu.siacs.conversations&referrer=utm_source%3Dgithub).
98
99Buying the App from the Play Store will also give you access to our [beta test](#beta).
100
101#### I don't have a Google Account but I would still like to make a contribution
102
103I accept donations over PayPal, bank transfer and various crypto currencies. For donations via PayPal you
104can use the email address `donate@siacs.eu` or the button below.
105
106[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CW3SYT3KG5PDL)
107
108**Disclaimer:** I'm not a huge fan of PayPal and their business policies. For
109larger contributions please get in touch with me beforehand and we can talk
110about bank transfer (SEPA).
111
112##### Crypto currencies
113
114Bitcoin: `1AeqNAcg85APAZj9BZfAjdFCC5zesqXp2B`
115
116Bitcoin Cash: `16ABkXzYAwWz8Y5DcWFfbBRqL63g3hzEaU`
117
118Ether: `0x5c4e5239cd9c6f4a909e4e8361526e2e3c8ba9fa`
119
120#### How do I create an account?
121XMPP, like email, is a federated protocol, which means that there is not one company you can create an *official XMPP account* with. Instead there are hundreds, or even thousands, of providers out there. One of those providers is our very own [conversations.im](https://account.conversations.im). If you don’t like to use *conversations.im* use a web search engine of your choice to find another provider. Or maybe your university has one. Or you can run your own. Or ask a friend to run one. Once you've found one, you can use Conversations to create an account. Just select *register new account* on server within the create account dialog.
122
123##### Domain hosting
124Using your own domain not only gives you a more recognizable Jabber ID, it also gives you the flexibility to migrate your account between different XMPP providers. This is a good compromise between the responsibilities of having to operate your own server and the downsides of being dependent on a single provider.
125
126Learn more about [conversations.im Jabber/XMPP domain hosting](https://account.conversations.im/domain/).
127
128##### Running your own
129If you already have a server somewhere and are willing and able to put the necessary work in, one alternative-in the spirit of federation-is to run your own. We recommend either [Prosody](https://prosody.im/) or [ejabberd](https://www.ejabberd.im/). Both of which have their own strengths. Ejabberd is slightly more mature nowadays but Prosody is arguably easier to set up.
130
131For Prosody you need a couple of so called [community modules](https://modules.prosody.im/) most of which are maintained by the same people that develop Prosody.
132
133If you pick ejabberd make sure you use the latest version. Linux Distributions might bundle some very old versions of it.
134
135#### Where can I set up a custom hostname / port
136Conversations will automatically look up the SRV records for your domain name
137which can point to any hostname port combination. If your server doesn’t provide
138those please contact your admin and have them read
139[this](http://prosody.im/doc/dns#srv_records). If your server operator is unwilling
140to fix this you can enable advanced server settings in the expert settings of
141Conversations.
142
143#### I get 'Incompatible Server'
144
145As regular user you should be picking a different server. The server you selected
146is probably insecure and/or very old.
147
148If you are a server administrator you should make sure that your server provides
149either STARTTLS or [XEP-0368: SRV records for XMPP over TLS](https://xmpp.org/extensions/xep-0368.html).
150
151On rare occasions this error message might also be caused by a server not providing
152a login (SASL) mechanism that Conversations is able to handle. Conversations supports
153SCRAM-SHA1, PLAIN, EXTERNAL (client certs) and DIGEST-MD5.
154
155#### I get 'Bind failure'. What does that mean?
156
157Some Bind failures are transient and resolve themselves after a reconnect.
158
159When trying to connect to OpenFire the bind failure can be a permanent problem when the domain part of the Jabber ID entered in Conversations doesn’t match the domain the OpenFire server feels responsible for. For example OpenFire is configured to use the domain `a.tld` but the Jabber ID entered is `user@b.tld` where `b.tld` also points to the same host. During bind OpenFire tries to reassign the Jabber to `user@a.tld`. Conversations doesn’t like that.
160This can be fixed by creating a new account in Conversations that uses the Jabber ID `user@a.tld`.
161
162Note: This is kind of a weird quirk in OpenFire. Most other servers would just throw a 'Server not responsible for domain' error instead of attempting to reassign the Jabber ID.
163
164Maybe you attempted to use the Jabber ID `test@b.tld` because `a.tld` doesn’t point to the correct host. In that case you might have to enable the extended connection settings in the expert settings of Conversations and set a host name.
165
166### I get 'Stream opening error'. What does that mean?
167
168In most cases this error is caused by ejabberd advertising support for TLSv1.3 but not properly supporting it. This can happen if the openssl version on the server already supports TLSv1.3 but the fast\_tls wrapper library used by ejabberd not (properly) support it. Upgrading fast\_tls and ejabberd or - theoretically - downgrading openssl should fix the issue. A work around is to explicity disable TLSv1.3 support in the ejabberd configuration. More information can be found on [this issue on the ejabberd issue tracker](https://github.com/processone/ejabberd/issues/2614).
169
170
171#### I’m getting this annoying permanent notification
172Starting with Conversations 2.3.6 Conversations releases distributed over the Google Play Store will display a permanent notification if you are running it on Android 8 and above. This is a rule that it is essentially enforced by the Google Play Store. (You won’t have the problem of a *forced* foreground notification if you are getting your app from F-Droid.)
173
174However you can disable the notification via settings of the operating system. (Not settings in Conversations.)
175
176**The battery consumption and the entire behaviour of Conversations will remain the same (as good or as bad as it was before). Why is Google doing this to you? We have no idea.**
177
178##### Android <= 7.1
179The foreground notification is still controlled over the expert settings within Conversations as it always has been. Whether or not you need to enable it depends on how aggressive the non-standard 'power saving' features are that your phone vendor has built into the operating system.
180
181##### Android 8.x
182Long press the permanent notification and disable that particular type of notification by moving the slider to the left. This will make the notification disappear but create another notification (this time created by the operating system itself.) that will complain about Conversations (and other apps) using battery. Starting with Android 8.1 you can disable that notification again with the same method described above.
183
184##### Android 9.0+
185Long press the permanent notification and press the info `(i)` button to get into the App info screen. In that screen touch the 'Notification' entry. In the next screen remove the checkbox for the 'Foreground service' entry.
186
187#### How do XEP-0357: Push Notifications work?
188You need to be running the Play Store version of Conversations and your server needs to support push notifications.¹ Because *Google’s Firebase Cloud Messaging (FCM)* are tied with an API key to a specific app your server can not initiate the push message directly. Instead your server will send the push notification to the [Conversations App server](https://github.com/iNPUTmice/p2) (operated by us) which then acts as a proxy and initiates the push message for you. The push message sent from our App server through FCM doesn’t contain any personal information. It is just an empty message which will wake up your device and tell Conversations to reconnect to your server. The information sent from your server to our App server depends on the configuration of your server but can be limited to your account name. (In any case the Conversations App server won't redirect any information through FCM even if your server sends this information.)
189
190In summary Google will never get hold of any personal information besides that *something* happened. (Which doesn’t even have to be a message but can be some automated event as well.) We - as the operator of the App server - will just get hold of your account name (without being able to tie this to your specific device).
191
192If you don’t want this simply pick a server which does not offer Push Notifications or build Conversations yourself without support for push notifications. (This is available via a gradle build flavor.) Non-play store source of Conversations like the Amazon App store will also offer a version without push notifications. Conversations will just work as before and maintain its own TCP connection in the background.
193
194You can find a detailed description of how your server, the app server and FCM are interacting with each other in the [README](https://github.com/iNPUTmice/p2/blob/master/README.md) of the Conversations App Server.
195
196 ¹ Your server only needs to support the server side of [XEP-0357: Push Notifications](http://xmpp.org/extensions/xep-0357.html). If you use the Play Store version you do **not** need to run your own app server. The server modules are called *mod_cloud_notify* on Prosody and *mod_push* on ejabberd.
197
198
199#### But why do I need a permanent notification if I use Google Push?
200FCM (Google Push) allows an app to wake up from *Doze* which is (as the name suggests) a hibernation feature of the Android operating system that cuts the network connection and also reduces the number of times the app is allowed to wake up (to ping the server for example). The app can ask to be excluded from doze. Non push variants of the app (from F-Droid or if the server doesn’t support it) will do this on first start up. So if you get exemption from *Doze*, or if you get regular push events sent to you, Doze should not pose a threat to Conversatons working properly. But even with *Doze* the app is still open in the background (kept in memory); it is just limited in the actions it can do. Conversations needs to stay in memory to hold certain session state (online status of concats, join status of group chats, …). However with Android 8 Google changed all of this again and now an App that wants to stay in memory needs to have a foreground service which is visible to the user via the annoying notification. But why does Conversations need to hold that state? XMPP is a stateful protocol that has a lot of per-session information; packets need to be counted, presence information needs to be held, some features like Message Carbons get activated once per session, MAM catchup happens once, service discovery happens only once; the list goes on. When Conversations was created in early 2014 none of this was a problem because apps were just allowed to stay in memory. Basically every XMPP client out there holds that information in memory because it would be a lot more complicated trying to persist it to disk. An entire rewrite of Conversations in the year 2019 would attempt to do that and would probably succeed however it would require exactly that; a complete rewrite which is not feasible right now. That’s by the way also the reason why it is difficult to write an XMPP client on iOS. Or more broadly put this is also the reason why other protocols are designed as or migrated to stateless protocols (often based on HTTP); take for example the migration of IMAP to [JMAP](https://jmap.io/).
201
202#### Conversations doesn’t work for me. Where can I get help?
203
204You can join our conference room on `conversations@conference.siacs.eu`.
205A lot of people in there are able to answer basic questions about the usage of
206Conversations or can provide you with tips on running your own XMPP server. If
207you found a bug or your app crashes please read the Developer / Report Bugs
208section of this document.
209
210#### I need professional support with Conversations or setting up my server
211
212I'm available for hire. Contact me at `inputmice@siacs.eu`.
213
214#### How does the address book integration work?
215
216The address book integration was designed to protect your privacy. Conversations
217neither uploads contacts from your address book to your server nor fills your
218address book with unnecessary contacts from your online roster. If you manually
219add a Jabber ID to your phones address book Conversations will use the name and
220the profile picture of this contact. To make the process of adding Jabber IDs to
221your address book easier you can click on the profile picture in the contact
222details within Conversations. This will start an "add to address book" intent
223with the JID as the payload. This doesn't require Conversations to have write
224permissions on your address book but also doesn't require you to copy/paste a
225JID from one app to another.
226
227#### I get 'delivery failed' on my messages
228
229If you get delivery failed on images it's probably because the recipient lost
230network connectivity during reception. In that case you can try it again at a
231later time.
232
233For text messages the answer to your question is a little bit more complex.
234When you see 'delivery failed' on text messages, it is always something that is
235being reported by the server. The most common reason for this is that the
236recipient failed to resume a connection. When a client loses connectivity for a
237short time the client usually has a five minute window to pick up that
238connection again. When the client fails to do so because the network
239connectivity is out for longer than that all messages sent to that client will
240be returned to the sender resulting in a delivery failed.
241
242Instead of returning a message to the sender both ejabberd and prosody have the
243ability to store messages in offline storage when the disconnecting client is
244the only client. In prosody this is available via an extra module called
245```mod_smacks_offline```. In ejabberd this is available via some configuration
246settings.
247
248Other less common reasons are that the message you sent didn't meet some
249criteria enforced by the server (too large, too many). Another reason could be
250that the recipient is offline and the server doesn't provide offline storage.
251
252Usually you are able to distinguish between these two groups in the fact that
253the first one happens always after some time and the second one happens almost
254instantly.
255
256#### Where can I see the status of my contacts? How can I set a status or priority?
257
258Statuses are a horrible metric. Setting them manually to a proper value rarely
259works because users are either lazy or just forget about them. Setting them
260automatically does not provide quality results either. Keyboard or mouse
261activity as indicator for example fails when the user is just looking at
262something (reading an article, watching a movie). Furthermore automatic setting
263of status always implies an impact on your privacy (are you sure you want
264everybody in your contact list to know that you have been using your computer at
2654am‽).
266
267In the past status has been used to judge the likelihood of whether or not your
268messages are being read. This is no longer necessary. With Chat Markers
269(XEP-0333, supported by Conversations since 0.4) we have the ability to **know**
270whether or not your messages are being read. Similar things can be said for
271priorities. In the past priorities have been used (by servers, not by clients!)
272to route your messages to one specific client. With carbon messages (XEP-0280,
273supported by Conversations since 0.1) this is no longer necessary. Using
274priorities to route OTR messages isn't practical either because they are not
275changeable on the fly. Metrics like last active client (the client which sent
276the last message) are much better.
277
278Unfortunately these modern replacements for legacy XMPP features are not widely
279adopted. However Conversations should be an instant messenger for the future and
280instead of making Conversations compatible with the past we should work on
281implementing new, improved technologies and getting them into other XMPP clients
282as well.
283
284Making these status and priority optional isn't a solution either because
285Conversations is trying to get rid of old behaviours and set an example for
286other clients.
287
288#### Translations
289Translations are managed on [Transifex](https://www.transifex.com/projects/p/conversations/)
290
291#### How do I backup / move Conversations to a new device?
292On the one hand Conversations supports Message Archive Management to keep a server side history of your messages so when migrating to a new device that device can display your entire history. However that does not work if you enable OMEMO due to its forward secrecy. (Read [The State of Mobile XMPP in 2016](https://gultsch.de/xmpp_2016.html) especially the section on encryption.)
293
294If you migrate to a new device and would still like to keep your history please use a third party backup tool like [oandbackup](https://github.com/jensstein/oandbackup) (needs root access on the device) or ```adb backup``` (no root access needed) from your computer. It is important that you disable (NOT delete) your account before backup and enable it only after a successful restore, otherwise OMEMO might not work afterwards. Also, remember that you can **only** transfer the backup to either the same version of Android or to a newer one (eg. 5.1.1 -> 5.1.1 or 5.1.1 -> 6.0.1).
295
296#### Conversations is missing a certain feature
297
298I'm open for new feature suggestions. You can use the [issue tracker][issues] on
299GitHub. Please take some time to browse through the issues to see if someone
300else already suggested it. Be assured that I read each and every ticket. If I
301like it I will leave it open until it's implemented. If I don't like it I will
302close it (usually with a short comment). If I don't comment on an feature
303request that's probably a good sign because this means I agree with you.
304Commenting with +1 on either open or closed issues won't change my mind, nor
305will it accelerate the development.
306
307#### You closed my feature request but I want it really really badly
308
309Just write it yourself and send me a pull request. If I like it I will happily
310merge it if I don't at least you and like minded people get to enjoy it.
311
312#### I need a feature and I need it now!
313
314I am available for hire. Contact me via XMPP: `inputmice@siacs.eu`
315
316### Security
317
318#### Why are there two end-to-end encryption methods and which one should I choose?
319
320* OMEMO works even when a contact is offline, and works with multiple devices. It also allows asynchronous file-transfer when the server has [HTTP File Upload](http://xmpp.org/extensions/xep-0363.html). However, OMEMO not widely support and is currently implemented only [by a handful of clients](https://omemo.top).
321* OpenPGP (XEP-0027) is a very old encryption method that has some advantages over OMEMO but should only be used by people who know what they are doing.
322
323#### How do I use OpenPGP
324
325Before you continue reading you should note that the OpenPGP support in
326Conversations is experimental. This is not because it will make the app unstable
327but because the fundamental concepts of PGP aren't ready for widespread use.
328The way PGP works is that you trust Key IDs instead of JID's or email addresses.
329So in theory your contact list should consist of Public-Key-IDs instead of
330JID's. But of course no email or XMPP client out there implements these
331concepts. Plus PGP in the context of instant messaging has a couple of
332downsides: It is vulnerable to replay attacks and it is rather verbose.
333
334To use OpenPGP you have to install the open source app
335[OpenKeychain](http://www.openkeychain.org) and then long press on the account in
336manage accounts and choose renew PGP announcement from the contextual menu.
337
338#### OMEMO is grayed out. What do I do?
339OMEMO is only available in 1:1 chats and private (members-only, non-anonymous) group chats. Encrypting public group chats makes little to no sense since anyone (including a hypothetical attacker) can join and a user couldn’t possibily verify all participants anyway. Furthermore for a lot of public group chat it is desirable to give new comers access to the full history.
340
341#### OMEMO doesn’t work. I get a 'Something went wrong' message in the 'Trust OMEMO Fingerprints' screen.
342OMEMO has two requirements: Your server and the server of your contact need to support PEP. Both of you can verify that individually by opening your account details and selecting ```Server info``` from the menu. The appearing table should list PEP as available. The second requirement is that the initial sender needs to have access to the published key material. This can either be achieved by having mutual presence subscription (you can verify that by opening the contact details and see if both check boxes *Send presence updates* and *Receive presence updates* are checked) or by using a server that makes the public key material accessible to anyone. In the [Compliance Tester](https://compliance.conversations.im) this is indicated by the 'OMEMO' feature. Since it is very common that the first messages are exchanged *before* adding each other to the contact list it is desirable to use servers that have 'OMEMO support'.
343
344#### How does the encryption for group chats work?
345
346##### OMEMO
347
348OMEMO encryption works only in private (members only) conferences that are non-anonymous. Non-anonymous (being able to discover the real JID of other participants) is a technical requirement to discover the key material. Members only is a sort of arbitrary requirement imposed by Conversations. (see 'OMEMO is grayed out')
349
350The server of all participants need to pass the OMEMO [Compliance Test](https://conversations.im/compliance/).
351In other words they either need to run Ejabberd 18.01+ or Prosody 0.11+.
352
353(Alternatively it would also work if all participants had each other in their contact list; But that rarely is the case in larger group chats.)
354
355The owner of a conference can make a public conference private by going into the conference
356details and hit the settings button (the one with the gears) and select both *private* and
357*members only*.
358
359##### OpenPGP
360
361Every participant has to announce their OpenPGP key (see answer above).
362If you would like to send encrypted messages to a conference you have to make
363sure that you have every participant's public key in your OpenKeychain.
364Right now there is no check in Conversations to ensure that.
365You have to take care of that yourself. Go to the conference details and
366touch every key id (The hexadecimal number below a contact). This will send you
367to OpenKeychain which will assist you on adding the key. This works best in
368very small conferences with contacts you are already using OpenPGP with. This
369feature is regarded experimental. Conversations is the only client that uses
370XEP-0027 with conferences. (The XEP neither specifically allows nor disallows
371this.)
372
373#### What is Blind Trust Before Verification / why are messages marked with a red lock?
374
375Read more about the concept on https://gultsch.de/trust.html
376
377#### What happened to OTR support?
378OTR was removed because it was highly unreliable. It didn’t work with multiple devices and was never really specified to work with XMPP. The codebase was a mess (There was an HTML parser in there for crying out loud to deal with the garbage some OTR clients would send.) Verification was implemented in a non-blocking way. It would tell you if the current session was using an unknown fingerprint but it didn’t actively stopped you from sending messages until you have confirmed the new fingerprint. (Like Conversations would do now with BTBV after verification or when BTBV is turned off.) Considering the previous points there was little to no desire from my point to fix this potential security issue or clean up the code base. Another reason for the removal was that people would use it *accidentally* even to communicate between two Conversations clients because they read somewhere that OTR is good.
379
380OTR is still available in [Conversations Legacy](https://github.com/siacs/Conversations/tree/legacy).
381
382### What clients do I use on other platforms
383There are XMPP Clients available for all major platforms.
384#### Windows / Linux
385For your desktop computer we recommend that you use [Gajim](https://gajim.org). You need to install the plugins `OMEMO`, `HTTP Upload` and `URL image preview` to get the best compatibility with Conversations. Plugins can be installed from within the app.
386#### iOS
387Unfortunately we don‘t have a recommendation for iPhones right now. There are two clients available [ChatSecure](https://chatsecure.org/) and [Monal](https://monal.im/). Both with their own pros and cons.
388
389
390### Development
391
392<a name="beta"></a>
393#### Beta testing
394If you bought the App on [Google Play](https://play.google.com/store/apps/details?id=eu.siacs.conversations)
395you can get access to the the latest beta version by signing up using [this link](https://play.google.com/apps/testing/eu.siacs.conversations).
396
397#### How do I build Conversations
398
399Make sure to have ANDROID_HOME point to your Android SDK. Use the Android SDK Manager to install missing dependencies.
400
401 git clone https://github.com/siacs/Conversations.git
402 cd Conversations
403 ./gradlew assembleConversationsFreeSystemDebug
404
405There are two build flavors available. *free* and *playstore*. Unless you know what you are doing you only need *free*.
406
407
408[](https://travis-ci.org/siacs/Conversations)
409
410#### How do I update/add external libraries?
411
412If the library you want to update is in Maven Central or JCenter (or has its own
413Maven repo), add it or update its version in `build.gradle`. If the library is
414in the `libs/` directory, you can update it using a subtree merge by doing the
415following (using `minidns` as an example):
416
417 git remote add minidns https://github.com/rtreffer/minidns.git
418 git fetch minidns
419 git merge -s subtree minidns master
420
421To add a new dependency to the `libs/` directory (replacing "name", "branch" and
422"url" as necessary):
423
424 git remote add name url
425 git merge -s ours --no-commit name/branch
426 git read-tree --prefix=libs/name -u name/branch
427 git commit -m "Subtree merged in name"
428
429#### How do I debug Conversations
430
431If something goes wrong Conversations usually exposes very little information in
432the UI (other than the fact that something didn't work). However with adb
433(android debug bridge) you can squeeze some more information out of Conversations.
434These information are especially useful if you are experiencing trouble with
435your connection or with file transfer.
436
437To use adb you have to connect your mobile phone to your computer with an USB cable
438and install `adb`. Most Linux systems have prebuilt packages for that tool. On
439Debian/Ubuntu for example it is called `android-tools-adb`.
440
441Furthermore you might have to enable 'USB debugging' in the Developer options of your
442phone. After that you can just execute the following on your computer:
443
444 adb -d logcat -v time -s conversations
445
446If need be there are also some Apps on the PlayStore that can be used to show the logcat
447directly on your rooted phone. (Search for logcat). However in regards to further processing
448(for example to create an issue here on Github) it is more convenient to just use your PC.
449
450#### I found a bug
451
452Please report it to our [issue tracker][issues]. If your app crashes please
453provide a stack trace. If you are experiencing misbehavior please provide
454detailed steps to reproduce. Always mention whether you are running the latest
455Play Store version or the current HEAD. If you are having problems connecting to
456your XMPP server your file transfer doesn’t work as expected please always
457include a logcat debug output with your issue (see above).
458
459[issues]: https://github.com/siacs/Conversations/issues