ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-10 02:59:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document how users should enable extra modules better.

Browse Source
This commit is contained in:
Sadie Powell 2023-01-24 03:02:10 +00:00
parent f310e1c98d
commit d19a5dc83b
1 changed files with 78 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
docs/conf/modules.conf.example
View File

@ -1010,13 +1010,15 @@
# MaxMindDB geolocation module: Provides geolocation information for # # MaxMindDB geolocation module: Provides geolocation information for #
# other modules that need it using the libMaxMindDB library. # # other modules that need it using the libMaxMindDB library. #
# # # #
# This module is in extras. Re-run configure with: # # This module depends on a third-party library (libmaxminddb) and may #
# ./configure --enable-extras geo_maxmind # need to be manually enabled at build time. If you are building from #
# and run make install, then uncomment this module to enable it. # # source you can do this by installing this dependency and running: #
# # # #
# This module requires libMaxMindDB to be installed on your system. # # ./configure --enable-extras geo_maxmind #
# Use your package manager to find the appropriate packages or check # # make install #
# the InspIRCd documentation page for this module. # # #
# Users of binary packages should consult the documentation for their #
# package to find out whether this module is available. #
#<module name="geo_maxmind"> #<module name="geo_maxmind">
# # # #
# If you use the geo_maxmind module you MUST provide a database file # # If you use the geo_maxmind module you MUST provide a database file #
@ -1347,11 +1349,18 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# LDAP module: Allows other SQL modules to access a LDAP database # LDAP module: Allows other SQL modules to access a LDAP database
# through a unified API. # through a unified API.
# This modules is in extras. Re-run configure with:
# ./configure --enable-extras ldap
# and run make install, then uncomment this module to enable it.
# #
# This module depends on a third-party library (OpenLDAP) and may need
# to be manually enabled at build time. If you are building from source
# you can do this by installing this dependency and running:
#
# ./configure --enable-extras ldap
# make install
#
# Users of binary packages should consult the documentation for their
# package to find out whether this module is available.
#<module name="ldap"> #<module name="ldap">
#
#<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree"> #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
# The server parameter indicates the LDAP server to connect to. The # # The server parameter indicates the LDAP server to connect to. The #
# ldap:// style scheme before the hostname proper is MANDATORY. # # ldap:// style scheme before the hostname proper is MANDATORY. #
@ -1443,8 +1452,16 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# JSON logging module: Allows writing messages to a JSON file. # # JSON logging module: Allows writing messages to a JSON file. #
# This module is in extras. Re-run configure with: # # #
# ./configure --enable-extras log_json # This module depends on a third-party library (RapidJSON) and may #
# need to be manually enabled at build time. If you are building from #
# source you can do this by installing this dependency and running: #
# #
# ./configure --enable-extras log_json #
# make install #
# #
# Users of binary packages should consult the documentation for their #
# package to find out whether this module is available. #
#<module name="log_json"> #<module name="log_json">
# #
#<log method="json" #<log method="json"
@ -1478,8 +1495,16 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Syslog logging module: Allows writing messages to the system log. # # Syslog logging module: Allows writing messages to the system log. #
# This module is in extras. Re-run configure with: # # #
# ./configure --enable-extras log_syslog # This module depends on a POSIX component (syslog) and may need to #
# be manually enabled at build time. If you are building from source #
# you can do this by running: #
# #
# ./configure --enable-extras log_syslog #
# make install #
# #
# Users of binary packages should consult the documentation for their #
# package to find out whether this module is available. #
#<module name="log_syslog"> #<module name="log_syslog">
# #
#<log method="syslog" #<log method="syslog"
@ -1520,9 +1545,16 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# MySQL module: Allows other SQL modules to access MySQL databases # MySQL module: Allows other SQL modules to access MySQL databases
# through a unified API. # through a unified API.
# This module is in extras. Re-run configure with: #
# This module depends on a third-party library (libmysqlclient) and may
# need to be manually enabled at build time. If you are building from
# source you can do this by installing this dependency and running:
#
# ./configure --enable-extras mysql # ./configure --enable-extras mysql
# and run make install, then uncomment this module to enable it. # make install
#
# Users of binary packages should consult the documentation for their
# package to find out whether this module is available.
#<module name="mysql"> #<module name="mysql">
# #
#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
@ -1806,9 +1838,16 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# PostgreSQL module: Allows other SQL modules to access PgSQL databases # PostgreSQL module: Allows other SQL modules to access PgSQL databases
# through a unified API. # through a unified API.
# This module is in extras. Re-run configure with: #
# This module depends on a third-party library (libpq) and may need to
# be manually enabled at build time. If you are building from source
# you can do this by installing this dependency and running:
#
# ./configure --enable-extras pgsql # ./configure --enable-extras pgsql
# and run make install, then uncomment this module to enable it. # make install
#
# Users of binary packages should consult the documentation for their
# package to find out whether this module is available.
#<module name="pgsql"> #<module name="pgsql">
# #
#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
@ -2249,9 +2288,16 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# TLS rehash signal module: Allows the TLS modules to be rehashed by # TLS rehash signal module: Allows the TLS modules to be rehashed by
# sending SIGUSR1 to a running InspIRCd process. # sending SIGUSR1 to a running InspIRCd process.
# This module is in extras. Re-run configure with: #
# This module depends on a POSIX component (SIGUSR1) and may need to be
# manually enabled at build time. If you are building from source you
# can do this by running:
#
# ./configure --enable-extras sslrehashsignal # ./configure --enable-extras sslrehashsignal
# and run make install, then uncomment this module to enable it. # make install
#
# Users of binary packages should consult the documentation for their
# package to find out whether this module is available.
#<module name="sslrehashsignal"> #<module name="sslrehashsignal">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@ -2329,10 +2375,16 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# SQLite3 module: Allows other SQL modules to access SQLite3 # # SQLite3 module: Allows other SQL modules to access SQLite3 #
# databases through a unified API. # # databases through a unified API. #
# This module is in extras. Re-run configure with: # # #
# ./configure --enable-extras sqlite3 # This module depends on a third-party library (SQLite) and may need #
# and run make install, then uncomment this module to enable it. # # to be manually enabled at build time. If you are building from #
# # source you can do this by installing this dependency and running: #
# #
# ./configure --enable-extras sqlite3 #
# make install #
# #
# Users of binary packages should consult the documentation for their #
# package to find out whether this module is available. #
#<module name="sqlite3"> #<module name="sqlite3">
# #
#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#