Commit graph

183 commits

Author SHA1 Message Date
J. Ryan Stinnett
b8766d5fb4 Clarify supported tier means desktop OSes
This clarifies that the "supported" tier is for browser and the official app on
desktop OSes only.

Fixes https://github.com/vector-im/riot-web/issues/12421
2020-02-24 16:52:30 +00:00
Michael Telatynski
44ec8198e5 Merge branches 'develop' and 't3chguy/usercontent' of github.com:vector-im/riot-web into t3chguy/usercontent
 Conflicts:
	README.md
2020-02-19 12:51:34 +00:00
J. Ryan Stinnett
e1eb354c1c Add experimental support tier
This updates and rewrites the supported environments portion of the README. It
also adds a new experimental support tier to clarify how we'll handle things
like installed PWAs and mobile web.
2020-02-14 18:04:54 +00:00
Michael Telatynski
22d0d1029e update README
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-02-13 16:55:23 +00:00
Travis Ralston
b23318be8d
Clarify which versions of what we support 2019-12-12 10:34:22 -07:00
Travis Ralston
1bd473a1b9 Move caching requirements higher in the readme 2019-11-24 21:54:01 -07:00
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