X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Finspircd.conf.example;h=f07f21cdd0e4121a1a6a45393dcec45c6e058a03;hb=e0dc7691c4cff3a38bc12adf10b3709d8c4901ba;hp=f421eb0e8b469bc20db7fc47639e1d21d1ad2be3;hpb=08d2ff86b0c7ed91549d832cf3e572c8623dc8e8;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example index f421eb0e8..f07f21cdd 100644 --- a/docs/conf/inspircd.conf.example +++ b/docs/conf/inspircd.conf.example @@ -50,8 +50,7 @@ # file you include will be treated as part of the configuration file # # which includes it, in simple terms the inclusion is transparent. # # # -# All paths to config files are relative to the directory that the # -# process runs in. # +# All paths to config files are relative to the config directory. # # # # You may also include an executable file, in which case if you do so # # the output of the executable on the standard output will be added # @@ -59,6 +58,7 @@ # # # Syntax is as follows: # # # +# # # # # # # Executable include example: # @@ -121,21 +121,10 @@ #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- # # -# Enter the port and address bindings here. # +# Configure the port and address bindings here. # # # -# # -# ____ _ _____ _ _ ____ _ _ _ # -# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # -# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # -# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # -# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # -# # -# If you want to link servers to InspIRCd you must load the # -# spanningtree module! Please see the modules list for # -# information on how to load this module! If you do not load this # -# module, server ports will NOT work! # -# Listener that binds on a TCP/IP endpoint: +# TLS (SSL) listener that binds on a TCP/IP endpoint: tag that you have defined or one - # of "openssl", "gnutls", "mbedtls" if you have not defined any. See the - # docs page for the SSL module you are using for more details. + # sslprofile: If you want the port(s) in this bind tag to use TLS (SSL), set this + # to the name of a custom tag that you have defined. See the + # docs page for the TLS (SSL) module you are using for more details: + # + # GnuTLS: https://docs.inspircd.org/3/modules/ssl_gnutls#sslprofile + # mbedTLS: https://docs.inspircd.org/3/modules/ssl_mbedtls#sslprofile + # OpenSSL: https://docs.inspircd.org/3/modules/ssl_openssl#sslprofile # # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls # for GnuTLS and ssl_mbedtls for mbedTLS. - ssl="gnutls" + sslprofile="Clients" # defer: When this is non-zero, connections will not be handed over to # the daemon from the operating system before data is ready. @@ -178,6 +170,10 @@ # not have brought the network interfaces up yet. free="no"> +# Plaintext listener that binds on a TCP/IP endpoint: + + + # Listener that binds on a UNIX endpoint (not supported on Windows): # - # Listener accepting HTML5 WebSocket connections. # Requires the websocket module and SHA-1 hashing support (provided by the sha1 # module). # -# You can define a custom tag which defines the SSL configuration -# for this listener. See the docs page for the SSL module you are using for + +# You can define a custom tag which defines the TLS (SSL) configuration +# for these listeners. See the docs page for the TLS (SSL) module you are using for # more details. # -# Alternatively, you can use one of the default SSL profiles which are created +# Alternatively, you can use one of the default TLS (SSL) profiles which are created # when you have not defined any: # "openssl" (requires the ssl_openssl module) # "gnutls" (requires the ssl_gnutls module) @@ -221,9 +220,6 @@ # completely link-compatible and can be used alongside each other on each end # of the link without any significant issues. - - - #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # @@ -240,18 +236,23 @@ # Connect blocks are searched twice for each user - once when the TCP # # connection is accepted, and once when the user completes their # # registration. Most of the information (hostname, ident response, # -# password, SSL when using STARTTLS, etc) is only available during # -# the second search, so if you are trying to make a closed server, # +# password, TLS (SSL) when using STARTTLS, etc) is only available # +# during the second search. If you are trying to make a closed server # # you will probably need a connect block just for user registration. # # This can be done by using # +# To enable IRCCloud on your network uncomment this: +# + +# A connect class with set denies connections from the specified host/IP range. + deny="3ffe::0/32" -# connect:reason is the message that users will see if they match a deny block - + # reason: The message that users will see if they match a deny block. + reason="The 6bone address space is deprecated"> +# A connect class with set allows c from the specified host/IP range. + #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- # # # CIDR configuration allows detection of clones and applying of # @@ -529,8 +539,8 @@ # rehash the ircd from the shell or to terminate the ircd from the # # shell using shell scripts, perl scripts, etc... and to monitor the # # ircd's state via cron jobs. If this is a relative path, it will be # -# relative to the configuration directory, and if it is not defined, # -# the default of 'inspircd.pid' is used. # +# relative to the runtime directory, and if it is not defined, the # +# default of 'inspircd.pid' is used. # # # # @@ -651,6 +661,10 @@ # link with servers running 2.0. Defaults to yes. allowzerolimit="no" + # modesinlist: If enabled then the current channel modes will be shown + # in the /LIST response. Defaults to yes. + modesinlist="no" + # exemptchanops: Allows users with with a status mode to be exempt # from various channel restrictions. Possible restrictions are: # - anticaps Channel mode +B - blocks messages with too many capital @@ -682,8 +696,9 @@ # - stripcolor Channel mode +S - strips formatting codes from # messages (requires the stripcolor module). # - topiclock Channel mode +t - limits changing the topic to (half)ops - # You can also configure this on a per-channel basis with a channel mode. - # See m_exemptchanops in modules.conf.example for more details. + # You can also configure this on a per-channel basis with a channel mode and + # even negate the configured exemptions below. + # See exemptchanops in modules.conf.example for more details. exemptchanops="censor:o filter:o nickflood:o nonick:v regmoderated:o" # invitebypassmodes: This allows /INVITE to bypass other channel modes. @@ -715,14 +730,14 @@ # connections. If defined, it sets a soft max connections value. softlimit="12800" - # clonesonconnect: If this is set to false, we won't check for clones + # clonesonconnect: If this is set to no, we won't check for clones # on initial connection, but only after the DNS check is done. # This can be useful where your main class is more restrictive # than some other class a user can be assigned after DNS lookup is complete. # Turning this option off will make the server spend more time on users we may - # potentially not want. Normally this should be neglible, though. - # Default value is true - clonesonconnect="true" + # potentially not want. Normally this should be negligible, though. + # Default value is yes + clonesonconnect="yes" # timeskipwarn: The time period that a server clock can jump by before # operators will be warned that the server is having performance issues. @@ -823,13 +838,8 @@ # # # This configuration tag defines the maximum sizes of various types # # on IRC, such as the maximum length of a channel name, and the # -# maximum length of a channel. Note that with the exception of the # -# identmax value all values given here are the exact values you would # -# expect to see on IRC. This contrasts with the older InspIRCd # -# releases where these values would be one character shorter than # -# defined to account for a null terminator on the end of the text. # -# # -# These values should match network-wide otherwise issues will occur. # +# maximum length of a channel. These values should match network-wide # +# otherwise issues will occur. # # # # The highest safe value you can set any of these options to is 500, # # but it is recommended that you keep them somewhat # @@ -890,7 +900,7 @@ # There are many different types which may be used, and modules may # generate their own. A list of useful types: # - USERS - information relating to user connection and disconnection -# - OPER - succesful and failed oper attempts +# - OPER - successful and failed oper attempts # - KILL - kill related messages # - FILTER - messages related to filter matches (filter module) # - CONFIG - configuration related messages @@ -964,10 +974,10 @@ + reason="Don't use this nick.">