gaja-group
/
element-web
forked from matrix/element-web
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #8702 from vector-im/michaelkaye/readme_updates_caching 

Add note in README about self-hosted riot installs requiring custom caching headers
This commit is contained in:
Travis Ralston 2019-11-24 21:55:38 -07:00 committed by GitHub
parent 8b2ca56283 1bd473a1b9
commit f8b42929c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -20,6 +20,7 @@ released version of Riot:
1. Download the latest version from https://github.com/vector-im/riot-web/releases 1. Download the latest version from https://github.com/vector-im/riot-web/releases
1. Untar the tarball on your web server 1. Untar the tarball on your web server
1. Move (or symlink) the `riot-x.x.x` directory to an appropriate name 1. Move (or symlink) the `riot-x.x.x` directory to an appropriate name
1. Configure the correct caching headers in your webserver (see below)
1. If desired, copy `config.sample.json` to `config.json` and edit it 1. If desired, copy `config.sample.json` to `config.json` and edit it
as desired. See the [configuration docs](docs/config.md) for details. as desired. See the [configuration docs](docs/config.md) for details.
1. Enter the URL into your browser and log into Riot! 1. Enter the URL into your browser and log into Riot!
@ -192,6 +193,18 @@ Labs Features
Some features of Riot may be enabled by flags in the `Labs` section of the settings. Some features of Riot may be enabled by flags in the `Labs` section of the settings.
Some of these features are described in [labs.md](https://github.com/vector-im/riot-web/blob/develop/docs/labs.md). Some of these features are described in [labs.md](https://github.com/vector-im/riot-web/blob/develop/docs/labs.md).
Caching requirements
====================
Riot requires the following URLs not to be cached, when/if you are serving Riot from your own webserver:
```
/config.*.json
/i18n
/home
/sites
/index.html
```
Development Development
=========== ===========