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
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
22d0d1029e
update README
...
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-02-13 16:55:23 +00:00
fde32f13a5
[CONFLICT CHUNKS] Merge branch 'develop' into travis/sourcemaps-develop
2020-01-09 14:15:09 -07:00
a9cae90a52
Signed-off-by Pankaj Singh <singh.pankaj@live.com
2019-12-26 23:11:17 +05:30
9865ce899b
Add a bunch of docs
...
We're making an assumption here that the decorator is actually all over the app when it's not.
2019-12-16 16:34:46 -07:00
b23318be8d
Clarify which versions of what we support
2019-12-12 10:34:22 -07:00
1bd473a1b9
Move caching requirements higher in the readme
2019-11-24 21:54:01 -07:00
9790cac065
Merge branch 'develop' into michaelkaye/readme_updates_caching
2019-11-24 21:52:35 -07:00
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
a3a8da1746
provide deep link to e2e instructions in react sdk
2019-10-21 14:13:57 +02:00
e2e7303cc3
Update README.md
...
Co-Authored-By: J. Ryan Stinnett <jryans@gmail.com>
2019-10-18 12:29:17 +00:00
d1a5376dae
clarify where the e2e tests are located
2019-10-10 16:54:52 +02:00
d20b2ee9eb
document how to run the e2e tests locally
2019-10-10 16:54:10 +02:00
9e27cb713f
Add config.json copy instruction to 'Development' as well
2019-10-06 13:04:20 +02:00
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
658c5b42be
Update README.md
...
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2019-09-01 13:41:21 +02:00
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
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
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
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
cafae31827
Add docs for defaultCountryCode
2019-05-31 21:23:58 -06:00
98f2d865b9
Add 'showLabsSettings' flag to docs+sample config
2019-05-30 20:03:42 -06:00
734d8a8151
Clarify Electron steps
2019-05-24 11:28:12 +01:00
ab6ba0e0d8
Add some clarity to the config options
2019-05-03 11:06:32 -06:00
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
9957149115
Merge pull request #9426 from vector-im/travis/dockerfile-continued
...
Add Dockerfile (part 2)
2019-05-01 10:42:21 -06:00
cc5911b4aa
Remove redundant and incorrect riot-desktop install instructions ( #9558 )
2019-04-25 13:22:32 +01:00
434e8cc937
Changed the Debian repo key and public key URLs
2019-04-16 21:03:53 +02:00
6c950593b7
the repo key filename changed, reflecting this
2019-04-16 17:58:54 +02:00
147f77f1dc
Update README.md
...
better wording
Co-Authored-By: axelsimon <github@axelsimon.net>
2019-04-16 17:55:49 +02:00
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
a263ca8cb3
Add USE_CUSTOM_SDKS to docs
2019-04-10 15:51:06 -06:00
eeae5dbcad
Add docs for the Docker image
2019-04-10 15:47:12 -06:00
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
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
5a051824c0
configure auth footer links through sdkconfig
...
Signed-off-by: Jonas Jelten <jelten@in.tum.de>
2019-03-28 12:32:10 +01:00
d098857d5a
wrap text and link from README.md
2019-03-22 14:49:44 +00:00
34e533dd4b
Remove Edge from browser support statements
...
At the current time, we do not intend to do additional work specifically to
support Edge. If it works for most use cases, that's great, but we do not
intend to fix issues that affect only Edge.
Fixes https://github.com/vector-im/riot-web/issues/9201
2019-03-18 15:47:48 +00:00
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
faa9932c77
Merge pull request #9011 from vector-im/t3chguy/local-config
...
Document some desktop app things
2019-03-15 17:53:55 +00:00
95611d2c12
Update README.md grammar
2019-03-15 17:53:20 +00:00
631fcb0ad2
Cross-promote mobile apps
2019-03-15 11:43:00 -06:00
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
fcaf0a5503
Recommend using the latest Node LTS version
2019-03-13 10:54:36 +00:00
92a9f13452
Recommend using the latest Node LTS version
2019-03-13 10:53:53 +00:00
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
337ac2f6a0
Reorder link and install steps
...
Take advantage of Yarn's preservation of links while installing and set up links
first and install second. This should result in a small speedup since we no
longer install the published SDKs just to replace them on the next line.
2019-03-11 18:36:45 +00:00
7c947d87ab
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-11 14:22:02 +00:00
01becf00f5
Try and improve README
...
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2019-03-01 08:01:26 +00:00
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
8b598e5565
Update README.md
...
Fix formatting
2019-02-15 12:49:26 +00:00
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
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
678904dcfb
Allow configuring auth header logo
2019-02-11 16:29:50 +00:00
86ced4cdad
Allow configuring welcome background image
2019-02-11 16:15:04 +00:00
4c877f118d
Document `embeddedPages` configuration
2019-02-11 09:29:17 +00:00
dd01a398b6
Syntax Coloring
...
Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>
2019-02-10 10:15:28 +01:00
5030410dd6
Merge pull request #8381 from aaronraimist/electron-browser-zoom+
...
Allow Electron to zoom with CommandOrControl+=
2019-02-07 08:22:45 +00:00
bfdffc653e
Allow Electron to zoom with CommandOrControl+=
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2019-02-02 15:53:10 -06:00
3eb550a15c
Spell homeserver correctly
2019-01-31 18:52:49 -06:00
2d360eab74
Remove support for team servers
2019-01-25 16:14:04 -06:00
633b8d419f
Mention node 8.x as recommended in development docs
...
Co-Authored-By: jaywink <mail@jasonrobinson.me>
2019-01-06 15:13:07 +02:00
e876edcbc3
Clarify readme instructions for developers
...
Setting up the SDK for development, I noticed that 3 tests failed on
develop branch. Linking the JS SDK made the tests pass. It looks like
the assumption is that developers link against the develop branch
of JS SDK to develop the React SDK.
Clarify this in the readme for completeness sake.
Signed-off-by: Jason Robinson <jasonr@matrix.org>
2019-01-04 11:01:35 +02:00
f7bdc9339c
Make clear that the Debian package is for desktop
2018-12-19 21:05:21 +00:00
0b65a1ee1a
Remove outdated info about custom skins
...
It has been marked outdated for several years. Since it appears on the repo home
page, it makes the project feel unmaintained.
Signed-off-by: J. Ryan Stinnett <jryans@gmail.com>
2018-12-06 19:25:07 -06:00
af4d3da7a8
link to Here Be Dragons
2018-10-11 10:29:28 +01:00
3286acd306
Use HTTPS cloning for riot-web too
2018-10-04 11:23:42 -06:00
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
d256194255
Document how to turn off Piwik and bug reports ( #6738 )
2018-10-01 20:21:13 -05:00
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
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
ef20813f2e
remove layering warnings
2018-09-09 18:38:21 +01:00
5ef141913b
remove ancient layering warning
2018-09-09 18:35:31 +01:00
964a3bc35b
Add readme bit on cross-origin renderer
2018-04-25 11:10:46 +01:00
6437b490a6
Fix another typo
2018-03-21 16:18:08 +01:00
1e977b50df
add default_theme to readme
2018-03-16 11:43:54 +00:00
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
3c3fd7cf2a
Remove typo
2018-03-05 21:47:28 +01:00
cfed0cbd0d
Mention localhost
2018-03-05 21:37:07 +01:00
ab55f2b938
document config.json
2018-03-03 20:30:08 +00:00
93da078669
Clarify that HTTPS is not just needed for VoIP
...
…but for basic security.
2018-02-15 02:17:37 +01:00
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
37b5de2251
update triaging a bit
2018-01-19 16:52:55 +00:00
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
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
27b594e1af
Fix broken Link
2017-09-04 18:31:53 +02:00
dd73aeec70
another s/vector/riot/
...
Signed-off-by: Hubert Chathi <hubert@uhoreg.ca>
2017-08-29 23:06:50 -04:00
00d69aa938
Update Link to Translation status
...
The translation is now done at translate.riot.im but the link was not updated
2017-08-15 00:32:38 +02:00
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
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
9f3c33758c
Merge pull request #4464 from vsund/patch-1
...
Fix signing key url in readme
2017-08-06 20:11:32 +01:00
a14bc9a9b1
README: minor fixes
2017-07-05 11:47:38 +01:00
ba0073ca71
README: Add notes on running tests
2017-07-05 11:45:33 +01:00
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
4f6b237fbc
Update translation links to riot.im
2017-06-09 15:16:38 +01:00
5fb60406b0
add minimum electron version requirement
2017-06-02 22:49:04 +01:00
71aed70d4b
Don't try to build with node 6.0
...
because it has broken npm
2017-06-01 17:55:52 +01:00
33b95d4965
Standardise on node v6/v7
2017-05-30 15:53:21 +01:00
107024efa8
Unnecessary whitespace
2017-05-25 11:42:19 +01:00
d4aa428321
Move translation status image to i18n section
2017-05-24 14:23:34 +01:00
dd1c50ce80
README formatting
...
Move translation status to its own heading
2017-05-23 15:30:36 +01:00
d419c42a4f
Squash merge https://github.com/matrix-org/matrix-react-sdk/pull/801
2017-05-23 15:16:31 +01:00
6b6fa59f3e
Squash merge https://github.com/vector-im/riot-web/pull/3636
2017-05-23 14:12:53 +01:00
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
1ed1080bf3
Update README with npm run electron
...
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2017-05-05 17:05:03 +01:00
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
e40c6905dd
more instructions
2017-04-01 13:33:24 +01:00
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
927d305ed9
Fixing triage markdown as per #3382
2017-03-09 14:36:56 +00:00
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
5469270e41
spell out where the PGP key lives for releases
2017-02-18 23:48:58 +02:00
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
3023ea5335
Merge branch 'release-v0.9.6'
2017-01-16 13:34:41 +00:00
ccf7db7cc2
Fix a couple more references to vector-web in README.md
2017-01-13 15:06:29 -05:00
27e311f7e8
Address PR comments
2017-01-11 18:15:06 +00:00
5258bf9c84
Update README now the js-sdk has a transpile step
2017-01-11 17:25:58 +00:00
d1a9695a35
update README to point to new names/locations
2016-12-28 20:57:31 -05:00
6e0f83a298
Merge branch 'release-v0.9.5'
2016-12-24 19:29:42 +00:00
8c523be6f5
add gnu-tar to debian electron build deps
2016-12-24 19:03:46 +00:00
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
f2afcc0bc8
add gnu-tar to debian electron build deps
2016-12-24 18:13:20 +00:00
2b70cb436e
add Debian Stretch install steps to readme
2016-12-23 22:32:16 -07:00
e741a4f294
Update desktop build instructions fixes #2792
...
This is based on what I had to do to get the desktop app running, as per the advice in https://github.com/vector-im/riot-web/issues/2792 . I am not familiar with `npm`, so please change this pull request if there is a more appropriate way of achieving the same result.
2016-12-22 14:53:03 -05:00
197c68c247
s/vector/riot/g
2016-12-21 22:45:57 +00:00
9ae86f2585
README.md: fix GFMD for nativefier
...
GitHub Flavoured MarkDown parsed this as
`sudo npm install nativefier -g nativefier https://riot.im/app/ ` which
is incorrect.
2016-12-17 21:17:58 +02:00
994bc9279f
Remove the client side filtering from the room dir
...
This removes the ability for the client to filter remote room
directories by network, since the /thirdparty/protocols API does
not yet work for remote servers. They would only get the main list
now though anyway, so there is no point in us continuing to support
it.
2016-12-16 14:17:13 +00:00
f5bd8abfda
Support room dir 3rd party network filtering
...
As per https://github.com/matrix-org/synapse/pull/1676
The existing local config system still exists and is used for
remote home server directories (since /thirdparty/protocols
doesn't support listing remote home servers, and also because
people are using it).
2016-12-14 15:41:15 +00:00
119e03b64f
Get the update base URL right
...
and update the text in the README.
2016-12-12 17:24:22 +00:00
fe574b008b
Credit aviral & other options for native riot
2016-12-09 19:05:25 +00:00
f7cd5cb76f
Update README to say how to build the desktop app
2016-12-09 18:29:06 +00:00
970a029cea
Merge remote-tracking branch 'origin/develop' into dbkr/electron_dist_tweaks
2016-12-02 14:32:31 +00:00
749d26c8f4
Link to the repo which it turns out is a thing
2016-12-02 14:25:20 +00:00
d0c2ab4cf1
Document cross_origin_renderer_url
2016-12-02 13:43:41 +00:00
9f51e2c407
Auto-update & build process with NSIS for windows
...
Amalgamate the electron build packaging into one script.
Use update_base_url so we can compute the actual URL in the
script for windows (because we need to put it in the build) and
at runtime for mac os.
2016-12-01 19:33:42 +00:00
6a944d3e7d
Fix config location in some more places
2016-11-30 18:09:51 +00:00
db07ef7899
Update readme to point to github releases
...
not /packages
2016-11-02 12:01:01 +00:00
f17e851435
Rename the package script/output dir to 'dist'
...
To match conventions from other projects and match the release
script which expects releasde artefacts in dist/
2016-11-01 15:22:06 +00:00
e0556789d2
readme tweaks
...
Note that Chrome requires https for voip (fixes #2506 )
Remove lies about where issues are filed.
2016-10-25 11:20:23 +01:00
9310d92605
document integrations config in README
2016-10-21 14:59:13 +01:00
d72323bfc5
typo
2016-10-20 17:05:44 +01:00
dfd0356609
s/vector/riot/ in the readme
...
Also remove the outdated "E2E" section
Fixes https://github.com/vector-im/vector-web/issues/2457
2016-10-20 16:54:30 +01:00
562b047362
Typo
2016-10-05 13:49:30 +01:00
381c9009fb
Doc roomDirectory config section
2016-10-04 16:21:39 +01:00
e8a12e7ddc
Revert "fix instructions"
...
This reverts commit 6a13155013
2016-09-16 17:27:52 +01:00
6a13155013
fix instructions
2016-09-16 17:08:27 +01:00
0aae88d753
nudge jenkins
2016-08-30 14:40:30 +01:00
13983900c0
clarify electron instructions
2016-08-27 22:21:52 +01:00
e06caa9ca1
mention not just a problem for Vector
2016-08-27 00:13:56 +01:00
efc5462131
warn people to put their Matrix HS on a separate domain
2016-08-27 00:13:20 +01:00
Michael Telatynski