features.rst 6.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. ========
  2. Features
  3. ========
  4. .. contents:: Table of Contents
  5. :depth: 2
  6. :local:
  7. Off-the-record encryption
  8. =========================
  9. Converse.js supports `Off-the-record (OTR) <https://otr.cypherpunks.ca/>`_
  10. encrypted messaging.
  11. The OTR protocol not only **encrypts your messages**, it provides ways to
  12. **verify the identity** of the person you are talking to,
  13. **plausible deniability** and **perfect forward secrecy** by generating
  14. new encryption keys for each conversation.
  15. In its current state, Javascript cryptography is fraught with dangers and
  16. challenges that make it impossible to reach the same standard of security that
  17. is available with native "desktop" software.
  18. This is due to its runtime malleability, the way it is "installed" (e.g.
  19. served) and the browser's lack of cryptographic primitives needed to implement
  20. secure crypto.
  21. For harsh but fairly valid criticism of Javascript cryptography, read:
  22. `Javascript Cryptography Considered Harmful <http://www.matasano.com/articles/javascript-cryptography/>`_.
  23. To get an idea on how this applies to OTR support in Converse.js, please read
  24. `my thoughts on it <https://opkode.com/media/blog/2013/11/11/conversejs-otr-support>`_.
  25. For now, suffice to say that although its useful to have OTR support in
  26. Converse.js in order to avoid most eavesdroppers, if you need serious
  27. communications privacy, then you're much better off using native software.
  28. Sound Notifications
  29. ===================
  30. From version 0.8.1 Converse.js can play a sound notification when you receive a
  31. message.
  32. For more info, please see the :ref:`play-sounds` configuration setting.
  33. Multilingual Support
  34. ====================
  35. Converse.js is translated into multiple languages. The default build,
  36. ``converse.min.js``, includes all languages.
  37. Languages increase the size of the Converse.js significantly.
  38. If you only need one, or a subset of the available languages, it's better to
  39. make a custom build which includes only those languages that you need.
  40. Chat Rooms
  41. ==========
  42. Commands
  43. --------
  44. Here are the different commands that may be used in a chat room:
  45. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  46. | Event Type | When is it triggered? | Example (substitue $nickname with an actual user's nickname) |
  47. +============+==============================================================================================+===============================================================+
  48. | **ban** | Ban a user from the chat room. They will not be able to join again. | /ban $nickname |
  49. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  50. | **clear** | Clear the messages shown in the chat room. | /clear |
  51. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  52. | **deop** | Make a moderator a normal participant. | /deop $nickname [$reason] |
  53. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  54. | **help** | Show the list of available commands. | /help |
  55. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  56. | **kick** | Kick a user out of a room. They will be able to join again. | /kick $nickname [$reason] |
  57. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  58. | **me** | Speak in the 3rd person. | /me $message |
  59. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  60. | **mute** | Remove a user's ability to post messages to the room. They will still be able to observe. | /mute $nickname [$reason] |
  61. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  62. | **nick** | Change your nickname. | /nick $nickname |
  63. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  64. | **op** | Make a normal participant a moderator. | /op $nickname [$reason] |
  65. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  66. | **topic** | Set the topic of the chat room. | /topic ${topic text} |
  67. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
  68. | **voice** | Allow a muted user to post messages to the room. | /voice $nickname [$reason] |
  69. +------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+