Mercurial > prosody-modules

comparison mod_strict_https/README.markdown @ 5414:0c8e6269ea38

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_strict_https: Refresh README
author Kim Alvefur <zash@zash.se>
date Wed, 03 May 2023 10:54:15 +0200
parents 4d73a1a6ba68
children f8797e3284ff
comparison
equal deleted inserted replaced
5413:c90011054335 5414:0c8e6269ea38
1 --- 1 ---
2 labels:
3 summary: HTTP Strict Transport Security 2 summary: HTTP Strict Transport Security
4 ... 3 ---
5 4
6 Introduction 5 # Introduction
7 ============
8 6
9 This module implements [HTTP Strict Transport 7 This module implements [RFC 6797: HTTP Strict Transport Security] and
10 Security](https://tools.ietf.org/html/rfc6797) and responds to all 8 responds to all non-HTTPS requests with a `301 Moved Permanently`
11 non-HTTPS requests with a `301 Moved Permanently` redirect to the HTTPS 9 redirect to the HTTPS equivalent of the path.
12 equivalent of the path.
13 10
14 Configuration 11 # Configuration
15 =============
16 12
17 Add the module to the `modules_enabled` list and optionally configure 13 Add the module to the `modules_enabled` list and optionally configure
18 the specific header sent. 14 the specific header sent.
19 15
20 modules_enabled = { 16 ``` lua
21 ... 17 modules_enabled = {
22 "strict_https"; 18 ...
23 } 19 "strict_https";
24 hsts_header = "max-age=31556952" 20 }
21 hsts_header = "max-age=31556952"
22 ```
25 23
26 Compatibility 24 # Compatibility
27 =============
28 25
29 ------- -------------- 26 ------- -------------
30 trunk Works 27 trunk Should work
31 0.9 Works 28 0.12 Should work
32 0.8 Doesn't work 29 0.11 Should work
33 ------- -------------- 30 ------- -------------