Commit graph

227 commits

Author SHA1 Message Date
Travis Ralston
9790cac065 Merge branch 'develop' into michaelkaye/readme_updates_caching 2019-11-24 21:52:35 -07:00
J. Ryan Stinnett
2c0559dbea Remove mention of CI scripts from docs
This removes `fetch-develop.deps.sh` from the docs, as it's designed more for
use on CI environments and ends up causing confusion when used for anything
else.

Fixes https://github.com/vector-im/riot-web/issues/11247
2019-10-29 10:37:36 +00:00
Bruno Windels
a3a8da1746 provide deep link to e2e instructions in react sdk 2019-10-21 14:13:57 +02:00
Bruno Windels
d1a5376dae clarify where the e2e tests are located 2019-10-10 16:54:52 +02:00
Michael Kohler
9e27cb713f Add config.json copy instruction to 'Development' as well 2019-10-06 13:04:20 +02:00
Travis Ralston
f97b632c65
Merge pull request #6146 from rugk/patch-1
Clarify that HTTPS is not just needed for VoIP
2019-09-01 09:31:34 -06:00
rugk
658c5b42be
Update README.md
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2019-09-01 13:41:21 +02:00
rugk
f7bab88079
Improve exceptions mention
In addition to fixes from review, also add link to official source with more information.
2019-08-27 22:28:15 +02:00
J. Ryan Stinnett
b93388f504 Restore config.json section for old Riot
Riot includes a link to the config.json section of the README, so let's restore
it (at least for a while) keep that link working.
2019-06-28 13:50:54 +01:00
J. Ryan Stinnett
73d801cb1d Extract configuration docs to separate file
The main README is very busy with too much information in one file. This
attempts to clean up one portion by moving configuration docs to a separate
file.

Fixes https://github.com/vector-im/riot-web/issues/9965
2019-06-27 19:08:33 +01:00
Travis Ralston
42be1d633c Do not fail on server liveliness checks during startup
Also warn about deprecated config option usage.

See https://github.com/vector-im/riot-web/issues/9828
2019-06-04 23:44:33 -06:00
Travis Ralston
cafae31827 Add docs for defaultCountryCode 2019-05-31 21:23:58 -06:00
Travis Ralston
98f2d865b9 Add 'showLabsSettings' flag to docs+sample config 2019-05-30 20:03:42 -06:00
J. Ryan Stinnett
734d8a8151 Clarify Electron steps 2019-05-24 11:28:12 +01:00
Travis Ralston
ab6ba0e0d8 Add some clarity to the config options 2019-05-03 11:06:32 -06:00
Travis Ralston
f08491cee8 Validate default homeserver config before loading the app
Implements the process described here: https://github.com/vector-im/riot-web/issues/9290#issuecomment-481966910

The expectation is that later layers (like the react-sdk) will make use of the `validated_discovery_config` option instead of interpreting the config themselves.

We intentionally block the UI from loading here to avoid races between discovery and the app loading.
2019-05-03 11:06:32 -06:00
Travis Ralston
9957149115
Merge pull request #9426 from vector-im/travis/dockerfile-continued
Add Dockerfile (part 2)
2019-05-01 10:42:21 -06:00
Richard van der Hoff
cc5911b4aa
Remove redundant and incorrect riot-desktop install instructions (#9558) 2019-04-25 13:22:32 +01:00
axel simon
434e8cc937
Changed the Debian repo key and public key URLs 2019-04-16 21:03:53 +02:00
axel simon
6c950593b7
the repo key filename changed, reflecting this 2019-04-16 17:58:54 +02:00
David Baker
147f77f1dc Update README.md
better wording

Co-Authored-By: axelsimon <github@axelsimon.net>
2019-04-16 17:55:49 +02:00
axel simon
261974e9eb
update installation instructions with new repo
change mentions of https://riot.im/packages to https://packages.riot.im
add instructions to remove old, now-untrusted riot.im signing key
update language and move from 'apt-get` to the simpler `apt`
2019-04-16 13:53:59 +02:00
Travis Ralston
a263ca8cb3 Add USE_CUSTOM_SDKS to docs 2019-04-10 15:51:06 -06:00
Travis Ralston
eeae5dbcad Add docs for the Docker image 2019-04-10 15:47:12 -06:00
pacien
2c9b51f29d Add support for custom profile directory
A custom user data directory can now be specified using the "profile-dir"
command line argument.

Github ref: closes #6175

Signed-off-by: Pacien TRAN-GIRARD <pacien.trangirard@pacien.net>
2019-04-09 19:35:14 +02:00
Andrew Morgan
8a48d9e86b
Remove vector-electron-desktop from README
The repo (https://github.com/iskrisis/vector-electron-desktop) very clearly states not to use it anymore.
2019-04-08 17:11:58 +01:00
Jonas Jelten
5a051824c0 configure auth footer links through sdkconfig
Signed-off-by: Jonas Jelten <jelten@in.tum.de>
2019-03-28 12:32:10 +01:00
Ben Parsons
d098857d5a wrap text and link from README.md 2019-03-22 14:49:44 +00:00
Travis Ralston
abb6bee44d
Merge pull request #9177 from vector-im/travis/browser-support-docs
Declare the officially supported browsers in the README
2019-03-15 12:04:17 -06:00
J. Ryan Stinnett
faa9932c77
Merge pull request #9011 from vector-im/t3chguy/local-config
Document some desktop app things
2019-03-15 17:53:55 +00:00
J. Ryan Stinnett
95611d2c12
Update README.md grammar 2019-03-15 17:53:20 +00:00
Travis Ralston
631fcb0ad2 Cross-promote mobile apps 2019-03-15 11:43:00 -06:00
Travis Ralston
e47728e0e4 Declare the officially supported browsers in the README
Fixes https://github.com/vector-im/riot-web/issues/8701
2019-03-14 12:59:57 -06:00
J. Ryan Stinnett
fcaf0a5503 Recommend using the latest Node LTS version 2019-03-13 10:54:36 +00:00
J. Ryan Stinnett
1312ba537a Update scripts and docs to use yarn where appropriate
Most `npm` operations are replaced with `yarn`, which generally has better
behavior. However, steps like publish that write to the NPM registry are left to
`npm`, which currently handles these tasks best.
2019-03-12 11:06:57 +00:00
Michael Telatynski
01becf00f5 Try and improve README
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2019-03-01 08:01:26 +00:00
J. Ryan Stinnett
2dc26b4c5d Document and recommend default_server_name
This the recommended way to define a default server (instead of the existing HS
and IS URL options). It will use `.well-known` discovery to find the URLs.

See https://github.com/vector-im/riot-web/issues/8763.
2019-02-20 16:08:58 +00:00
Michael Kaye
8b598e5565
Update README.md
Fix formatting
2019-02-15 12:49:26 +00:00
Michael Kaye
f9551ddff5 Add note in README about self-hosted riot installs requiring custom riot headers.
Copy the list of headers from the current matrix.org list
2019-02-15 12:43:47 +00:00
David Baker
a6edf66109 Fix order of fetch-develop-deps / npm install
It's possible this git fixed in the CI scripts but not the README.
Running `npm install` undoes the npm linking, so this needs to be
run before fetch-develop-deps.
2019-02-13 13:09:03 +00:00
J. Ryan Stinnett
678904dcfb Allow configuring auth header logo 2019-02-11 16:29:50 +00:00
J. Ryan Stinnett
86ced4cdad Allow configuring welcome background image 2019-02-11 16:15:04 +00:00
J. Ryan Stinnett
4c877f118d Document embeddedPages configuration 2019-02-11 09:29:17 +00:00
Julien Jerphanion
dd01a398b6 Syntax Coloring
Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>
2019-02-10 10:15:28 +01:00
J. Ryan Stinnett
5030410dd6
Merge pull request #8381 from aaronraimist/electron-browser-zoom+
Allow Electron to zoom with CommandOrControl+=
2019-02-07 08:22:45 +00:00
Aaron Raimist
bfdffc653e
Allow Electron to zoom with CommandOrControl+=
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2019-02-02 15:53:10 -06:00
J. Ryan Stinnett
3eb550a15c Spell homeserver correctly 2019-01-31 18:52:49 -06:00
J. Ryan Stinnett
2d360eab74 Remove support for team servers 2019-01-25 16:14:04 -06:00
Remi Rampin
f7bdc9339c Make clear that the Debian package is for desktop 2018-12-19 21:05:21 +00:00
Matthew Hodgson
af4d3da7a8 link to Here Be Dragons 2018-10-11 10:29:28 +01:00
Travis Ralston
3286acd306
Use HTTPS cloning for riot-web too 2018-10-04 11:23:42 -06:00
Aaron Raimist
eabcc9261d
Add text saying that bug reports aren't automatic
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2018-10-02 22:58:49 -05:00
Aaron Raimist
d256194255
Document how to turn off Piwik and bug reports (#6738) 2018-10-01 20:21:13 -05:00
Travis Ralston
91304e70a1 Swap out the complicated canary stuff for serial execution
Fixes https://github.com/vector-im/riot-web/issues/7386
2018-09-25 15:49:14 -06:00
Travis Ralston
67e9606d55 Reduce the number of terminals required to build riot-web to 1
A step towards a real solution for https://github.com/vector-im/riot-web/issues/7305

This approach makes use of `npm link` to remove the use of symlinks in the build process. The build process has also been altered to invoke the build process of each underlying SDK (react, js). This means that one can now `npm link` and `npm start` and have a working environment. 

At the same time, parallelshell was dropped due to lack of maintenance from the maintainer.
2018-09-17 17:50:03 -06:00
Matthew Hodgson
5ef141913b remove ancient layering warning 2018-09-09 18:35:31 +01:00
David Baker
964a3bc35b Add readme bit on cross-origin renderer 2018-04-25 11:10:46 +01:00
rugk
6437b490a6
Fix another typo 2018-03-21 16:18:08 +01:00
Matthew Hodgson
1e977b50df add default_theme to readme 2018-03-16 11:43:54 +00:00
David Baker
96f374ed69 Remove og:image with status.im URL
And make it configurable, albeit only at buuld time, as hopefully
explained in the README.
2018-03-14 18:34:26 +00:00
rugk
3c3fd7cf2a
Remove typo 2018-03-05 21:47:28 +01:00
rugk
cfed0cbd0d
Mention localhost 2018-03-05 21:37:07 +01:00
Matthew Hodgson
ab55f2b938 document config.json 2018-03-03 20:30:08 +00:00
rugk
93da078669
Clarify that HTTPS is not just needed for VoIP
…but for basic security.
2018-02-15 02:17:37 +01:00
Ander Punnar
d9409232f9 default url, not domain
https://github.com/matrix-org/matrix-react-sdk/blob/master/src/components/views/messages/MFileBody.js#L116

Signed-off-by: Ander Punnar <ander@kvlt.ee>
2018-01-23 12:15:08 +02:00
Matthew Hodgson
37b5de2251 update triaging a bit 2018-01-19 16:52:55 +00:00
Michael Telatynski
26269986f5
move piwik whitelists to conf and add piwik config.json info to readme
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2017-11-19 15:36:28 +00:00
Travis Ralston
eb6ce753aa Clarify what an integrations server is
Possibly helps resolve #1698

Signed-off-by: Travis Ralston <travpc@gmail.com>
2017-10-11 19:52:10 -06:00
Hubert Chathi
dd73aeec70 another s/vector/riot/
Signed-off-by: Hubert Chathi <hubert@uhoreg.ca>
2017-08-29 23:06:50 -04:00
Richard van der Hoff
0b2120e423 Merge pull request #4764 from MTRNord/patch-5
Fix typo with scripts/fetch-develop-deps.sh in Building From Source
2017-08-08 18:23:44 +01:00
Marcel
a3525f411d Fix typo with scripts/fetch-develop-deps.sh in Building From Source
scripts/fetch-develop-deps.sh vs scripts/fetch-develop.deps.sh
2017-08-08 19:22:07 +02:00
Matthew Hodgson
9f3c33758c Merge pull request #4464 from vsund/patch-1
Fix signing key url in readme
2017-08-06 20:11:32 +01:00
Richard van der Hoff
a14bc9a9b1 README: minor fixes 2017-07-05 11:47:38 +01:00
Richard van der Hoff
ba0073ca71 README: Add notes on running tests 2017-07-05 11:45:33 +01:00
Valentin Sundermann
aade0d557d Fix key url in readme
The URL for the signing key changed and hence pointed to a wrong direction.
2017-06-20 20:50:18 +02:00
David Baker
4f6b237fbc Update translation links to riot.im 2017-06-09 15:16:38 +01:00
Michael Telatynski
5fb60406b0 add minimum electron version requirement 2017-06-02 22:49:04 +01:00
Richard van der Hoff
71aed70d4b Don't try to build with node 6.0
because it has broken npm
2017-06-01 17:55:52 +01:00
Richard van der Hoff
33b95d4965 Standardise on node v6/v7 2017-05-30 15:53:21 +01:00
David Baker
d4aa428321 Move translation status image to i18n section 2017-05-24 14:23:34 +01:00
David Baker
6b6fa59f3e Squash merge https://github.com/vector-im/riot-web/pull/3636 2017-05-23 14:12:53 +01:00
David Baker
68a39b2783 Update process to not set deps to #develop
Update README instructions and add checks to release script to
prevent us forgetting to bump the versions of dependencies
(because the check in the main release script will only catch
references to #develop left in, which will no longer be the
failure mode).
2017-05-19 11:59:27 +01:00
Michael Telatynski
1ed1080bf3 Update README with npm run electron
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2017-05-05 17:05:03 +01:00
Michael Telatynski
9e2324fb69 don't hook on postinstall, current dev cycle uses (abuses) npm i to build
so no point making it take longer than it has to for the devs only testing
webapp

build:electron - hook npm run install:electron
install:electron - run npm i for the electron deps
electron - start the app locally for testing

add to README

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2017-04-23 22:50:58 +01:00
Matthew Hodgson
e40c6905dd more instructions 2017-04-01 13:33:24 +01:00
Matthew Hodgson
84a0ef9695 spell out that if you're on develop you need to keep your deps up-to-date 2017-04-01 13:25:16 +01:00
Tom Lant
927d305ed9 Fixing triage markdown as per #3382 2017-03-09 14:36:56 +00:00
David Baker
feb8115d24 Desktop instructions: npm run build, not dist
Clarify that you only need to run build rather than dist to run
the electron app.

Hopefully satisfies: https://github.com/vector-im/riot-web/pull/3237
2017-02-20 10:32:14 +00:00
Matthew Hodgson
5469270e41 spell out where the PGP key lives for releases 2017-02-18 23:48:58 +02:00
David Baker
3c91f90dc9 Tweak desktop instructions (#3069)
to make it clear you need to do all the things in 'building from
source', including the build-react-sdk dance if you're building
develop.
2017-01-26 09:47:01 +00:00
David Baker
3023ea5335 Merge branch 'release-v0.9.6' 2017-01-16 13:34:41 +00:00
Hubert Chathi
ccf7db7cc2 Fix a couple more references to vector-web in README.md 2017-01-13 15:06:29 -05:00
David Baker
27e311f7e8 Address PR comments 2017-01-11 18:15:06 +00:00
David Baker
5258bf9c84 Update README now the js-sdk has a transpile step 2017-01-11 17:25:58 +00:00
Hubert Chathi
d1a9695a35 update README to point to new names/locations 2016-12-28 20:57:31 -05:00
Matthew Hodgson
6e0f83a298 Merge branch 'release-v0.9.5' 2016-12-24 19:29:42 +00:00
Matthew Hodgson
8c523be6f5 add gnu-tar to debian electron build deps 2016-12-24 19:03:46 +00:00
Matthew Hodgson
b06d045188 Merge pull request #2808 from vector-im/matthew/electron-captcha2
make electron send email validation URLs with a nextlink of riot.im
2016-12-24 18:38:29 +00:00
Matthew Hodgson
f2afcc0bc8 add gnu-tar to debian electron build deps 2016-12-24 18:13:20 +00:00
Kevin McDonald
2b70cb436e add Debian Stretch install steps to readme 2016-12-23 22:32:16 -07:00