Mercurial > prosody-modules
annotate mod_strict_https/README.md @ 6084:4c0e3fe57e92
mod_compliance_latest: Gracefull error logging on missing dependency.
diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md
--- a/mod_compliance_latest/README.md
+++ b/mod_compliance_latest/README.md
@@ -9,13 +9,15 @@ rockspec:
# Introduction
-This module will always require and load to the lastest compliance tester we have in the community modules.
-Currently this is [mod_compliance_2023].
+This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules.
+Currently this is [mod_compliance_2023]. See the linked module for further details.
+
+If you do not use the *Prosody plugin installer* this module will likely have limited value to you.
+You can also just install the current compliance tester manually.
# Configuration
-Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer.
-See the linked module for further details.
+Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*.
# Compatibility
diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua
--- a/mod_compliance_latest/mod_compliance_latest.lua
+++ b/mod_compliance_latest/mod_compliance_latest.lua
@@ -1,1 +1,6 @@
-module:depends("compliance_2023");
+local success, err = pcall(function() module:depends("compliance_2023") end)
+
+if not success then
+ module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?")
+ return 1, "Error: Couldn't load dependency mod_compliance_2023."
+end
| author | Menel <menel@snikket.de> |
|---|---|
| date | Mon, 23 Dec 2024 12:58:03 +0100 |
| parents | fe081789f7b5 |
| children |
| rev | line source |
|---|---|
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
1 --- |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
2 summary: HTTP Strict Transport Security |
|
5414
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
3 --- |
| 1782 | 4 |
|
5414
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
5 # Introduction |
| 1782 | 6 |
|
5414
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
7 This module implements [RFC 6797: HTTP Strict Transport Security] and |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
8 responds to all non-HTTPS requests with a `301 Moved Permanently` |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
9 redirect to the HTTPS equivalent of the path. |
| 1782 | 10 |
|
5414
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
11 # Configuration |
| 1782 | 12 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
13 Add the module to the `modules_enabled` list and optionally configure |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
14 the specific header sent. |
| 1782 | 15 |
|
5414
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
16 ``` lua |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
17 modules_enabled = { |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
18 ... |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
19 "strict_https"; |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
20 } |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
21 hsts_header = "max-age=31556952" |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
22 ``` |
| 1782 | 23 |
|
5415
f8797e3284ff
mod_strict_https: Add way to disable redirect
Kim Alvefur <zash@zash.se>
parents:
5414
diff
changeset
|
24 If the redirect from `http://` to `https://` causes trouble with |
|
f8797e3284ff
mod_strict_https: Add way to disable redirect
Kim Alvefur <zash@zash.se>
parents:
5414
diff
changeset
|
25 internal use of HTTP APIs it can be disabled: |
|
f8797e3284ff
mod_strict_https: Add way to disable redirect
Kim Alvefur <zash@zash.se>
parents:
5414
diff
changeset
|
26 |
|
f8797e3284ff
mod_strict_https: Add way to disable redirect
Kim Alvefur <zash@zash.se>
parents:
5414
diff
changeset
|
27 ``` lua |
|
f8797e3284ff
mod_strict_https: Add way to disable redirect
Kim Alvefur <zash@zash.se>
parents:
5414
diff
changeset
|
28 hsts_redirect = false |
|
f8797e3284ff
mod_strict_https: Add way to disable redirect
Kim Alvefur <zash@zash.se>
parents:
5414
diff
changeset
|
29 ``` |
|
f8797e3284ff
mod_strict_https: Add way to disable redirect
Kim Alvefur <zash@zash.se>
parents:
5414
diff
changeset
|
30 |
|
5414
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
31 # Compatibility |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
32 |
|
5414
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
33 ------- ------------- |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
34 trunk Should work |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
35 0.12 Should work |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
36 0.11 Should work |
|
0c8e6269ea38
mod_strict_https: Refresh README
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
37 ------- ------------- |
