Read by release script in js-sdk
|6 years ago|
|docs||7 years ago|
|electron||6 years ago|
|res||6 years ago|
|scripts||6 years ago|
|src||6 years ago|
|test||6 years ago|
|.babelrc||6 years ago|
|.gitignore||6 years ago|
|.modernizr.json||7 years ago|
|.npmignore||6 years ago|
|.travis.yml||6 years ago|
|AUTHORS.rst||6 years ago|
|CHANGELOG.md||6 years ago|
|CONTRIBUTING.rst||7 years ago|
|LICENSE||7 years ago|
|README.md||6 years ago|
|config.sample.json||6 years ago|
|karma.conf.js||6 years ago|
|package.json||6 years ago|
|release.sh||6 years ago|
|release_config.yaml||6 years ago|
|webpack.config.js||6 years ago|
Riot (formerly known as Vector) is a Matrix web client built using the Matrix React SDK (https://github.com/matrix-org/matrix-react-sdk).
The easiest way to test Riot is to just use the hosted copy at https://riot.im/app. The develop branch is continuously deployed by Jenkins at https://riot.im/develop for those who like living dangerously.
To host your own copy of Riot, the quickest bet is to use a pre-built released version of Riot:
- Download the latest version from https://github.com/vector-im/vector-web/releases
- Untar the tarball on your web server
- Move (or symlink) the vector-x.x.x directory to an appropriate name
- If desired, copy
config.jsonand edit it as desired. See below for details.
- Enter the URL into your browser and log into Riot!
Note that Chrome does not allow microphone or webcam access for sites served over http (except localhost), so for working VoIP you will need to serve Riot over https.
Important Security Note
We do not recommend running Riot from the same domain name as your Matrix homeserver. The reason is the risk of XSS (cross-site-scripting) vulnerabilities that could occur if someone caused Riot to load and render malicious user generated content from a Matrix API which then had trusted access to Riot (or other apps) due to sharing the same domain.
We have put some coarse mitigations into place to try to protect against this situation, but it's still not good practice to do it in the first place. See https://github.com/vector-im/vector-web/issues/1977 for more details.
Building From Source
Riot is a modular webapp built with modern ES6 and requires a npm build system to build.
- Install or update
node.jsso that your
npmis at least at version
- Clone the repo:
git clone https://github.com/vector-im/vector-web.git
- Switch to the vector-web directory:
- Install the prerequisites:
- If you are using the
developbranch of vector-web, you will probably need to rebuild one of the dependencies, due to https://github.com/npm/npm/issues/3055:
(cd node_modules/matrix-react-sdk && npm install)
- Configure the app by copying
config.jsonand modifying it (see below for details)
npm run distto build a tarball to deploy. Untaring this file will give a version-specific directory containing all the files that need to go on your web server.
npm run dist is not supported on Windows, so Windows users can run
npm run build, which will build all the necessary files into the
directory. The version of Riot will not appear in Settings without
using the dist script. You can then mount the
webapp directory on your
webserver to actually serve up the app, which is entirely static content.
You can configure the app by copying
config.json and customising it:
default_hs_urlis the default home server url.
default_is_urlis the default identity server url (this is the server used 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 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.
integrations_ui_url: URL to the web interface for the integrations server.
integrations_rest_url: URL to the REST interface for the integrations server.
roomDirectory: config for the public room directory. This section encodes behaviour on the room directory screen for filtering the list by server / network type and joining third party networks. This config section will disappear once APIs are available to get this information for home servers. This section is optional.
roomDirectory.servers: List of other Home Servers' directories to include in the drop down list. Optional.
roomDirectory.serverConfig: Config for each server in
roomDirectory.serverConfig.<server_name>.networks: List of networks (named in
roomDirectory.networks) to include for this server. Optional.
roomDirectory.networks: config for each network type. Optional.
roomDirectory.<network_type>.name: Human-readable name for the network. Required.
roomDirectory.<network_type>.protocol: Protocol as given by the server in
/_matrix/client/unstable/thirdparty/protocolsresponse. Required to be able to join this type of third party network.
roomDirectory.<network_type>.domain: Domain as given by the server in
/_matrix/client/unstable/thirdparty/protocolsresponse, if present. Required to be able to join this type of third party network, if present in
roomDirectory.<network_type>.portalRoomPattern: Regular expression matching aliases for portal rooms to locations on this network. Required.
roomDirectory.<network_type>.icon: URL to an icon to be displayed for this network. Required.
roomDirectory.<network_type>.example: Textual example of a location on this network, eg. '#channel' for an IRC network. Optional.
roomDirectory.<network_type>.nativePattern: Regular expression that matches a valid location on this network. This is used as a hint to the user to indicate when a valid location has been entered so it's not necessary for this to be exactly correct. Optional.
update_base_url(electron app only): HTTPS URL to a web server to download updates from. This should be the path to the directory containing
cross_origin_renderer_url: URL to a static HTML page hosting code to help display encrypted file attachments. This MUST be hosted on a completely separate domain to anything else since it is used to isolate the privileges of file attachments to this domain. Default:
usercontent.riot.im. This needs to contain v1.html from https://github.com/matrix-org/usercontent/blob/master/v1.html
Running as a Desktop app
In future we'll do an official distribution of Riot as an desktop app. Meanwhile, there are a few options:
@asdf:matrix.org points out that you can use nativefier and it just works(tm):
sudo npm install nativefier -g nativefier https://riot.im/app/
krisa has a dedicated electron project at https://github.com/krisak/vector-electron-desktop (although you should swap out the 'vector' folder for the latest vector tarball you want to run. Get a tarball from https://github.com/vector-im/vector-web/releases or build your own
- see Building From Source above).
There's also a (much) older electron distribution at https://github.com/stevenhammerton/vector-desktop
Before attempting to develop on Riot you must read the developer guide
matrix-react-sdk at https://github.com/matrix-org/matrix-react-sdk, which
also defines the design, architecture and style for Riot too.
The idea of Riot is to be a relatively lightweight "skin" of customisations on
top of the underlying
matrix-react-sdk provides both the
higher and lower level React components useful for building Matrix communication
apps using React.
After creating a new component you must run
npm run reskindex to regenerate
component-index.js for the app (used in future for skinning)
However, as of July 2016 this layering abstraction is broken due to rapid
development on Riot forcing
matrix-react-sdk to move fast at the expense of
maintaining a clear abstraction between the two. Hacking on Riot inevitably
means hacking equally on
matrix-react-sdk, and there are bits of
matrix-react-sdk behaviour incorrectly residing in the
(e.g. matrix-react-sdk specific CSS), and a bunch of Riot specific behaviour
matrix-react-sdk (grep for
riot). This separation problem will be
solved asap once development on Riot (and thus matrix-react-sdk) has
stabilised. Until then, the two projects should basically be considered as a
single unit. In particular,
matrix-react-sdk issues are currently filed
vector-web in github.
Please note that Riot is intended to run correctly without access to the public internet. So please don't depend on resources (JS libs, CSS, images, fonts) hosted by external CDNs or servers but instead please package all dependencies into Riot itself.
Setting up a dev environment
Much of the functionality in Riot is actually in the
matrix-js-sdk modules. It is possible to set these up in a way that makes it
easy to track the
develop branches in git and to make local changes without
having to manually rebuild each time.
First clone and build
git clone email@example.com:matrix-org/matrix-js-sdk.git
git checkout develop
npm install source-map-loader# because webpack is made of fail (https://github.com/webpack/webpack/issues/1472)
Then similarly with
git clone firstname.lastname@example.org:matrix-org/matrix-react-sdk.git
git checkout develop
rm -r node_modules/matrix-js-sdk; ln -s ../../matrix-js-sdk node_modules/
Finally, build and start Riot itself:
git clone email@example.com:vector-im/vector-web.git
git checkout develop
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/
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
Remember, the command will not terminate since it runs the web server and rebuilds source files when they change. This development server also disables caching, so do NOT use it in production.
Open http://127.0.0.1:8080/ in your browser to see your newly built Riot.
When you make changes to
matrix-react-sdk, you will need to run
npm run build in the relevant directory. You can do this automatically by instead
npm start in the 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 Riot skin, you will need to rebuild
the skin's index by running,
npm run reskindex.
If any of these steps error with,
file table overflow, you are probably on a mac
which has a very low limit on max open files. Run
ulimit -Sn 1024 and try again.
You'll need to do this in each new terminal you open before building Riot.
Issues will be triaged by the core team using the following primary set of tags:
priority: P1: top priority; typically blocks releases. P2: one below that P3: non-urgent P4/P5: bluesky some day, who knows.
bug or feature: bug severity: * cosmetic - feature works functionally but UI/UX is broken. * critical - whole app doesn't work * major - entire feature doesn't work * minor - partially broken feature (but still usable)
* release blocker * ui/ux (think of this as cosmetic) * network (specific to network conditions) * platform (platform specific)