PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Add note in README about self-hosted riot installs requiring custom riot headers.

Browse source 
Copy the list of headers from the current matrix.org list
This commit is contained in:
Michael Kaye 2019-02-15 12:43:47 +00:00
parent 674b8c3561
commit f9551ddff5
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -16,6 +16,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 below for details. as desired. See below for details.
1. Enter the URL into your browser and log into Riot! 1. Enter the URL into your browser and log into Riot!
@ -416,3 +417,17 @@ community engagement
* hacktoberfest * hacktoberfest
* bounty? - proposal to be included in a bounty programme * bounty? - proposal to be included in a bounty programme
* bounty - included in Status Open Bounty * bounty - included in Status Open Bounty
== Caching requirements ==
Riot requires the following URLs not to be cached if you are serving riot from your own webserver:
```
/config.*.json
/i18n
/home
/sites
/index.html
```