From ca100624982362f1f4ddf23147c2750f8009dc10 Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Tue, 22 Oct 2019 17:01:48 +0000 Subject: [PATCH] [CORL-646] Docs update (#2648) * docs: added docs for trust proxy * fix: adjusted incorrect HTML - fixes #2656 --- docs/source/version-5-configuration.md | 7 +++++++ docs/source/version-5-counts.md | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/source/version-5-configuration.md b/docs/source/version-5-configuration.md index e128a981e..5ae528a80 100644 --- a/docs/source/version-5-configuration.md +++ b/docs/source/version-5-configuration.md @@ -58,3 +58,10 @@ the variables in a `.env` file in the root of the project in a simple , `1 minute`) that should be used to send keep alive messages through the websocket to keep the socket alive (Default `30 seconds`) - `TRUST_PROXY` - When provided, it configures the "trust proxy" settings for Express (See https://expressjs.com/en/guide/behind-proxies.html) + +## `TRUST_PROXY` + +If you are encountering issues where urls in the administration are showing with +a `http` instead of `https`, you may need to set the `TRUST_PROXY` setting. +Refer to https://expressjs.com/en/guide/behind-proxies.html for possible values +of this configuration variable as it pertains to your setup. diff --git a/docs/source/version-5-counts.md b/docs/source/version-5-counts.md index ec566a53d..9ff11df42 100644 --- a/docs/source/version-5-counts.md +++ b/docs/source/version-5-counts.md @@ -6,7 +6,7 @@ permalink: /v5/integrating/counts/ Add the `count.js` script to your `html` tree. On a page that includes the _Stream Embed_ this is done for you automatically, however for best performance we recommend to include it into the `` tag. ```html - + ``` > **NOTE:** Replace the value of `{% raw %}{{ CORAL_DOMAIN_NAME }}{% endraw %}` with the location of your running instance of Coral.