changeset 8883:fb40978c1afb

docs: clarify that force_https trumps anything else
author Mads Kiilerich <mads@kiilerich.com>
date Mon, 17 May 2021 16:59:06 +0200
parents 81e6b5e62a2c
children 883a0c6c425f
files development.ini docs/setup.rst kallithea/templates/ini/template.ini.mako
diffstat 3 files changed, 9 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/development.ini	Wed May 12 12:01:54 2021 +0200
+++ b/development.ini	Mon May 17 16:59:06 2021 +0200
@@ -111,11 +111,11 @@
 ## cut off limit for large diffs (size in bytes)
 cut_off_limit = 256000
 
-## force https in Kallithea, fixes https redirects, assumes it's always https
-force_https = false
+## always pretend the client connected using HTTPS (default false)
+#force_https = true
 
-## use Strict-Transport-Security headers
-use_htsts = false
+## use Strict-Transport-Security headers (default false)
+#use_htsts = true
 
 ## number of commits stats will parse on each iteration
 commit_parse_limit = 25
--- a/docs/setup.rst	Wed May 12 12:01:54 2021 +0200
+++ b/docs/setup.rst	Mon May 17 16:59:06 2021 +0200
@@ -417,7 +417,7 @@
 - With ``https_fixup = true``, the scheme will be taken from the
   ``X-Url-Scheme``, ``X-Forwarded-Scheme`` or ``X-Forwarded-Proto`` HTTP header
   (default ``http``).
-- With ``force_https = true`` the default will be ``https``.
+- With ``force_https = true``, the scheme will be seen as ``https``.
 - With ``use_htsts = true``, Kallithea will set ``Strict-Transport-Security`` when using https.
 
 .. _nginx_virtual_host:
--- a/kallithea/templates/ini/template.ini.mako	Wed May 12 12:01:54 2021 +0200
+++ b/kallithea/templates/ini/template.ini.mako	Mon May 17 16:59:06 2021 +0200
@@ -174,11 +174,11 @@
 <%text>##</%text> cut off limit for large diffs (size in bytes)
 cut_off_limit = 256000
 
-<%text>##</%text> force https in Kallithea, fixes https redirects, assumes it's always https
-force_https = false
+<%text>##</%text> always pretend the client connected using HTTPS (default false)
+#force_https = true
 
-<%text>##</%text> use Strict-Transport-Security headers
-use_htsts = false
+<%text>##</%text> use Strict-Transport-Security headers (default false)
+#use_htsts = true
 
 <%text>##</%text> number of commits stats will parse on each iteration
 commit_parse_limit = 25