1
0
mirror of https://github.com/anope/anope.git synced 2026-07-09 14:03:13 +02:00

Document which modules are extra and how to enable them

This commit is contained in:
Adam
2013-12-09 21:18:01 -05:00
parent 1b4d62e2bc
commit 50f430fb23
+19 -16
View File
@@ -4,6 +4,9 @@
* The following blocks are used to load all non-core modules, including 3rd-party modules.
* Modules can be prevented from loading by commenting out the line, other modules can be added by
* adding a module block. These modules will be loaded prior to Services connecting to your network.
*
* Note that some of these modules are labeled EXTRA, and must be enabled prior to compiling by
* running the 'extras' script on Linux and UNIX.
*/
/*
@@ -156,7 +159,7 @@ module { name = "help" }
}
/*
* m_httpd
* m_httpd [EXTRA]
*
* Allows services to serve web pages. By itself, this module does nothing useful.
*
@@ -197,7 +200,7 @@ module { name = "help" }
}
/*
* m_ldap
* m_ldap [EXTRA]
*
* This module allows other modules to use LDAP. By itself, this module does nothing useful.
*/
@@ -219,7 +222,7 @@ module { name = "help" }
}
/*
* m_ldap_authentication
* m_ldap_authentication [EXTRA]
*
* This module allows many commands such as IDENTIFY, RELEASE, RECOVER, GHOST, etc. use
* LDAP to authenticate users. Requires m_ldap.
@@ -277,7 +280,7 @@ module { name = "help" }
}
/*
* m_ldap_oper
* m_ldap_oper [EXTRA]
*
* This module dynamically ties users to Anope opertypes when they identify
* via LDAP group membership. Requires m_ldap.
@@ -318,7 +321,7 @@ module { name = "help" }
}
/*
* m_mysql
* m_mysql [EXTRA]
*
* This module allows other modules to use MySQL.
*/
@@ -339,7 +342,7 @@ module { name = "help" }
}
/*
* m_proxyscan
* m_proxyscan [EXTRA]
*
* This module allows you to scan connecting clients for open proxies.
* Note that using this will allow users to get the IP of your services.
@@ -421,7 +424,7 @@ module { name = "help" }
}
/*
* m_sql_authentication
* m_sql_authentication [EXTRA]
*
* This module allows authenticating users against an external SQL database using a custom
* query.
@@ -486,7 +489,7 @@ module { name = "help" }
#module { name = "m_sql_log" }
/*
* m_sql_oper
* m_sql_oper [EXTRA]
*
* This module allows granting users services operator privileges and possibly IRC Operator
* privileges based on an external SQL database using a custom query.
@@ -512,7 +515,7 @@ module { name = "help" }
}
/*
* m_sqlite
* m_sqlite [EXTRA]
*
* This module allows other modules to use SQLite.
*/
@@ -557,14 +560,14 @@ module { name = "help" }
}
/*
* m_regex_pcre
* m_regex_pcre [EXTRA]
*
* Provides the regex engine regex/pcre, which uses the Perl Compatible Regular Expressions library.
*/
#module { name = "m_regex_pcre" }
/*
* m_regex_posix
* m_regex_posix [EXTRA]
*
* Provides the regex engine regex/posix, which uses the POSIX compliant regular expressions.
* This is likely the only regex module you will not need extra libraries for.
@@ -572,7 +575,7 @@ module { name = "help" }
#module { name = "m_regex_posix" }
/*
* m_regex_tre
* m_regex_tre [EXTRA]
*
* Provides the regex engine regex/tre, which uses the TRE regex library.
*/
@@ -609,7 +612,7 @@ module { name = "help" }
}
/*
* m_ssl
* m_ssl [EXTRA]
*
* This module uses SSL to connect to the uplink server(s).
*/
@@ -630,7 +633,7 @@ module { name = "help" }
}
/*
* m_xmlrpc
* m_xmlrpc [EXTRA]
*
* Allows remote applications (websites) to execute queries in real time to retrieve data from Anope.
* By itself this module does nothing, but allows other modules (m_xmlrpc_main) to receive and send XMLRPC queries.
@@ -644,7 +647,7 @@ module { name = "help" }
}
/*
* m_xmlrpc_main
* m_xmlrpc_main [EXTRA]
*
* Adds the main XMLRPC core functions.
* Requires m_xmlrpc.
@@ -652,7 +655,7 @@ module { name = "help" }
#module { name = "m_xmlrpc_main" }
/*
* webcpanel
* webcpanel [EXTRA]
*
* This module creates a web configuration panel that allows users and operators to perform any task
* as they could over IRC. If you are using the default configuration you should be able to access