From f9551ddff54bfe042cbe77b8f0172d87cc220e87 Mon Sep 17 00:00:00 2001 From: Michael Kaye <1917473+michaelkaye@users.noreply.github.com> Date: Fri, 15 Feb 2019 12:43:47 +0000 Subject: [PATCH 1/3] Add note in README about self-hosted riot installs requiring custom riot headers. Copy the list of headers from the current matrix.org list --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 10fef7360e..1d49a56bb9 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ released version of Riot: 1. Download the latest version from https://github.com/vector-im/riot-web/releases 1. Untar the tarball on your web server 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 as desired. See below for details. 1. Enter the URL into your browser and log into Riot! @@ -416,3 +417,17 @@ community engagement * hacktoberfest * bounty? - proposal to be included in a bounty programme * 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 +``` + + + From 8b598e55659482d7c976229ed37ac1d5c767f28d Mon Sep 17 00:00:00 2001 From: Michael Kaye <1917473+michaelkaye@users.noreply.github.com> Date: Fri, 15 Feb 2019 12:49:26 +0000 Subject: [PATCH 2/3] Update README.md Fix formatting --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1d49a56bb9..a7e370a0e7 100644 --- a/README.md +++ b/README.md @@ -418,9 +418,9 @@ community engagement * bounty? - proposal to be included in a bounty programme * bounty - included in Status Open Bounty -== Caching requirements == +## Caching requirements -Riot requires the following URLs not to be cached if you are serving riot from your own webserver: +Riot requires the following URLs not to be cached, when if you are serving riot from your own webserver: ``` /config.*.json /i18n From 1bd473a1b95a69f120eca1e0b166c7608dab8c74 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Sun, 24 Nov 2019 21:54:01 -0700 Subject: [PATCH 3/3] Move caching requirements higher in the readme --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b1bf0379b2..d728f6b49f 100644 --- a/README.md +++ b/README.md @@ -193,6 +193,18 @@ Labs Features 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). +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 =========== @@ -376,17 +388,3 @@ community engagement * hacktoberfest * bounty? - proposal to be included in a bounty programme * bounty - included in Status Open Bounty - -## 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 -``` - - -