||3 years ago|
|.github||4 years ago|
|docs||4 years ago|
|electron_app||3 years ago|
|origin_migrator||4 years ago|
|res||4 years ago|
|scripts||3 years ago|
|src||3 years ago|
|test||4 years ago|
|.babelrc||5 years ago|
|.editorconfig||6 years ago|
|.eslintignore||6 years ago|
|.eslintrc.js||6 years ago|
|.gitignore||4 years ago|
|.modernizr.json||5 years ago|
|.npmignore||6 years ago|
|.travis.yml||3 years ago|
|AUTHORS.rst||5 years ago|
|CHANGELOG.md||3 years ago|
|CONTRIBUTING.rst||4 years ago|
|LICENSE||7 years ago|
|README.md||4 years ago|
|config.sample.json||4 years ago|
|karma.conf.js||4 years ago|
|package-lock.json||3 years ago|
|package.json||3 years ago|
|postcss.config.js||6 years ago|
|release.sh||4 years ago|
|release_config.yaml||6 years ago|
|webpack.config.js||3 years ago|
Riot (formerly known as Vector) is a Matrix web client built using the Matrix React SDK.
The easiest way to test Riot is to just use the hosted copy at https://riot.im/app.
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/riot-web/releases
- Untar the tarball on your web server
- Move (or symlink) the
riot-x.x.xdirectory 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!
Releases are signed by PGP, and can be checked against the public key at https://riot.im/packages/keys/riot.asc .
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.
Desktop Installation for Debian Stretch
- Add the repository to your sources.list using either of the following two options:
- Directly to sources.list:
echo "deb https://riot.im/packages/debian/ stretch main" | sudo tee -a /etc/apt/sources.list
- As a separate entry in sources.list.d:
echo "deb https://riot.im/packages/debian/ stretch main" | sudo tee /etc/apt/sources.list.d/riot.list
- Add the gpg signing key for the riot repository:
curl -s https://riot.im/packages/debian/repo-key.asc | sudo apt-key add -
- Update your package lists:
sudo apt-get update
- Install Riot:
sudo apt-get install riot-web
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/riot-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
nodeis at least v8.12.0 (and
npmis at least v5.x).
Clone the repo:
git clone https://github.com/vector-im/riot-web.git.
Switch to the riot-web directory:
Install the prerequisites:
If you're using the
developbranch then it is recommended to set up a proper development environment ("Setting up a dev environment" below) however one can install the develop versions of the dependencies instead:
Note that running
npm installwill undo the symlinks put in place by
scripts/fetch-develop.deps.shso you should run
npm installfirst, or run
npm link matrix-js-sdkand
npm link matrix-react-sdkafter running
Whenever you git pull on riot-web you will also probably need to force an update to these dependencies - the simplest way is to re-run the script, but you can also manually update and rebuild them:
cd matrix-js-sdk git pull npm install # re-run to pull in any new dependencies # Depending on your version of npm, npm run build may happen as part of # the npm install above (https://docs.npmjs.com/misc/scripts#prepublish-and-prepare) # If in doubt, run it anyway: npm run build cd ../matrix-react-sdk git pull npm install npm run build
Or just use https://riot.im/develop - the continuous integration release of the develop branch. (Note that we don't reference the develop versions in git directly due to https://github.com/npm/npm/issues/3055.)
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
webapp 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:
For a good example, see https://riot.im/develop/config.json.
default_server_namesets the default server name to use for authentication. This will trigger Riot to ask
https://<server_name>/.well-known/matrix/clientfor the homeserver and identity server URLs to use. This is the recommended approach for setting a default server. However, it is also possible to use the following to directly configure each of the URLs:
default_hs_urlsets the default homeserver URL.
default_is_urlsets 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 the future, identity servers will be decentralised.
- Riot will report an error if you accidentally configure both
default_hs_urlsince it's unclear which should take priority.
features: Lookup of optional features that may be
disabled, or exposed to the user in the
labssection of settings. The available optional experimental features vary from release to release.
brand: String to pass to your homeserver when configuring email notifications, to let the homeserver know what email template to use when talking to you.
branding: Configures various branding and logo details, such as:
welcomeBackgroundUrl: An image to use as a wallpaper outside the app during authentication flows
authHeaderLogoUrl: An logo image that is shown in the header during authentication flows
integrations_ui_url: URL to the web interface for the integrations server. The integrations server is not Riot and normally not your homeserver either. The integration server settings may be left blank to disable integrations.
integrations_rest_url: URL to the REST interface for the integrations server.
integrations_widgets_urls: list of URLs to the REST interface for the widget integrations server.
bug_report_endpoint_url: endpoint to send bug reports to (must be running a https://github.com/matrix-org/rageshake server). Bug reports are sent when a user clicks "Send Logs" within the application. Bug reports can be disabled by leaving the
bug_report_endpoint_urlout of your config file.
roomDirectory: config for the public room directory. This section is optional.
roomDirectory.servers: List of other homeservers' directories to include in the drop down list. Optional.
default_theme: name of theme to use by default (e.g. 'light')
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
win32(for update packages, not installer packages).
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:
https://usercontent.riot.im/v1.html. This needs to contain v1.html from https://github.com/matrix-org/usercontent/blob/master/v1.html
piwik: Analytics can be disabled by setting
piwik: falseor by leaving the piwik config option out of your config file. If you want to enable analytics, set
piwikto be an object containing the following properties:
url: The URL of the Piwik instance to use for collecting analytics
whitelistedHSUrls: a list of HS URLs to not redact from the analytics
whitelistedISUrls: a list of IS URLs to not redact from the analytics
siteId: The Piwik Site ID to use when sending analytics to the Piwik server configured above
welcomeUserId: the user ID of a bot to invite whenever users register that can give them a tour
embeddedPages: Configures the pages displayed in portions of Riot that embed static files, such as:
welcomeUrl: Initial content shown on the outside of the app when not logged in. Defaults to
welcome.htmlsupplied with Riot.
homeUrl: Content shown on the inside of the app when a specific room is not selected. By default, no home page is configured. If one is set, a button to access it will be shown in the top left menu.
index.html also has an og:image meta tag that is set to an image
hosted on riot.im. This is the image used if links to your copy of Riot
appear in some websites like Facebook, and indeed Riot itself. This has to be
static in the HTML and an absolute URL (and HTTP rather than HTTPS), so it's
not possible for this to be an option in config.json. If you'd like to change
it, you can build Riot as above, but run
RIOT_OG_IMAGE_URL="http://example.com/logo.png" npm run build.
Alternatively, you can edit the
og:image meta tag in
each time you download a new version of Riot.
Running as a Desktop app
Riot can also be run as a desktop app, wrapped in electron. You can download a pre-built version from https://riot.im/desktop.html or, if you prefer, build it yourself. Requires Electron >=1.6.0
To run as a desktop app:
Follow the instructions in 'Building From Source' above, but run
npm run buildinstead of
npm run dist(since we don't need the tarball).
Install electron and run it:
npm install electron npm run electron
To build packages, use electron-builder. This is configured to output:
debfor Linux But this can be customised by editing the
buildsection of package.json as per https://github.com/electron-userland/electron-builder/wiki/Options
See https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build for dependencies required for building packages for various platforms.
The only platform that can build packages for all three platforms is macOS:
brew install wine --without-x11 brew install mono brew install gnu-tar npm install npm run build:electron
For other packages, use electron-builder manually. For example, to build a package for 64 bit Linux:
- Follow the instructions in 'Building From Source' above
node_modules/.bin/build -l --x64
All electron packages go into
Many thanks to @aviraldg for the initial work on the electron integration.
Other options for running as a desktop app:
- @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/
Before attempting to develop on Riot you must read the developer guide
also defines the design, architecture and style for Riot too.
You should also familiarise yourself with the "Here be Dragons" guide to the tame & not-so-tame dragons (gotchas) which exist in the codebase.
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).
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 https://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 # see https://github.com/webpack/webpack/issues/1472 popd
Then similarly with
git clone https://github.com/matrix-org/matrix-react-sdk.git pushd matrix-react-sdk git checkout develop npm link ../matrix-js-sdk popd
Finally, build and start Riot itself:
git clone https://github.com/vector-im/riot-web.git cd riot-web git checkout develop npm install npm link ../matrix-js-sdk npm link ../matrix-react-sdk 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
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-js-sdk they should be
automatically picked up by webpack and built.
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.
Running the tests
There are a number of application-level tests in the
tests directory; these
are designed to run in a browser instance under the control of
karma. To run them:
- Make sure you have Chrome installed (a recent version, like 59)
- Make sure you have
matrix-react-sdkinstalled and built, as above
npm run test
The above will run the tests under Chrome in a
You can also tell karma to run the tests in a loop (every time the source
changes), in an instance of Chrome on your desktop, with
npm run test-multi. This also gives you the option of running the tests in 'debug'
mode, which is useful for stepping through the tests in the developer tools.
To add a new translation, head to the translating doc.
For a developer guide, see the translating dev doc.
Issues will be triaged by the core team using the below set of tags.
Tags are meant to be used in combination - e.g.:
- P1 critical bug == really urgent stuff that should be next in the bugfixing todo list
- "release blocker" == stuff which is blocking us from cutting the next release.
- P1 feature type:voip == what VoIP features should we be working on next?
- P1: top priority - i.e. pool of stuff which we should be working on next
- P2: still need to fix, but lower than P1
- P3: non-urgent
- P4: interesting idea - bluesky some day
- P5: recorded for posterity/to avoid duplicates. No intention to resolves right now.
bug or feature: compulsory
bug severity: compulsory, if bug
- critical - whole app doesn't work
- major - entire feature doesn't work
- minor - partially broken feature (but still usable)
- cosmetic - feature works functionally but UI/UX is broken
- type:* - refers to a particular part of the app; used to filter bugs on a given topic - e.g. VOIP, signup, timeline, etc.
additional categories (self-explanatory):
- release blocker
- ui/ux (think of this as cosmetic)
- network (specific to network conditions)
- platform specific
- blocked - whether this issue currently can't be progressed due to outside factors
- bounty? - proposal to be included in a bounty programme
- bounty - included in Status Open Bounty