X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fconf%2Fmodules.conf.example;h=ae32bb0e0a0a03350dc32c70396e9b80f18fdb59;hb=0d33e174a4ac49e54f73e4375e7702e13a1cf34c;hp=dec54ec65b03f65145ba78f95b248361ccf8e72a;hpb=ade19f79c5a3bee9fa0d422d86945a942087e827;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index dec54ec65..ae32bb0e0 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -116,6 +116,10 @@ # to successfully trigger. If they are not, then # # the user receives a 'no such nick' 401 numeric. # # # +# stripcolor - If this is true, the text from the user will be # +# stripped of color and format codes before # +# matching against 'text'. # +# # # uline - Setting this to true will ensure that the user # # given in 'requires' is also on a U-lined server, # # as well as actually being on the network. If the # @@ -173,7 +177,7 @@ # users that send overly capitalised messages to channels. Unlike the # blockcaps module this module is more flexible as it has more options # for punishment and allows channels to configure their own punishment -# policies. +# policies. # # # You may also configure the characters which anticaps considers to be @@ -420,10 +424,11 @@ # # Set the maximum number of lines allowed to be stored per channel below. # This is the hard limit for 'X'. -# If notice is set to yes, joining users will get a NOTICE before playback -# telling them about the following lines being the pre-join history. +# If prefixmsg is set to yes, joining users without batch support will get +# a NOTICE before playback telling them about the following lines being +# the pre-join history. # If bots is set to yes, it will also send to users marked with +B -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel logging module: Used to send snotice output to channels, to @@ -550,11 +555,13 @@ # +# prefix="net-" +# ignorecase="no"> # # +# prefix="net-" +# ignorecase="no"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Clones module: Adds an oper command /CLONES for detecting cloned @@ -564,6 +571,20 @@ # To use, CLONES must be in one of your oper class blocks. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Codepage module: Allows using a custom 8-bit codepage for nicknames +# and case mapping. +# +# You should include one of the following files to set your codepage: +# +# +# +# +# +# You can also define a custom codepage. For details on how to do this +# please refer to the docs site: +# https://docs.inspircd.org/3/modules/codepage + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Common channels module: Adds user mode +c, which, when set, requires # that users must share a common channel with you to PRIVMSG or NOTICE @@ -611,7 +632,7 @@ # killonbadreply - Whether to kill the user if they send the wrong # # PONG reply. # # # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel cycle module: Adds the /CYCLE command which is a server-side @@ -653,7 +674,7 @@ # the throttling when the server just booted. # # +# quitmsg="Throttled" bootwait="2m"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Custom prefixes: Allows for channel prefixes to be configured. @@ -675,7 +696,7 @@ # You can also override the configuration of prefix modes added by both the core # and other modules by adding a customprefix tag with change="yes" specified. # -# +# # # Do /RELOADMODULE customprefix after changing the settings of this module. @@ -922,7 +943,7 @@ # other modules that need it using the libMaxMindDB library. # # # # This module is in extras. Re-run configure with: # -# ./configure --enable-extras=m_geo_maxmind.cpp +# ./configure --enable-extras geo_maxmind # and run make install, then uncomment this module to enable it. # # # # This module requires libMaxMindDB to be installed on your system. # @@ -1156,7 +1177,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # IRCv3 client-to-client tags module: Provides the message-tags IRCv3 -# extension which allows clients to add extra data to their messages. +# extension which allows clients to add extra data to their messages. # This is used to support new IRCv3 features such as replies and ids. # @@ -1173,6 +1194,12 @@ # another user into a channel. This respects . # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# IRCv3 labeled-response module: Provides the labeled-response IRCv3 +# extension which allows server responses to be associated with the +# client message which caused them to be sent. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # IRCv3 message id module: Provides the msgid IRCv3 extension which # adds a unique identifier to each message when the message-tags cap @@ -1235,7 +1262,7 @@ # LDAP module: Allows other SQL modules to access a LDAP database # through a unified API. # This modules is in extras. Re-run configure with: -# ./configure --enable-extras=m_ldap.cpp +# ./configure --enable-extras ldap # and run make install, then uncomment this module to enable it. # # @@ -1379,7 +1406,7 @@ # MySQL module: Allows other SQL modules to access MySQL databases # through a unified API. # This module is in extras. Re-run configure with: -# ./configure --enable-extras=m_mysql.cpp +# ./configure --enable-extras mysql # and run make install, then uncomment this module to enable it. # # @@ -1407,6 +1434,9 @@ # National characters module: # 1) Allows using national characters in nicknames. # 2) Allows using custom (national) casemapping over the network. +# +# This module is incredibly poorly written and documented. You should +# probably use the codepage module instead for 8-bit codepages. # # # file - Location of the file which contains casemapping rules. If this @@ -1658,7 +1688,12 @@ # # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be # saved. Defaults to false. -# +# +# 'saveperiod' determines how often to check if the database needs to be +# saved to disk. Defaults to every five seconds. +# # # # You may also create channels on startup by using the block. @@ -1668,7 +1703,7 @@ # PostgreSQL module: Allows other SQL modules to access PgSQL databases # through a unified API. # This module is in extras. Re-run configure with: -# ./configure --enable-extras=m_pgsql.cpp +# ./configure --enable-extras pgsql # and run make install, then uncomment this module to enable it. # # @@ -2090,7 +2125,7 @@ # SSL rehash signal module: Allows the SSL modules to be rehashed by # sending SIGUSR1 to a running InspIRCd process. # This modules is in extras. Re-run configure with: -# ./configure --enable-extras=m_sslrehashsignal.cpp +# ./configure --enable-extras sslrehashsignal # and run make install, then uncomment this module to enable it. # @@ -2167,7 +2202,7 @@ # SQLite3 module: Allows other SQL modules to access SQLite3 # # databases through a unified API. # # This module is in extras. Re-run configure with: # -# ./configure --enable-extras=m_sqlite3.cpp +# ./configure --enable-extras sqlite3 # and run make install, then uncomment this module to enable it. # # # @@ -2296,11 +2331,18 @@ # Requires SHA-1 hash support available in the sha1 module. # # -# Whether to re-encode messages as UTF-8 before sending to WebSocket -# clients. This is recommended as the WebSocket protocol requires all -# text frames to be sent as UTF-8. If you do not have this enabled -# messages will be sent as binary frames instead. -# +# proxyranges: A space-delimited list of glob or CIDR matches to trust +# the X-Real-IP or X-Forwarded-For headers from. If enabled +# the server will use the IP address specified by those HTTP +# headers. You should NOT enable this unless you are using +# a HTTP proxy like nginx as it will allow IP spoofing. +# sendastext: Whether to re-encode messages as UTF-8 before sending to +# WebSocket clients. This is recommended as the WebSocket +# protocol requires all text frames to be sent as UTF-8. +# If you do not have this enabled messages will be sent as +# binary frames instead. +# # # If you use the websocket module you MUST specify one or more origins # which are allowed to connect to the server. You should set this as @@ -2316,8 +2358,9 @@ # be a lot less bans to apply - as most of them will already be there. # -# Specify the filename for the xline database here. -# +# Specify the filename for the xline database and how often to check whether +# the database needs to be saved here. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # ____ _ _____ _ _ ____ _ _ _ #