diff mod_secure_interfaces/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_secure_interfaces/README.wiki@29f3d6b7ad16
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_secure_interfaces/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,42 @@
+---
+labels:
+- 'Stage-Beta'
+summary: 'Mark some network interfaces (e.g. loopback/LAN) as always secure'
+...
+
+Introduction
+============
+
+Sometimes you might run clients without encryption on the same machine
+or LAN as Prosody - and you want Prosody to treat them as secure (e.g.
+allowing plaintext authentication) even though they are not encrypted.
+
+This module allows you to tell Prosody which of the current server's
+interfaces (IP addresses) that you consider to be on secure networks.
+
+Configuration
+=============
+
+Configuration is simple, just load the module like any other by adding
+it to your modules\_enabled list:
+
+        modules_enabled = {
+            ...
+            "secure_interfaces";
+            ...
+        }
+
+Then set the list of secure interfaces (just make sure it is set in the
+global section of your config file, and **not** under a VirtualHost or
+Component):
+
+        secure_interfaces = { "127.0.0.1", "::1", "192.168.1.54" }
+
+Compatibility
+=============
+
+  ------- ---------
+  0.9     Works
+  0.8     Unknown
+  trunk   Works
+  ------- ---------