mirrors/vector-im-hydrogen-web
1
0
Fork 0
mirror of https://github.com/vector-im/hydrogen-web.git synced 2024-12-22 19:14:52 +01:00
Code Issues Projects Releases Wiki Activity
4,662 Commits 491 Branches 136 Tags 34 MiB
TypeScript 48.9%
JavaScript 40%
HTML 7.9%
CSS 3%
Shell 0.1%
ad02c1625f
Go to file
Paulo Pinto ad02c1625f Encode SSO redirect URL as it may contain multiple query parameters 
If the returnURL contains multiple query parameters (e.g. http://localhost:3000?foo=bar&bar=baz), the homeserver would fail to correctly parse the URL, and only the first query parameter would be kept.

This is not an issue with the homeserver since the URL cannot be parsed in an unambiguous way, as the resulting URL would be:

https://example.com/_matrix/client/r0/login/sso/redirect?redirectUrl=http://localhost:3000?foo=bar&bar=baz

It's not possible to know whether the bar parameter is part of the "parent" URL, or part of the redirectUrl parameter.

----

To fix this, we now encode the redirectUrl parameter, which results in:

https://example.com/_matrix/client/r0/login/sso/redirect?redirectUrl=http%3A%2F%2Flocalhost%3A3000%2Fparent.html%3Ffoo%3Dbar%26bar%3Dbaz

This URL is correctly parsed by synapse.
2022-10-27 15:42:24 +01:00
.github/workflows Add GH Action to build the docker image 2021-11-01 14:55:32 +00:00
doc Add explaining doc 2022-08-01 17:01:36 +05:30
playwright Fix formatting 2022-10-25 21:29:28 +05:30
prototypes add prototype to show we can prevent the txn from being aborted on error 2021-09-21 20:58:16 +02:00
scripts Merge pull request #906 from vector-im/playwright 2022-10-26 11:28:38 +05:30
src Encode SSO redirect URL as it may contain multiple query parameters 2022-10-27 15:42:24 +01:00
.dockerignore chore: optimise Dockerfile 2021-03-14 12:52:35 +01:00
.editorconfig wip 2019-02-17 23:58:01 +01:00
.eslintrc.js JoinedMap to typescript 2022-08-07 21:12:59 -07:00
.gitignore Convert Cypress --> Playwright 2022-10-18 23:44:58 +05:30
.gitlab-ci.yml chore: add GitLab CI definition 2021-03-14 13:20:39 +01:00
.ts-eslintrc.js updates ts-eslint and fixes errors in src/observable 2022-08-07 21:13:00 -07:00
codestyle.md dont use lookbehind in regular expressions, safari & older firefoxes choke on them 2021-12-08 18:00:37 +01:00
CONTRIBUTING.md remove changelog notes remainder 2022-02-17 17:44:44 +01:00
Dockerfile Required pkg for aarch64 docker build 2021-09-29 19:31:39 -07:00
Dockerfile-dev Required pkg for aarch64 docker build 2021-09-29 19:31:39 -07:00
LICENSE add full license text 2020-08-05 18:40:45 +02:00
package.json Remove cypress as dependency 2022-10-25 17:06:39 +05:30
playwright.config.ts Limit workers to 1 for now 2022-10-25 21:18:56 +05:30
README.md add notes about client side caching 2022-05-18 19:44:39 +00:00
TODO.md WIP 2020-08-05 18:17:35 +01:00
tsconfig-declaration.json somewhat works, but not everything we need 2021-12-22 16:31:18 +01:00
tsconfig.json Revert back option 2022-07-29 17:33:33 +05:30
view-gallery.html rearrange assets and main.js to make them run with vite 2021-11-08 11:10:23 +01:00
vite.common-config.js Change directory name 2022-07-19 17:56:08 +05:30
vite.config.js Get the theme-collection id from manifest 2022-06-23 15:06:22 +05:30
vite.sdk-assets-config.js Specify theme as array 2022-07-29 23:45:58 +05:30
vite.sdk-lib-config.js Remove unsued imports 2022-04-13 17:44:07 +05:30
yarn.lock Convert Cypress --> Playwright 2022-10-18 23:44:58 +05:30

README.md

Hydrogen

A minimal Matrix chat client, focused on performance, offline functionality, and broad browser support. This is work in progress and not yet ready for primetime. Bug reports are welcome, but please don't file any feature requests or other missing things to be on par with Element Web.

Goals

Hydrogen's goals are:

  • Work well on desktop as well as mobile browsers
  • UI components can be easily used in isolation
  • It is a standalone webapp, but can also be easily embedded into an existing website/webapp to add chat capabilities.
  • Loading (unused) parts of the application after initial page load should be supported

For embedded usage, see the SDK instructions.

If you find this interesting, come and discuss on #hydrogen:matrix.org.

How to use

Hydrogen is deployed to hydrogen.element.io. You can also deploy Hydrogen on your own web server:

  1. Download the latest release package.
  2. Extract the package to the public directory of your web server.
  3. If this is your first deploy:

    1. copy config.sample.json to config.json and if needed, make any modifications (unless you've set up your own sygnal instance, you don't need to change anything in the push section).

    2. Disable caching entirely on the server for:

      • index.html
      • sw.js
      • config.json
      • All theme manifests referenced in the themeManifests of config.json, these files are typically called theme-{name}.json.

      These resources will still be cached client-side by the service worker. Because of this; you'll still need to refresh the app twice before config.json changes are applied.

Set up a dev environment

You can run Hydrogen locally by the following commands in the terminal:

  • yarn install (only the first time)
  • yarn start in the terminal

Now point your browser to http://localhost:3000. If you prefer, you can also use docker.

FAQ

Some frequently asked questions are answered here.