Arsharth
/
hydrogen-web
forked from mystiq/hydrogen-web
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add notes about client side caching

This commit is contained in:
Bruno Windels 2022-05-18 19:44:39 +00:00 committed by GitHub
parent 13428bd03c
commit 514d5c0a50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -22,12 +22,14 @@ Hydrogen is deployed to [hydrogen.element.io](https://hydrogen.element.io). You
1. Extract the package to the public directory of your web server. 1. Extract the package to the public directory of your web server.
1. If this is your first deploy: 1. 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](https://github.com/matrix-org/sygnal) instance, you don't need to change anything in the `push` section). 1. copy `config.sample.json` to `config.json` and if needed, make any modifications (unless you've set up your own [sygnal](https://github.com/matrix-org/sygnal) instance, you don't need to change anything in the `push` section).
1. Disable caching entirely on the server (they will still be cached client-side by the service worker) for: 1. Disable caching entirely on the server for:
- `index.html` - `index.html`
- `sw.js` - `sw.js`
- `config.json` - `config.json`
- All theme manifests referenced in the `themeManifests` of `config.json`, these files are typically called `theme-{name}.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 ## Set up a dev environment
You can run Hydrogen locally by the following commands in the terminal: You can run Hydrogen locally by the following commands in the terminal: