You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Matthew Hodgson 647c01fe2a where did this img symlink go? all iamges break without it... 7 years ago
docs Actually add the doc 7 years ago
src make tabcomplete items clickable 7 years ago
vector where did this img symlink go? all iamges break without it... 7 years ago
.gitignore Run the CSS through webpack so we can pull in CSS files from modules with require rather than symlinking into the node_module directory which is breaking people on different npm versions. 7 years ago
.modernizr.json Add objectfit and localstorage to browser features 7 years ago
.npmignore Tweak the example build process. Move example -> examples/trivial to we can have more than one. Update README appropriately. 7 years ago
AUTHORS.rst changelog, authors and contributing files 7 years ago
CHANGES.rst changelog 7 years ago
CONTRIBUTING.rst changelog, authors and contributing files 7 years ago
LICENSE Basic structure of a react SDK and start of an implementation. 7 years ago Add a link to E2E bug in the README 7 years ago
config.json Add config file for default hs/is urls 7 years ago
package.json Merge branch 'develop' into require-css 7 years ago
webpack.config.js Merge branch 'develop' into rav/olm 7 years ago


Vector is a Matrix web client built using the Matrix React SDK (

Getting started

  1. Install or update node.js so that your npm is at least at version 2.0.0
  2. Clone the repo: git clone
  3. Switch to the SDK directory: cd vector-web
  4. Install the prerequisites: npm install
  5. Start the development builder and a testing server: npm start
  6. Wait a few seconds for the initial build to finish.
  7. Open 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.

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


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 npm link to tell Vector about them:

  1. git clone
  2. cd matrix-react-sdk
  3. git checkout develop
  4. npm install
  5. npm run build
  6. npm start (to start the dev rebuilder)
  7. cd ../vector-web
  8. Link the react sdk package into the example: npm link path/to/your/react/sdk

Similarly, you may need to npm link path/to/your/js/sdk in your matrix-react-sdk directory.

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.

You may need to run npm i source-map-loader in matrix-js-sdk if you get errors about "Cannot resolve module 'source-map-loader'" due to shortcomings in webpack.


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 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 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.