From 1efe34c0adab854d16a785f1ccfe797d46b57c5e Mon Sep 17 00:00:00 2001 From: teddit Date: Tue, 18 Jan 2022 19:54:26 +0100 Subject: [PATCH] add description for config.api_force_https --- README.md | 1 + config.js.template | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c53e45..433075a 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,7 @@ The following variables may be set to customize your deployment at runtime. | flairs_enabled | Enables the rendering of user and link flairs on Teddit. Defaults to **true** | | highlight_controversial | Enables controversial comments to be indicated by a typographical dagger (†). Defaults to **true** | | api_enabled | Teddit API feature. Might increase loads significantly on your instance. Defaults to **true** | +| api_force_https | Force HTTPS to Teddit API permalinks (see #285). Defaults to **false** | | video_enabled | Enables video playback within Teddit. Defaults to **true** | | redis_enabled | Enables Redis caching. If disabled, does not allow for any caching of Reddit API calls. Defaults to **true** | | redis_db | Sets the redis DB name, if required | diff --git a/config.js.template b/config.js.template index 8c8eeeb..416fa78 100644 --- a/config.js.template +++ b/config.js.template @@ -6,7 +6,7 @@ const config = { flairs_enabled: !('FLAIRS_ENABLED' in process.env) || process.env.FLAIRS_ENABLED === 'true', // Enables the rendering of user and link flairs on teddit highlight_controversial: !('HIGHLIGHT_CONTROVERSIAL' in process.env) || process.env.HIGHLIGHT_CONTROVERSIAL === 'true', // Enables controversial comments to be indicated by a typographical dagger (†) api_enabled: !('API_ENABLED' in process.env) || process.env.API_ENABLED === 'true', // Teddit API feature. Might increase loads significantly on your instance. - api_force_https: process.env.API_FORCE_HTTPS === 'true' || false, + api_force_https: process.env.API_FORCE_HTTPS === 'true' || false, // Force HTTPS to Teddit API permalinks (see #285). video_enabled: !('VIDEO_ENABLED' in process.env) || process.env.VIDEO_ENABLED === 'true', redis_enabled: !('REDIS_ENABLED' in process.env) || process.env.REDIS_ENABLED === 'true', // If disabled, does not cache Reddit API calls redis_db: process.env.REDIS_DB,