Lightweight matrix client with legacy and mobile browser support
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Eric Eastwood 5b54280ac2
Ignore macOS metadata .DS_Store (#770)
2 days ago
.github/workflows Add GH Action to build the docker image 8 months ago
doc viewClassForTile is needed for TimelineView 2 months ago
prototypes add prototype to show we can prevent the txn from being aborted on error 9 months ago
scripts Merge pull request #759 from vector-im/move-scope-down 1 week ago
src Merge pull request #767 from vector-im/bwindels/download-media 4 days ago
.dockerignore chore: optimise Dockerfile 1 year ago
.editorconfig wip 3 years ago
.eslintrc.js Move plugin to /scripts and create eslintrc 4 months ago
.gitignore Ignore macOS metadata .DS_Store (#770) 2 days ago
.gitlab-ci.yml chore: add GitLab CI definition 1 year ago
.ts-eslintrc.js only enable promise related rules ... I think? 11 months ago
CONTRIBUTING.md remove changelog notes remainder 4 months ago
Dockerfile Required pkg for aarch64 docker build 9 months ago
Dockerfile-dev Required pkg for aarch64 docker build 9 months ago
LICENSE add full license text 2 years ago
README.md add notes about client side caching 1 month ago
TODO.md WIP 2 years ago
codestyle.md dont use lookbehind in regular expressions, safari & older firefoxes choke on them 7 months ago
package.json Require node 15. 5 days ago
tsconfig-declaration.json somewhat works, but not everything we need 6 months ago
tsconfig.json make tsconfig file to build declaration files 6 months ago
view-gallery.html rearrange assets and main.js to make them run with vite 8 months ago
vite.common-config.js Fix typo here 2 weeks ago
vite.config.js Merge remote-tracking branch 'origin/move-config-root' 1 month ago
vite.sdk-assets-config.js Add some comments 2 months ago
vite.sdk-lib-config.js Remove unsued imports 3 months ago
yarn.lock Update Vite to avoid flakey errors in our PostCSS plugins 2 months ago

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.