Add more documentation to example configs [jdhore]

[user/henk/code/inspircd.git] / conf / opers.conf.example

diff --git a/conf/opers.conf.example b/conf/opers.conf.example
index 08a123fa6152cc861313280d1d9fe6332ec97f6c..9bcf6856a8fd225e98e7db91fc9abdff40755e7f 100644 (file)
--- a/conf/opers.conf.example
+++ b/conf/opers.conf.example
@@ -15,7 +15,23 @@
      name="Shutdown" 
 
      # commands: oper commands that users of this class can run.
-     commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOAD" 
+     commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOAD GUNLOADMODULE GRELOADMODULE SAJOIN SAPART SANICK SAQUIT SATOPIC" 
+
+     # privs: special privileges that users with this class may utilise.
+     #  VIEWING:
+     #   - channels/auspex: allows opers with this priv to see more detail about channels than normal users.
+     #   - users/auspex: allows opers with this priv to view more details about users than normal users.
+     #   - servers/auspex: allows opers with this priv to see more detail about server information than normal users.
+     # ACTIONS:
+     #   - users/mass-message: allows opers with this priv to PRIVMSG and NOTICE to a server mask (e.g. NOTICE $*)
+     #   - channels/high-join-limit: allows opers with this priv to join <channels:opers> total channels instead of <channels:users> total channels.
+     #   - channels/set-permanent: allows opers with this priv to set +P on channels with m_permchannels.
+     # PERMISSIONS:
+     #   - users/flood/no-throttle: allows opers with this priv to send commands without being throttled (*NOTE)
+     #   - users/flood/increased-buffers: allows opers with this priv to send and recieve data without worrying about being disconnected for exceeding limits (*NOTE)
+     #
+     # *NOTE: These privs are potantially dangerous, as they grant users with them the ability to hammer your server's CPU/RAM as much as they want, essentially.
+     privs="users/auspex channels/auspex servers/auspex users/mass-message channels/high-join-limit channels/set-permanent users/flood/no-throttle users/flood/increased-buffers"
 
      # usermodes: Oper-only usermodes that opers with this class can use.
      usermodes="*" 
@@ -23,10 +39,10 @@
      # chanmodes: Oper-only channel modes that opers with this class can use.
      chanmodes="*">
 
-<class name="ServerLink" commands="CONNECT SQUIT RCONNECT MKPASSWD MKSHA256" usermodes="*" chanmodes="*">
-<class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE" usermodes="*" chanmodes="*">
-<class name="OperChat" commands="WALLOPS GLOBOPS SETIDLE SPYLIST SPYNAMES" usermodes="*" chanmodes="*">
-<class name="HostCloak" commands="SETHOST SETIDENT SETNAME CHGHOST CHGIDENT" usermodes="*" chanmodes="*">
+<class name="ServerLink" commands="CONNECT SQUIT CONNECT MKPASSWD ALLTIME SWHOIS CLOSE JUMPSERVER LOCKSERV" usermodes="*" chanmodes="*" privs="servers/auspex">
+<class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE TLINE RLINE CHECK NICKLOCK SHUN CLONES CBAN" usermodes="*" chanmodes="*">
+<class name="OperChat" commands="WALLOPS GLOBOPS SETIDLE" usermodes="*" chanmodes="*" privs="users/mass-message">
+<class name="HostCloak" commands="SETHOST SETIDENT SETNAME CHGHOST CHGIDENT TAXONOMY" usermodes="*" chanmodes="*" privs="users/auspex">
 
 
 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
@@ -90,6 +106,14 @@
       # of types. NOTE: This is case-sensitive as well.
       type="NetAdmin">
 
+# oline with plain-text password and no comments..for all who like copy & paste
+<oper
+      name="Brain"
+      password="s3cret"
+      host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
+      #fingerprint="67:CB:9D:C0:13:24:8A:82:9B:B2:17:1E:D1:1B:EC:D4"
+      type="NetAdmin">
+
 # oline with hashed password. It is highly recommended to use hashed passwords.
 <oper 
       # name: oper login that is used to oper up (/oper name password).
@@ -97,9 +121,10 @@
       name="Brain"
 
       # hash: what hash this password is hashed with. requires the module
-      # for selected hash (m_md5.so, m_sha256.so or m_ripemd160) be
-      # loaded and the oper password hashing module (m_password_hash.so)
+      # 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".
+      # Create hashed password with: /mkpasswd <hash> <password>
       hash="sha256"
 
       # password: a hash of your password (see above option) hashed
@@ -114,4 +139,3 @@
       # type: What oper type this oline is. See the block above for list
       # of types. NOTE: This is case-sensitive as well.
       type="NetAdmin">
-