summaryrefslogtreecommitdiff
path: root/docs/conf
diff options
context:
space:
mode:
authorPeter Powell <petpow@saberuk.com>2018-06-18 03:28:58 +0100
committerPeter Powell <petpow@saberuk.com>2018-06-18 03:35:58 +0100
commit584cbe80152ed3bb8cdbedc41c43d63cd10ca799 (patch)
tree08200da97b938ee5ef2d14788706e848b21863ce /docs/conf
parent3cd61d86de6a18a79fdd21952a67b7d1a7f9c517 (diff)
Clarify the documentation for m_httpd and m_httpd_{config,stats}.
Thanks to @SleepyEntropy for pointing out that multiple internet- accessible servers do not have these modules correctly configured.
Diffstat (limited to 'docs/conf')
-rw-r--r--docs/conf/modules.conf.example19
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index c3f074b94..a538ea879 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -890,6 +890,8 @@
# If you choose to use the m_httpd.so module, then you will need to add
# a <bind> tag with type "httpd", and load at least one of the other
# m_httpd_* modules to provide pages to display.
+# <bind address="127.0.0.1" port="8067" type="httpd">
+# <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
#
# You can adjust the timeout for HTTP connections below. All HTTP
# connections will be closed after (roughly) this many seconds.
@@ -912,13 +914,22 @@
# <httpdacl path="/*" types="blacklist" blacklist="*">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# HTTP config module: Allows the configuration of the server to be
-# viewed over HTTP. Requires m_httpd.so to be loaded for it to function.
+# HTTP config module: Allows the server configuration to be viewed over
+# HTTP via the /config path. Requires m_httpd.so to be loaded for it to
+# function.
+#
+# IMPORTANT: This module exposes extremely sensitive information about
+# your server and users so you *MUST* protect it using a local-only
+# <bind> tag and/or the m_httpd_acl.so module. See above for details.
#<module name="m_httpd_config.so">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# HTTP stats module: Provides basic stats pages over HTTP.
-# Requires m_httpd.so to be loaded for it to function.
+# HTTP stats module: Provides server statistics over HTTP via the /stats
+# path. Requires m_httpd.so to be loaded for it to function.
+#
+# IMPORTANT: This module exposes extremely sensitive information about
+# your server and users so you *MUST* protect it using a local-only
+# <bind> tag and/or the m_httpd_acl.so module. See above for details.
#<module name="m_httpd_stats.so">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#