OpenCloud
/
element-web
mirror of https://github.com/vector-im/element-web
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #2001 from vector-im/rav/fix_readme_lies 

Update encryption info in README
pull/2007/head
Richard van der Hoff 2016-08-24 10:22:38 +01:00 committed by GitHub
parent 9d77fab18f f2936dc15c
commit 5348b8a980
1 changed files with 9 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -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 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 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 To host your own copy of Vector, the quickest bet is to use a pre-built released version
of Vector: 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, for verifying third party identifiers like email addresses). If this is blank,
registering with an email address, adding an email address to your account, 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 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 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 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. 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 proof-of-concept. See https://matrix.org/jira/browse/SPEC-162 for an overview
of the current progress. of the current progress.
Vector is built with support for end-to-end encryption by default. 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
To enable encryption for a room, type 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
/encrypt on the option of enabling encryption. Any messages sent in that room will then be
``` encrypted.
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 Note that historical encrypted messages cannot currently be decoded - history
is therefore lost when the page is reloaded. is therefore lost when the page is reloaded.
There is currently no visual indication of whether encryption is enabled for a
room.