From 2089dfce5734a21ccdbbe133cb8499e2168cd281 Mon Sep 17 00:00:00 2001
From: danieldg <danieldg@e03df62e-2008-0410-955e-edbf42e46eb7>
Date: Wed, 4 Mar 2009 00:07:56 +0000
Subject: [PATCH] Add more documentation to example configs [jdhore]

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@11165 e03df62e-2008-0410-955e-edbf42e46eb7
---
 conf/inspircd.conf.example | 22 +++++++++++++++++++---
 conf/modules.conf.example  | 10 ++++++++++
 conf/opers.conf.example    |  3 ++-
 3 files changed, 31 insertions(+), 4 deletions(-)

diff --git a/conf/inspircd.conf.example b/conf/inspircd.conf.example
index ca218c4a1b..1cfbeb40b0 100644
--- a/conf/inspircd.conf.example
+++ b/conf/inspircd.conf.example
@@ -161,7 +161,15 @@
 #   need this ability should know the die and restart password.       #
 #                                                                     #
 
-<power 
+<power
+       # hash: what hash these passwords are hashed with. requires the module
+       # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
+       # loaded and the password hashing module (m_password_hash.so)
+       # loaded. Options here are: "md5", "sha256" and "ripemd160".
+       # Optional, but recommended. Create hashed password with:
+       # /mkpasswd <hash> <password>
+       #hash="sha256"
+
        # diepass: Password for opers to use if they need to shutdown (die)
        # a server.
        diepass="" 
@@ -192,10 +200,18 @@
 
 <connect 
          # allow: What IP addresses/hosts to allow for this block.
-         allow="196.12.*"  
+         allow="196.12.*"
+
+         # hash: what hash this password is hashed with. requires the module
+         # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
+         # loaded and the password hashing module (m_password_hash.so)
+         # loaded. Options here are: "md5", "sha256" and "ripemd160".
+         # Optional, but recommended. Create hashed password with:
+         # /mkpasswd <hash> <password>
+         #hash="sha256"
 
          # password: Password to use for this block/user(s)
-         password="secret" 
+         password="secret"
 
          # port: What port this user is allowed to connect on. (optional)
          # The port MUST be set to listen in the bind blocks above.
diff --git a/conf/modules.conf.example b/conf/modules.conf.example
index 0eb5a290a1..2b99e5b6e5 100644
--- a/conf/modules.conf.example
+++ b/conf/modules.conf.example
@@ -594,12 +594,15 @@
 #-#-#-#-#-#-#-#-#-#-  CUSTOM TITLE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#
 #  name              - The username used to identify 
 #  password          - The password used to identify
+#  hash              - The hash for the specific user's password (optional)
+#                      m_password_hash.so and a hashing module must be loaded for this to work
 #  host              - Allowed hostmask [optional]
 #  title             - Title shown in whois
 #  vhost             - Displayed host [optional]
 #
 #<title name="foo" password="bar" title="Official Chat Helper">
 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
+#<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # DCCALLOW module: Adds the /DCCALLOW command
@@ -694,6 +697,9 @@
 #                                                                     #
 # Your choice of regex engine must match on all servers network-wide.
 #
+# You may specify specific channels that are exempt from being filtered:
+#<exemptfromfilter channel="#blah">
+#
 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 # Optional - If you specify to use the m_filter module, then          #
@@ -1716,10 +1722,14 @@
 # user       - Username for the vhost.                                #
 #                                                                     #
 # pass       - Password for the vhost.                                #
+#								      #
+# hash       - The hash for the specific user (optional)
+#              m_password_hash.so and a hashing module must be loaded for this to work
 #                                                                     #
 # host       - Vhost to set.                                          #
 #
 #<vhost user="some_username" pass="some_password" host="some.host">
+#<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Watch module: Adds the WATCH command, which is used by clients to 
diff --git a/conf/opers.conf.example b/conf/opers.conf.example
index 957b412848..9bcf6856a8 100644
--- a/conf/opers.conf.example
+++ b/conf/opers.conf.example
@@ -122,8 +122,9 @@
 
       # hash: what hash this password is hashed with. requires the module
       # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
-      # loaded and the oper password hashing module (m_password_hash.so)
+      # loaded and the password hashing module (m_password_hash.so)
       # loaded. Options here are: "md5", "sha256" and "ripemd160".
+      # Create hashed password with: /mkpasswd <hash> <password>
       hash="sha256"
 
       # password: a hash of your password (see above option) hashed