Matrix Referenz Client (Web Version)

Go to file

David Baker 3f9f3e9d92 Merge pull request #998 from vector-im/rav/fix_the_sodding_deployment_instructions Update the README to give clearer dev instructions		2016-02-24 11:24:48 +00:00
deploy	Listen on 0.0.0.0 and not localhost	2016-02-03 13:20:07 +00:00
docs	Actually add the doc	2015-09-17 11:06:50 +01:00
src	Merge pull request #997 from vector-im/dbkr/fix_new_room_crash	2016-02-23 18:12:42 +00:00
vector	Merge pull request #556 from vector-im/notif_sync	2016-01-21 10:31:46 +00:00
.gitignore	Add 'package' script to build a webapp bundle for straight unzipping on a production server.	2016-02-10 15:35:06 +00:00
.modernizr.json	Add objectfit and localstorage to browser features	2015-10-29 15:56:03 +00:00
.npmignore	Tweak the example build process. Move example -> examples/trivial to we can have more than one. Update README appropriately.	2015-07-03 15:56:04 +01:00
AUTHORS.rst	changelog, authors and contributing files	2015-08-10 18:09:35 +01:00
CHANGES.rst	changelog	2015-10-28 18:37:53 +00:00
CONTRIBUTING.rst	changelog, authors and contributing files	2015-08-10 18:09:35 +01:00
LICENSE	Basic structure of a react SDK and start of an implementation.	2015-06-09 17:40:42 +01:00
README.md	formatting	2016-02-23 21:00:27 +00:00
config.json	Fix default hs url after it was broken in `77b45e72`	2016-02-22 17:07:26 +00:00
jenkins.sh	Dump vector/react/jssdk SHAs in filename	2016-02-02 17:03:48 +00:00
package.json	oops, add sanitize-html	2016-02-21 00:05:44 +00:00
webpack.config.js	Merge branch 'develop' into rav/olm	2015-12-03 18:28:50 +00:00

README.md

Vector/Web

Vector is a Matrix web client built using the Matrix React SDK (https://github.com/matrix-org/matrix-react-sdk).

Getting started

Install or update node.js so that your npm is at least at version 2.0.0
Clone the repo: git clone https://github.com/vector-im/vector-web.git
Switch to the SDK directory: cd vector-web
Install the prerequisites: npm install
Start the development builder and a testing server: npm start
Wait a few seconds for the initial build to finish.
Open http://127.0.0.1:8080/ in your browser to see your newly built Vector.

With npm start, any changes you make to the source files will cause a rebuild so your changes will show up when you refresh. This development server also disables caching, so do NOT use it in production.

For production use, run npm run build to build all the necessary files into the vector directory and run your own server.

Development

For simple tweaks, you can work on any of the source files within Vector with the setup above, and your changes will cause an instant rebuild.

However, all serious development on Vector happens on the develop branch. This typically depends on the develop snapshot versions of matrix-react-sdk and matrix-js-sdk too, which isn't handled by Vector's package.json. To get the right dependencies, check out the develop branches of these libraries and then use ln -s to tell Vector about them:

[Be aware that there may be problems with this process under npm version 3.]

First clone and build matrix-js-sdk:

git clone git@github.com:matrix-org/matrix-js-sdk.git
pushd matrix-js-sdk
git checkout develop
npm install
npm install source-map-loader # because webpack is made of fail
popd

Then similarly with matrix-react-sdk:

git clone git@github.com:matrix-org/matrix-react-sdk.git
pushd matrix-react-sdk
git checkout develop
npm install
rm -r node_modules/matrix-js-sdk; ln -s ../../matrix-js-sdk node_modules/
popd

Finally, build and start vector itself:

git clone git@github.com:vector-im/vector-web.git
cd vector-web
git checkout develop
npm install
rm -r node_modules/matrix-js-sdk; ln -s ../../matrix-js-sdk node_modules/
rm -r node_modules/matrix-react-sdk; ln -s ../../matrix-react-sdk node_modules/
npm start

Wait a few seconds for the initial build to finish; you should see something like:

Hash: b0af76309dd56d7275c8
Version: webpack 1.12.14
Time: 14533ms
         Asset     Size  Chunks             Chunk Names
     bundle.js   4.2 MB       0  [emitted]  main
    bundle.css  91.5 kB       0  [emitted]  main
 bundle.js.map  5.29 MB       0  [emitted]  main
bundle.css.map   116 kB       0  [emitted]  main
    + 1013 hidden modules

Open http://127.0.0.1:8080/ in your browser to see your newly built Vector.

When you make changes to matrix-js-sdk or matrix-react-sdk, you will need to run npm run build in the relevant directory. You can do this automatically by instead running npm start in each directory, to start a development builder which will watch for changes to the files and rebuild automatically.

If you add or remove any components from the Vector skin, you will need to rebuild the skin's index by running, npm run reskindex.

Deployment

Just run npm run build and then mount the vector directory on your webserver to actually serve up the app, which is entirely static content.

Enabling encryption

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. See https://matrix.org/jira/browse/SPEC-162 for an overview of the current progress.

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.