From dfd03566094a1229a37796159db2f7b48fae9ac8 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Thu, 20 Oct 2016 16:54:30 +0100 Subject: [PATCH 01/13] s/vector/riot/ in the readme Also remove the outdated "E2E" section Fixes https://github.com/vector-im/vector-web/issues/2457 --- README.md | 105 +++++++++++++++++++++++------------------------------- 1 file changed, 44 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 6b819cce53..5b96cb56d3 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,55 @@ -Vector/Web -========== +Riot +==== -Vector is a Matrix web client built using the Matrix React SDK (https://github.com/matrix-org/matrix-react-sdk). +Riot (formerly known as Vector) is a Matrix web client built using the Matrix +React SDK (https://github.com/matrix-org/matrix-react-sdk). Getting Started =============== -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 -those who like living dangerously. +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 Vector, the quickest bet is to use a pre-built released version -of Vector: +To host your own copy of Riot, the quickest bet is to use a pre-built +released version of Riot: 1. Download the latest version from https://vector.im/packages/ 1. Untar the tarball on your web server 1. Move (or symlink) the vector-x.x.x directory to an appropriate name 1. If desired, copy `config.sample.json` to `config.json` and edit it as desired. See below for details. -1. Enter the URL into your browser and log into vector! +1. Enter the URL into your browser and log into Riot! Important Security Note ======================= -We do not recommend running Vector 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 Vector to load and render malicious user generated -content from a Matrix API which then had trusted access to Vector (or other apps) due -to sharing the same domain. +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. +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 ==================== -Vector is a modular webapp built with modern ES6 and requires a npm build system to build. +Riot is a modular webapp built with modern ES6 and requires a npm build system +to build. 1. Install or update `node.js` so that your `npm` is at least at version `2.0.0` 1. Clone the repo: `git clone https://github.com/vector-im/vector-web.git` -1. Switch to the vector directory: `cd vector-web` +1. Switch to the vector-web directory: `cd vector-web` 1. Install the prerequisites: `npm install` -1. If you are using the `develop` branch of vector, 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)` -1. Configure the app by copying `config.sample.json` to `config.json` and modifying - it (see below for details) +1. If you are using the `develop` branch 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)` +1. Configure the app by copying `config.sample.json` to `config.json` and + modifying it (see below for details) 1. `npm run package` to 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. @@ -102,14 +105,14 @@ You can configure the app by copying `vector/config.sample.json` to Running as a Desktop app ======================== -In future we'll do an official distribution of Vector as an desktop app. Meanwhile, +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://vector.im/beta/ +nativefier https://riot.im/app/ ``` krisa has a dedicated electron project at https://github.com/krisak/vector-electron-desktop @@ -123,11 +126,11 @@ There's also a (much) older electron distribution at https://github.com/stevenha Development =========== -Before attempting to develop on Vector you **must** read the developer guide +Before attempting to develop on Ruit you **must** read the developer guide for `matrix-react-sdk` at https://github.com/matrix-org/matrix-react-sdk, which -also defines the design, architecture and style for Vector too. +also defines the design, architecture and style for Riot too. -The idea of Vector is to be a relatively lightweight "skin" of customisations on +The idea of Riot is to be a relatively lightweight "skin" of customisations on top of the underlying `matrix-react-sdk`. `matrix-react-sdk` provides both the higher and lower level React components useful for building Matrix communication apps using React. @@ -136,26 +139,26 @@ After creating a new component you must run `npm run reskindex` to regenerate the `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 Vector forcing `matrix-react-sdk` to move fast at the expense of -maintaining a clear abstraction between the two.** Hacking on Vector inevitably +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 `vector-web` project -(e.g. matrix-react-sdk specific CSS), and a bunch of Vector specific behaviour -in the `matrix-react-sdk` (grep for Vector). This separation problem will be -solved asap once development on Vector (and thus matrix-react-sdk) has +(e.g. matrix-react-sdk specific CSS), and a bunch of Riot specific behaviour +in the `matrix-react-sdk` (grep for `vector` / `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 against `vector-web` in github. -Please note that Vector is intended to run correctly without access to the public +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 Vector itself. +into Riot itself. Setting up a dev environment ============================ -Much of the functionality in Vector is actually in the `matrix-react-sdk` and +Much of the functionality in Riot is actually in the `matrix-react-sdk` and `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. @@ -178,7 +181,7 @@ Then similarly with `matrix-react-sdk`: 1. `rm -r node_modules/matrix-js-sdk; ln -s ../../matrix-js-sdk node_modules/` 1. `popd` -Finally, build and start vector itself: +Finally, build and start Riot itself: 1. `git clone git@github.com:vector-im/vector-web.git` 1. `cd vector-web` @@ -203,19 +206,19 @@ Finally, build and start vector itself: 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. -1. Open http://127.0.0.1:8080/ in your browser to see your newly built Vector. +1. 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 running `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 Vector skin, you will need to rebuild +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 vector. +You'll need to do this in each new terminal you open before building Riot. Filing issues ============= @@ -247,23 +250,3 @@ bug or feature: * network (specific to network conditions) * platform (platform specific) - -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 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 -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 -the option of enabling encryption. Any messages sent in that room will then be -encrypted. - -Note that historical encrypted messages cannot currently be decoded - history -is therefore lost when the page is reloaded. - From d72323bfc551bc81238cbf2e018bcb0bd41bc834 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Thu, 20 Oct 2016 17:05:44 +0100 Subject: [PATCH 02/13] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5b96cb56d3..59c0036511 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ There's also a (much) older electron distribution at https://github.com/stevenha Development =========== -Before attempting to develop on Ruit you **must** read the developer guide +Before attempting to develop on Riot you **must** read the developer guide for `matrix-react-sdk` at https://github.com/matrix-org/matrix-react-sdk, which also defines the design, architecture and style for Riot too. From 9310d9260590975fb229fd60adab3e7a06bfb054 Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 21 Oct 2016 14:59:13 +0100 Subject: [PATCH 03/13] document integrations config in README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 59c0036511..a0f2a6c86c 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,8 @@ You can configure the app by copying `vector/config.sample.json` to 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. +1. `integrations_ui_url`: URL to the web interface for the integrations server. +1. `integrations_rest_url`: URL to the REST interface for the integrations server. 1. `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 From e0556789d2f52d5236d04590e8adbde873bab1b9 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 25 Oct 2016 11:20:23 +0100 Subject: [PATCH 04/13] readme tweaks Note that Chrome requires https for voip (fixes #2506) Remove lies about where issues are filed. --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a0f2a6c86c..180bcff5ce 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,10 @@ released version of Riot: as desired. See below for details. 1. 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 ======================= @@ -222,12 +226,6 @@ If any of these steps error with, `file table overflow`, you are probably on a m 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. -Filing issues -============= - -All issues for Vector-web and Matrix-react-sdk should be filed at -https://github.com/matrix-org/matrix-react-sdk/issues - Triaging issues =============== From df94dd74872f027cee8ae36cf100ab7750926395 Mon Sep 17 00:00:00 2001 From: David Baker Date: Tue, 25 Oct 2016 14:41:02 +0100 Subject: [PATCH 05/13] Update ChangelogDialog.js --- src/components/views/dialogs/ChangelogDialog.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/views/dialogs/ChangelogDialog.js b/src/components/views/dialogs/ChangelogDialog.js index e4a85f6106..6bc6de60fe 100644 --- a/src/components/views/dialogs/ChangelogDialog.js +++ b/src/components/views/dialogs/ChangelogDialog.js @@ -44,7 +44,7 @@ export default class ChangelogDialog extends React.Component { _elementsForCommit(commit) { return (
  • - + {commit.commit.message}
    • From 61d7db6eb614ba9e0f5ca534abdbdbfe4ff7000b Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 26 Oct 2016 10:35:46 +0100 Subject: [PATCH 06/13] Correct text alignment on room directory search Seemed to only be broken on firefox --- src/skins/vector/css/vector-web/structures/RoomDirectory.css | 1 + 1 file changed, 1 insertion(+) diff --git a/src/skins/vector/css/vector-web/structures/RoomDirectory.css b/src/skins/vector/css/vector-web/structures/RoomDirectory.css index fdf88e346d..563b1772c9 100644 --- a/src/skins/vector/css/vector-web/structures/RoomDirectory.css +++ b/src/skins/vector/css/vector-web/structures/RoomDirectory.css @@ -62,6 +62,7 @@ limitations under the License. .mx_RoomDirectory_searchbox { display: table-cell; + vertical-align: middle; } .mx_RoomDirectory_listheader .mx_NetworkDropdown { From fcf683c8a7e18d2233d6454aa44f3825ecc226b8 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Wed, 26 Oct 2016 14:13:36 +0100 Subject: [PATCH 07/13] Use webpack to copy olm.js Rather than copying olm.js ourselves in package.json, get webpack to do it for us by declaring it as a second entry point. --- .gitignore | 2 +- package.json | 20 +++++++++----------- webpack.config.js | 23 ++++++++++++++++++----- 3 files changed, 28 insertions(+), 17 deletions(-) diff --git a/.gitignore b/.gitignore index 200fa33dd1..2806eedff1 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,6 @@ /vector/components.css /vector/emojione/ /vector/config.json -/vector/olm.js +/vector/olm.* .DS_Store npm-debug.log diff --git a/package.json b/package.json index dee6ecced4..d6a631707b 100644 --- a/package.json +++ b/package.json @@ -16,21 +16,19 @@ "build:modernizr": "modernizr -c .modernizr.json -d src/vector/modernizr.js", "build:css": "catw \"src/skins/vector/css/**/*.css\" -o vector/components.css --no-watch", "build:compile": "babel --source-maps -d lib src", - "build:bundle": "NODE_ENV=production webpack -p lib/vector/index.js vector/bundle.js", - "build:bundle:dev": "webpack --optimize-occurence-order lib/vector/index.js vector/bundle.js", - "build:staticfiles": "cpx -v node_modules/olm/olm.js vector/", - "build": "node scripts/babelcheck.js && npm run build:staticfiles && npm run build:emojione && npm run build:css && npm run build:compile && npm run build:bundle", - "build:dev": "npm run build:staticfiles && npm run build:emojione && npm run build:css && npm run build:compile && npm run build:bundle:dev", + "build:bundle": "NODE_ENV=production webpack -p --progress", + "build:bundle:dev": "webpack --optimize-occurence-order --progress", + "build": "node scripts/babelcheck.js && npm run build:emojione && npm run build:css && npm run build:bundle", + "build:dev": "npm run build:emojione && npm run build:css && npm run build:bundle:dev", "package": "scripts/package.sh", "start:emojione": "cpx \"node_modules/emojione/assets/svg/*\" vector/emojione/svg/ -w", - "start:js": "webpack -w src/vector/index.js vector/bundle.js", - "start:js:prod": "NODE_ENV=production webpack -w src/vector/index.js vector/bundle.js", + "start:js": "webpack -w --progress", + "start:js:prod": "NODE_ENV=production webpack -w --progress", "start:skins:css": "catw \"src/skins/vector/css/**/*.css\" -o vector/components.css", - "start:staticfiles": "cpx -Lwv node_modules/olm/olm.js vector/", "//cache": "Note the -c 1 below due to https://code.google.com/p/chromium/issues/detail?id=508270", - "start": "node scripts/babelcheck.js && parallelshell \"npm run start:staticfiles\" \"npm run start:emojione\" \"npm run start:js\" \"npm run start:skins:css\" \"http-server -c 1 vector\"", - "start:prod": "parallelshell \"npm run start:staticfiles\" \"npm run start:emojione\" \"npm run start:js:prod\" \"npm run start:skins:css\" \"http-server -c 1 vector\"", - "clean": "rimraf lib vector/olm.js vector/bundle.css vector/bundle.js vector/bundle.js.map vector/webpack.css* vector/emojione", + "start": "node scripts/babelcheck.js && parallelshell \"npm run start:emojione\" \"npm run start:js\" \"npm run start:skins:css\" \"http-server -c 1 vector\"", + "start:prod": "parallelshell \"npm run start:emojione\" \"npm run start:js:prod\" \"npm run start:skins:css\" \"http-server -c 1 vector\"", + "clean": "rimraf lib vector/olm.* vector/bundle.* vector/emojione", "prepublish": "npm run build:css && npm run build:compile", "test": "karma start --single-run=true --autoWatch=false --browsers PhantomJS --colors=false", "test:multi": "karma start" diff --git a/webpack.config.js b/webpack.config.js index 95afcfba98..4d5747f689 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -3,6 +3,18 @@ var webpack = require('webpack'); var ExtractTextPlugin = require("extract-text-webpack-plugin"); module.exports = { + entry: { + "bundle": "./src/vector/index.js", + + // We ship olm.js as a separate lump of javascript. This makes it get + // loaded via a separate - - + <% for(var i=0; i + + <% } %>