Mercurial > prosody-modules
diff mod_strict_https/README.markdown @ 5414:0c8e6269ea38
mod_strict_https: Refresh README
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Wed, 03 May 2023 10:54:15 +0200 |
parents | 4d73a1a6ba68 |
children | f8797e3284ff |
line wrap: on
line diff
--- a/mod_strict_https/README.markdown Wed May 03 10:34:00 2023 +0200 +++ b/mod_strict_https/README.markdown Wed May 03 10:54:15 2023 +0200 @@ -1,33 +1,30 @@ --- -labels: summary: HTTP Strict Transport Security -... +--- -Introduction -============ +# Introduction -This module implements [HTTP Strict Transport -Security](https://tools.ietf.org/html/rfc6797) and responds to all -non-HTTPS requests with a `301 Moved Permanently` redirect to the HTTPS -equivalent of the path. +This module implements [RFC 6797: HTTP Strict Transport Security] and +responds to all non-HTTPS requests with a `301 Moved Permanently` +redirect to the HTTPS equivalent of the path. -Configuration -============= +# Configuration Add the module to the `modules_enabled` list and optionally configure the specific header sent. - modules_enabled = { - ... - "strict_https"; - } - hsts_header = "max-age=31556952" +``` lua +modules_enabled = { + ... + "strict_https"; +} +hsts_header = "max-age=31556952" +``` -Compatibility -============= +# Compatibility - ------- -------------- - trunk Works - 0.9 Works - 0.8 Doesn't work - ------- -------------- + ------- ------------- + trunk Should work + 0.12 Should work + 0.11 Should work + ------- -------------