From f2936dc15ca78078b1f1fb7258def5f40d541192 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 23 Aug 2016 18:07:07 +0100 Subject: [PATCH] Update encryption info in README --- README.md | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a940da64d..ee60bce7a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Getting Started The easiest way to test Vector is to just use the hosted copy at https://vector.im/beta. The develop branch is continuously deployed by Jenkins at https://vector.im/develop for -those who like living dangerously. +those who like living dangerously. To host your own copy of Vector, the quickest bet is to use a pre-built released version of Vector: @@ -55,7 +55,7 @@ You can configure the app by copying `vector/config.sample.json` to for verifying third party identifiers like email addresses). If this is blank, registering with an email address, adding an email address to your account, or inviting users via email address will not work. Matrix identity servers are - very simple web services which map third party identifiers (currently only email + very simple web services which map third party identifiers (currently only email addresses) to matrix IDs: see http://matrix.org/docs/spec/identity_service/unstable.html for more details. Currently the only public matrix identity servers are https://matrix.org and https://vector.im. In future identity servers will be decentralised. @@ -216,20 +216,13 @@ day-to-day use; it is experimental and should be considered only as a proof-of-concept. See https://matrix.org/jira/browse/SPEC-162 for an overview of the current progress. -Vector is built with support for end-to-end encryption by default. - -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`.) +To enable the (very experimental) support, check the 'End-to-End Encryption' +box in the 'Labs' section of the user settings (note that the labs are disabled +on http://vector.im/beta: you will need to use http://vector.im/develop or your +own deployment of vector). The Room Settings dialog will then show an +'Encryption' setting; rooms for which you are an administrator will offer you +the option of enabling encryption. Any messages sent in that room will then be +encrypted. 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.