From 759e35003bcd74d2574c17b9bc5477e9d0b50dac Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 4 Dec 2015 15:39:39 +0000 Subject: [PATCH] Put some warnings on the crypto stuff --- README.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d13a2cc9..7417391c 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,27 @@ actually serve up the app, which is entirely static content. Enabling encryption =================== -To build a version of vector with the (experimental) support for end-to-end -encryption, install the olm module with `npm i -https://matrix.org/packages/npm/olm/olm-0.1.0.tgz` before running `npm -start`. The olm library will be detected and used if available. +End-to-end encryption in Vector and Matrix is not yet considered ready for +day-to-day use; it is experimental and should be considered only as a +proof-of-concept. + +To build a version of vector with support for end-to-end encryption, install +the olm module with `npm i https://matrix.org/packages/npm/olm/olm-0.1.0.tgz` +before running `npm start`. The olm library will be detected and used if +available. + +To enable encryption for a room, type + +``` +/encrypt on +``` + +in the message bar in that room. Vector will then generate a set of keys, and +encrypt all outgoing messages in that room. (Note that other people in that +room will send messages in the clear unless they also `/encrypt on`.) + +Note that historical encrypted messages cannot currently be decoded - history +is therefore lost when the page is reloaded. + +There is currently no visual indication of whether encryption is enabled for a +room, or whether a particular message was encrypted.