Went a bit wild on the README...

This commit is contained in:
Sam Whited 2014-10-19 22:16:41 -04:00
parent 268f790b4c
commit 843a978ca1

311
README.md
View File

@ -1,18 +1,21 @@
#Conversations # Conversations
Conversations: the very last word in instant messaging Conversations: the very last word in instant messaging
[![Google Play](http://developer.android.com/images/brand/en_generic_rgb_wo_45.png)](https://play.google.com/store/apps/details?id=eu.siacs.conversations) [![Google Play](http://developer.android.com/images/brand/en_generic_rgb_wo_45.png)](https://play.google.com/store/apps/details?id=eu.siacs.conversations)
![screenshots](https://raw.githubusercontent.com/siacs/Conversations/master/screenshots.png) ![screenshots](https://raw.githubusercontent.com/siacs/Conversations/master/screenshots.png)
##Design principles ## Design principles
* Be as beautiful and easy to use as possible without sacrificing security or * Be as beautiful and easy to use as possible without sacrificing security or
privacy privacy
* Rely on existing, well established protocols (XMPP) * Rely on existing, well established protocols (XMPP)
* Do not require a Google Account or specifically Google Cloud Messaging (GCM) * Do not require a Google Account or specifically Google Cloud Messaging (GCM)
* Require as few permissions as possible * Require as few permissions as possible
##Features ## Features
* End-to-end encryption with either [OTR](https://otr.cypherpunks.ca/) or [OpenPGP](http://www.openpgp.org/about_openpgp/) * End-to-end encryption with either [OTR](https://otr.cypherpunks.ca/) or [OpenPGP](http://www.openpgp.org/about_openpgp/)
* Sending and receiving images * Sending and receiving images
* Indication when your contact has read your message * Indication when your contact has read your message
@ -25,19 +28,22 @@ Conversations: the very last word in instant messaging
* Very low impact on battery life * Very low impact on battery life
###XMPP Features ### XMPP Features
Conversations works with every XMPP server out there. However XMPP is an extensible
protocol. These extensions are standardized as well in so called XEPs. Conversations works with every XMPP server out there. However XMPP is an
Conversations supports a couple of those to make the overall user experience better. There is a extensible protocol. These extensions are standardized as well in so called
chance that your current XMPP server does not support these extensions. XEP's. Conversations supports a couple of these to make the overall user
Therefore to get the most out of Conversations you should consider either switching to an experience better. There is a chance that your current XMPP server does not
XMPP server that does or — even better — run your own XMPP server for you and support these extensions; therefore to get the most out of Conversations you
your friends. should consider either switching to an XMPP server that does or — even better —
These XEPs are - as of now: run your own XMPP server for you and your friends. These XEP's are:
* XEP-0065: SOCKS5 Bytestreams (or rather mod_proxy65). Will be used to transfer files if both parties are behind a firewall (NAT).
* XEP-0065: SOCKS5 Bytestreams (or mod_proxy65). Will be used to transfer
files if both parties are behind a firewall (NAT).
* XEP-0138: Stream Compression saves bandwidth * XEP-0138: Stream Compression saves bandwidth
* XEP-0163: Personal Eventing Protocol for avatars * XEP-0163: Personal Eventing Protocol for avatars
* XEP-0198: Stream Management allows XMPP to survive small network outages and changes of the underlying TCP connection. * XEP-0198: Stream Management allows XMPP to survive small network outages and
changes of the underlying TCP connection.
* XEP-0280: Message Carbons which automatically syncs the messages you send to * XEP-0280: Message Carbons which automatically syncs the messages you send to
your desktop client and thus allows you to switch seamlessly from your mobile your desktop client and thus allows you to switch seamlessly from your mobile
client to your desktop client and back within one conversation. client to your desktop client and back within one conversation.
@ -46,22 +52,28 @@ These XEPs are - as of now:
Conversations is in the background. Allows the server to save bandwidth by Conversations is in the background. Allows the server to save bandwidth by
withholding unimportant packages. withholding unimportant packages.
##Team ## Team
####Head of Development
#### Head of Development
* [Daniel Gultsch](https://github.com/inputmice) * [Daniel Gultsch](https://github.com/inputmice)
####Code Contributions #### Code Contributions
(In order of appearance) (In order of appearance)
* [Rene Treffer](https://github.com/rtreffer) * [Rene Treffer](https://github.com/rtreffer)
* [Andreas Straub](https://github.com/strb) * [Andreas Straub](https://github.com/strb)
* [Alethea Butler](https://github.com/alethea) * [Alethea Butler](https://github.com/alethea)
* [M. Dietrich](https://github.com/emdete) * [M. Dietrich](https://github.com/emdete)
* [betheg](https://github.com/betheg) * [betheg](https://github.com/betheg)
####Logo #### Logo
* [Diego Turtulici](http://efesto.eigenlab.org/~diesys) * [Diego Turtulici](http://efesto.eigenlab.org/~diesys)
####Translations #### Translations
* [Sergio Cárdenas](https://github.com/kruks23) (Spanish) * [Sergio Cárdenas](https://github.com/kruks23) (Spanish)
* [Benoit Bouvarel](https://github.com/BenoitBouvarel) (French) * [Benoit Bouvarel](https://github.com/BenoitBouvarel) (French)
* [Daniel Gultsch](https://github.com/iNPUTmice) (German) * [Daniel Gultsch](https://github.com/iNPUTmice) (German)
@ -71,180 +83,215 @@ These XEPs are - as of now:
* [Anders Sandblad](https://github.com/andersruneson) (Swedish) * [Anders Sandblad](https://github.com/andersruneson) (Swedish)
* [Aizaz AZ](http://www.linkedin.com/in/aizazhaider) (Chinese) * [Aizaz AZ](http://www.linkedin.com/in/aizazhaider) (Chinese)
##FAQ ## FAQ
###General
####How do I install Conversations? ### General
#### How do I install Conversations?
Conversations is entirely open source and licensed under GPLv3. So if you are a Conversations is entirely open source and licensed under GPLv3. So if you are a
software developer you can check out the sources from github and use ant to software developer you can check out the sources from GitHub and use ant to
build your apk file. build your apk file.
The more convenient way - which not only gives you automatic updates but also The more convenient way — which not only gives you automatic updates but also
supports the further development of Conversations - is to buy the App in the Google supports the further development of Conversations - is to buy the App in the
[Play Store](https://play.google.com/store/apps/details?id=eu.siacs.conversations). Google [Play Store](https://play.google.com/store/apps/details?id=eu.siacs.conversations).
####I don't have a Google Account but I would still like to make a contribution
I accept donations over PayPal, BitCoin and Flattr. For donations via PayPal you can use the email address donate@siacs.eu or the button below. #### I don't have a Google Account but I would still like to make a contribution
I accept donations over PayPal, Bitcoin and Flattr. For donations via PayPal you
can use the email address `donate@siacs.eu` or the button below.
[![Donate with PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CW3SYT3KG5PDL) [![Donate with PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CW3SYT3KG5PDL)
**Disclaimer:** I'm not a huge fan of PayPal and their business policies. For larger **Disclaimer:** I'm not a huge fan of PayPal and their business policies. For
contributions please get in touch with me beforehand and we can talk about bank larger contributions please get in touch with me beforehand and we can talk
transfer (SEPA). about bank transfer (SEPA).
My Bitcoin Address is: 1NxSU1YxYzJVDpX1rcESAA3NJki7kRgeeu My Bitcoin Address is: `1NxSU1YxYzJVDpX1rcESAA3NJki7kRgeeu`
[![Flattr this!](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=inputmice&url=http%3A%2F%2Fconversations.siacs.eu&title=Conversations&tags=github&category=software) [![Flattr this!](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=inputmice&url=http%3A%2F%2Fconversations.siacs.eu&title=Conversations&tags=github&category=software)
####How do I create an account? #### How do I create an account?
XMPP like email for example is a federated protocol which means that there is
not one company you can create your 'official xmpp account' with but there are
hundreds or even thousands of provider out there. To find one use a web search
engine of your choice. Or maybe your university has one. Or you can run your own.
Or ask a friend to run one. Once you found one you can use Conversations to
create an account. Just select 'register new account on server' within the
create account dialog.
####Conversations doesn't work for me. Where can I get help? XMPP, like email, is a federated protocol which means that there is not one
You can join our conference room on conversations@conference.siacs.eu A lot of company you can create an 'official XMPP account' with. Instead there are
hundreds, or even thousands, of provider out there. To find one use a web search
engine of your choice. 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.
#### Conversations doesn't work for me. Where can I get help?
You can join our conference room on `conversations@conference.siacs.eu` A lot of
people in there are able to answer basic questions about the usage of people in there are able to answer basic questions about the usage of
Conversations or can provide you with tips on running your own XMPP server. If Conversations or can provide you with tips on running your own XMPP server. If
you found a bug or your app crashes please read the Developer / Report Bugs you found a bug or your app crashes please read the Developer / Report Bugs
section of this document. section of this document.
####I need professional support with Conversations or setting up my server #### I need professional support with Conversations or setting up my server
I'm available for hire. Contact me at inputmice@siacs.eu
####How does the address book integration work? I'm available for hire. Contact me at `inputmice@siacs.eu`.
The address bock integration was designed to protect your privacy. Conversations
#### How does the address book integration work?
The address book integration was designed to protect your privacy. Conversations
neither uploads contacts from your address book to your server nor fills your neither uploads contacts from your address book to your server nor fills your
address book with unnecessary contacts from your online roster. If you manually address book with unnecessary contacts from your online roster. If you manually
add a Jabber ID to your phones address book Conversations will use the name and add a Jabber ID to your phones address book Conversations will use the name and
the profile picture of this contact. To make the process of adding Jabber IDs to the profile picture of this contact. To make the process of adding Jabber IDs to
your address book easier you can click on the profile picture in the contact your address book easier you can click on the profile picture in the contact
details within Conversations. This will start an add to address book intent with the jabber ID details within Conversations. This will start an "add to address book" intent
as payload. This doesnt require Conversations to have write permissions on your with the JID as the payload. This doesn't require Conversations to have write
address book but also doesnt require you to copy past Jabber ID from one app to permissions on your address book but also doesn't require you to copy/paste a
another. JID from one app to another.
####I get 'delivery failed' on my messages #### I get 'delivery failed' on my messages
If you get delivery failed on images its probably because the recipient lost
If you get delivery failed on images it's probably because the recipient lost
network connectivity during reception. In that case you can try it again at a network connectivity during reception. In that case you can try it again at a
later time. later time.
For text messages the answer to your question is a little bit more complex. For text messages the answer to your question is a little bit more complex.
'delivery failed' on text messages is always something that is being reported by When you see 'delivery failed' on text messages, it is always something that is
the server. The most common reason for this is that the recipient failed to being reported by the server. The most common reason for this is that the
resume a connection. When a client loses connectivity for a short time the recipient failed to resume a connection. When a client loses connectivity for a
client usually has a five minute window to pick up that connection again. When short time the client usually has a five minute window to pick up that
the client fails to do so because the network connectivity is out for longer connection again. When the client fails to do so because the network
than that all messages sent to that client will be returned to the sender connectivity is out for longer than that all messages sent to that client will
resulting in a delivery failed. be returned to the sender resulting in a delivery failed.
Other less common reasons are that the message you sent didnt meet some Other less common reasons are that the message you sent didn't meet some
criteria enforced by the server. (Too large, too many) Another reason could be criteria enforced by the server (too large, too many). Another reason could be
that the recipient is offline and the server doesnt provide offline storage. that the recipient is offline and the server doesn't provide offline storage.
Usually you are able to distinguish between these two groups in the fact that Usually you are able to distinguish between these two groups in the fact that
the first one happens always after some time and the second one happens almost the first one happens always after some time and the second one happens almost
instantly. instantly.
####Where can I see the status of my contacts? How can I set a status or priority #### Where can I see the status of my contacts? How can I set a status or priority?
Status are a horrible metric. Setting them manually to a proper value rarely
Statuses are a horrible metric. Setting them manually to a proper value rarely
works because users are either lazy or just forget about them. Setting them works because users are either lazy or just forget about them. Setting them
automatically does not provide quality results either. Keyboard or mouse automatically does not provide quality results either. Keyboard or mouse
activity as indicator for example fails when the user is just looking at activity as indicator for example fails when the user is just looking at
something (reading an article, watching a movie). Furthermore automatic setting something (reading an article, watching a movie). Furthermore automatic setting
of status always implies an impact on your privacy. (Are you sure you want of status always implies an impact on your privacy (are you sure you want
everybody in your contact list to know that you have been using your computer at everybody in your contact list to know that you have been using your computer at
4am?!) 4am‽).
In the past status has been used to judge the likelihood of whether or not your In the past status has been used to judge the likelihood of whether or not your
messages are being read. This is no longer necessary. With Chat Markers messages are being read. This is no longer necessary. With Chat Markers
(XEP-0333, supported by Conversations since 0.4) we have the ability to **know** (XEP-0333, supported by Conversations since 0.4) we have the ability to **know**
whether or not your messages are being read. whether or not your messages are being read. Similar things can be said for
Similar things can be said for priorities. In the past priorities have been used priorities. In the past priorities have been used (by servers, not by clients!)
(By servers, not by clients!) to route your messages to one specific client. to route your messages to one specific client. With carbon messages (XEP-0280,
With carbon messages (XEP-0280, supported by Conversations since 0.1) this is no supported by Conversations since 0.1) this is no longer necessary. Using
longer necessary. Using priorities to route OTR messages isn't practical either priorities to route OTR messages isn't practical either because they are not
because they are not changeable on the fly. Metrics like last active client changeable on the fly. Metrics like last active client (the client which sent
(the client which sent the last message) are much better. the last message) are much better.
Unfortunately these modern replacements for legacy XMPP features are not widely Unfortunately these modern replacements for legacy XMPP features are not widely
adopted. However Conversations should be an instant messenger for the future and adopted. However Conversations should be an instant messenger for the future and
instead of making Conversations compatible with the past we should work on instead of making Conversations compatible with the past we should work on
implementing new, improved technologies into other XMPP clients as well. implementing new, improved technologies and getting them into other XMPP clients
as well.
Making these status and priority optional isn't a solution either because Making these status and priority optional isn't a solution either because
Conversations is trying to get rid of old behaviours and set an example for Conversations is trying to get rid of old behaviours and set an example for
other clients. other clients.
####Conversations is missing a certain feature #### Conversations is missing a certain feature
I'm open for new feature suggestions. You can use the issue tracker on Github.
Please take some time to browse through the issues to see if someone else I'm open for new feature suggestions. You can use the [issue tracker][issues] on
already suggested it. Be assured that I read each and every ticket. If I like it GitHub. Please take some time to browse through the issues to see if someone
I will leave it open until it's implemented. If I don't like it I will close else already suggested it. Be assured that I read each and every ticket. If I
it. (Usually with a short comment). If I don't comment on an feature request like it I will leave it open until it's implemented. If I don't like it I will
that's probably a good sign because this means I agree with you. Commenting with close it (usually with a short comment). If I don't comment on an feature
+1 on either open or closed issues won't change my mind nor will it accelerate the request that's probably a good sign because this means I agree with you.
development. Commenting with +1 on either open or closed issues won't change my mind, nor
will it accelerate the development.
#### You closed my feature request but I want it really really badly
####You closed my feature request but I want it really really badly
Just write it yourself and send me a pull request. If I like it I will happily Just write it yourself and send me a pull request. If I like it I will happily
merge it if I don't at least you and like minded people get to enjoy it. merge it if I don't at least you and like minded people get to enjoy it.
####I need a feature and I need it now! #### I need a feature and I need it now!
I am available for hire. Contact me JID: inputmice@siacs.eu
###Security I am available for hire. Contact me via XMPP: `inputmice@siacs.eu`
####Why are there two end-to-end encryption methods and which one should I choose?
In most cases OTR should be the encryption method of choice. It works out of the box with most contacts as long as they are online.
However PGP can be in some cases (carbonated messages to multiple clients) be
more flexible.
####How do I use openPGP
Before you continue reading you should notice that the openPGP support in
Conversations is marked as experimental. This is not because it will make the app
unstable but because the fundamental concepts of PGP aren't ready for a
widespread use. The way PGP works is that you trust Key IDs instead of XMPP- or email addresses. So in theory your contact list should consist of Public-Key-IDs instead of email addresses. But of course no email or xmpp client out there implements these concepts. Plus PGP in the context of instant messaging has a couple of downsides. It is vulnerable to replay attacks, it is rather verbose, and decrypting and encrypting takes longer than OTR. It is however asynchronous and works well with carbonated messages.
To use openpgp you have to install the opensource app OpenKeychain (www.openkeychain.org) and then long press on the account in manage accounts and choose renew PGP announcement from the contextual menu. ### Security
####How does the encryption for conferences work?
For conferences the only supported encryption method is OpenPGP. (OTR does not #### Why are there two end-to-end encryption methods and which one should I choose?
work with multiple participants.) Every participant has to announce their
OpenPGP key. (See answer above). If you would like to send encrypted messages to In most cases OTR should be the encryption method of choice. It works out of the
box with most contacts as long as they are online. However PGP can, in some
cases, (message carbons to multiple clients) be more flexible.
#### How do I use OpenPGP
Before you continue reading you should note that the OpenPGP support in
Conversations is experimental. This is not because it will make the app unstable
but because the fundamental concepts of PGP aren't ready for widespread use.
The way PGP works is that you trust Key IDs instead of JID's or email addresses.
So in theory your contact list should consist of Public-Key-IDs instead of
JID's. But of course no email or XMPP client out there implements these
concepts. Plus PGP in the context of instant messaging has a couple of
downsides: It is vulnerable to replay attacks, it is rather verbose, and
decrypting and encrypting takes longer than OTR. It is however asynchronous and
works well with message carbons.
To use OpenPGP you have to install the open source app
[OpenKeychain](www.openkeychain.org) and then long press on the account in
manage accounts and choose renew PGP announcement from the contextual menu.
#### How does the encryption for conferences work?
For conferences the only supported encryption method is OpenPGP (OTR does not
work with multiple participants). Every participant has to announce their
OpenPGP key (see answer above). If you would like to send encrypted messages to
a conference you have to make sure that you have every participant's public key a conference you have to make sure that you have every participant's public key
in your OpenKeychain. Right now there is no check in Conversations to ensure in your OpenKeychain. Right now there is no check in Conversations to ensure
that. You have to take care of that yourself. Go to the conference details and that. You have to take care of that yourself. Go to the conference details and
touch every key id (The hexadecimal number below a contact). This will send you touch every key id (The hexadecimal number below a contact). This will send you
to OpenKeychain which will assist you on adding the key. to OpenKeychain which will assist you on adding the key. This works best in
This works best in very small conferences with contacts you are already using very small conferences with contacts you are already using OpenPGP with. This
OpenPGP with. This feature is regarded experimental. Conversations is the only feature is regarded experimental. Conversations is the only client that uses
client that uses XEP-0027 with conferences. (The XEP neither specifically allows XEP-0027 with conferences. (The XEP neither specifically allows nor disallows
nor disallows this.) this.)
###Development
####How do I build Conversations ### Development
#### How do I build Conversations
Make sure to have ANDROID_HOME point to your Android SDK Make sure to have ANDROID_HOME point to your Android SDK
```
git clone https://github.com/siacs/Conversations.git git clone https://github.com/siacs/Conversations.git
cd Conversations cd Conversations
git submodule update --init --recursive git submodule update --init --recursive
ant clean ant clean
ant debug ant debug
```
####How do I debug Conversations #### How do I debug Conversations
If something goes wrong Conversations usually exposes very little information in If something goes wrong Conversations usually exposes very little information in
the UI. (Other than the fact that something didn't work) the UI (other than the fact that something didn't work). However with adb
However with adb (android debug bridge) you squeeze some more information out of (android debug bridge) you squeeze some more information out of Conversations.
Conversations. These information are especially useful if you are experiencing These information are especially useful if you are experiencing trouble with
troubles with your connection or with file transfer. your connection or with file transfer.
````
adb -d logcat -v time -s conversations adb -d logcat -v time -s conversations
````
####I found a bug #### I found a bug
Please report it to our issue tracker. If your app crashes please provide a
stack trace. If you are experiencing misbehaviour please provide detailed Please report it to our [issue tracker][issues]. If your app crashes please
steps to reproduce. provide a stack trace. If you are experiencing misbehaviour please provide
Always mention whether you are running the latest Play Store version or the detailed steps to reproduce. Always mention whether you are running the latest
current HEAD. Play Store version or the current HEAD. If you are having problems connecting to
If you are having problems connecting to your XMPP server your file transfer your XMPP server your file transfer doesnt work as expected please always
doesnt work as expected please always include a logcat debug output with your include a logcat debug output with your issue (see above).
issue. (See above)
[issues]: https://github.com/siacs/Conversations/issues