@@ -90,7 +90,7 @@ to build.
9090 npm install
9191 npm run build
9292 ```
93- Or just use https://riot.im/develop - the continuous integration release of the
93+ Or just use https://riot.im/develop - the continuous integration release of the
9494 develop branch. (Note that we don't reference the develop versions in git directly
9595 due to https://github.com/npm/npm/issues/3055 .)
96961 . Install the prerequisites: ` npm install ` .
@@ -134,7 +134,9 @@ For a good example, see https://riot.im/develop/config.json
1341341 . ` integrations_rest_url ` : URL to the REST interface for the integrations server.
1351351 . ` integrations_widgets_urls ` : list of URLs to the REST interface for the widget integrations server.
1361361 . ` bug_report_endpoint_url ` : endpoint to send bug reports to (must be running a
137- https://github.com/matrix-org/rageshake server)
137+ https://github.com/matrix-org/rageshake server). Bug reports are sent when a user clicks
138+ "Send Logs" within the application. Bug reports can be disabled by leaving the
139+ ` bug_report_endpoint_url ` out of your config file.
1381401 . ` roomDirectory ` : config for the public room directory. This section is optional.
1391411 . ` roomDirectory.servers ` : List of other homeservers' directories to include in the drop
140142 down list. Optional.
@@ -147,11 +149,13 @@ For a good example, see https://riot.im/develop/config.json
147149 anything else since it is used to isolate the privileges of file attachments to this
148150 domain. Default: ` https://usercontent.riot.im/v1.html ` . This needs to contain v1.html from
149151 https://github.com/matrix-org/usercontent/blob/master/v1.html
150- 1 . ` piwik ` : an object containing the following properties:
151- 1 . ` url ` : The URL of the Piwik instance to use for collecting Analytics
152- 1 . ` whitelistedHSUrls ` : a list of HS URLs to not redact from the Analytics
153- 1 . ` whitelistedISUrls ` : a list of IS URLs to not redact from the Analytics
154- 1 . ` siteId ` : The Piwik Site ID to use when sending Analytics to the Piwik server configured above
152+ 1 . ` piwik ` : Analytics can be disabled by setting ` piwik: false ` or by leaving the piwik config
153+ option out of your config file. If you want to enable analytics, set ` piwik ` to be an object
154+ containing the following properties:
155+ 1 . ` url ` : The URL of the Piwik instance to use for collecting analytics
156+ 1 . ` whitelistedHSUrls ` : a list of HS URLs to not redact from the analytics
157+ 1 . ` whitelistedISUrls ` : a list of IS URLs to not redact from the analytics
158+ 1 . ` siteId ` : The Piwik Site ID to use when sending analytics to the Piwik server configured above
1551591 . ` teamServerConfig ` , ` teamTokenMap ` , ` referralBaseUrl ` : an obsolete precursor to communities
156160 with referral tracking; please ignore it.
1571611 . ` welcomeUserId ` : the user ID of a bot to invite whenever users register that can give them a tour
@@ -230,6 +234,10 @@ Before attempting to develop on Riot you **must** read the developer guide
230234for ` matrix-react-sdk ` at https://github.com/matrix-org/matrix-react-sdk , which
231235also defines the design, architecture and style for Riot too.
232236
237+ You should also familiarise yourself with the "Here be Dragons" guide to the
238+ tame & not-so-tame dragons (gotchas) which exist in the codebase:
239+ https://docs.google.com/document/d/12jYzvkidrp1h7liEuLIe6BMdU0NUjndUYI971O06ooM
240+
233241The idea of Riot is to be a relatively lightweight "skin" of customisations on
234242top of the underlying ` matrix-react-sdk ` . ` matrix-react-sdk ` provides both the
235243higher and lower level React components useful for building Matrix communication
@@ -270,7 +278,7 @@ Then similarly with `matrix-react-sdk`:
270278
271279Finally, build and start Riot itself:
272280
273- 1 . ` git clone git@ github.com: vector-im/riot-web.git `
281+ 1 . ` git clone https:// github.com/ vector-im/riot-web.git `
2742821 . ` cd riot-web `
2752831 . ` git checkout develop `
2762841 . ` npm install `
0 commit comments