X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Finspircd.conf.example;h=f07f21cdd0e4121a1a6a45393dcec45c6e058a03;hb=e0dc7691c4cff3a38bc12adf10b3709d8c4901ba;hp=e3f3185d531ddab6949714aa54587c3bd83779d6;hpb=4be144252bf894e6a964a12d7dbc12f91ced908b;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example index e3f3185d5..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,20 +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! # +# 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 - # wiki 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. @@ -175,24 +168,49 @@ # whether the interface that provides the bind address is available. This # is useful for if you are starting InspIRCd on boot when the server may # not have brought the network interfaces up yet. - free="no" -> + 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). # -# EXPERIMENTAL: Listener that binds on a UNIX endpoint instead of a TCP/IP endpoint: -# -# You can define a custom tag which defines the SSL configuration -# for this listener. See the wiki 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) @@ -202,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 -#-#-#-#-#-#-#-#-#-#-# # # @@ -221,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. or @@ -346,14 +388,14 @@ allow="*" # maxchans: Maximum number of channels a user in this class - # be in at one time. + # can be in at one time. maxchans="20" # timeout: How long the server will wait before disconnecting # a user if they do not do anything on connect. # (Note, this is a client-side thing, if the client does not # send /NICK, /USER or /PASS) - timeout="10" + timeout="20" # pingfreq: How often the server tries to ping connecting clients. pingfreq="2m" @@ -394,7 +436,7 @@ # immediately killing them; their commands are held in the recvq and processed later # as the user's command penalty drops. Note that if this is enabled, flooders will # quit with "RecvQ exceeded" rather than "Excess Flood". - fakelag="on" + fakelag="yes" # localmax: Maximum local connections per IP. localmax="3" @@ -409,10 +451,14 @@ # useident: Defines if users in this class must respond to a ident query or not. useident="no" + # usests: Whether a STS policy should be advertised to users in this class. + # This setting only has effect when the ircv3_sts module is loaded. + #usests="no" + # limit: How many users are allowed in this class limit="5000" - # modes: Usermodes that are set on users in this block on connect. + # modes: User modes that are set on users in this block on connect. # Enabling this option requires that the conn_umodes module be loaded. # This entry is highly recommended to use for/with IP cloaking/masking. # For the example to work, this also requires that the cloaking @@ -420,6 +466,7 @@ modes="+x"> + #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- # # # CIDR configuration allows detection of clones and applying of # @@ -447,11 +494,11 @@ # This file has all the information about oper classes, types and o:lines. # You *MUST* edit it. - +# # This file has all the information about server links and ulined servers. # You *MUST* edit it if you intend to link servers. - +# #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # @@ -492,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. # # # # @@ -614,8 +661,14 @@ # 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 + # letters (requires the anticaps module). # - auditorium-see Permission required to see the full user list of # a +u channel (requires the auditorium module). # - auditorium-vis Permission required to be visible in a +u channel @@ -643,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. @@ -676,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. @@ -772,7 +826,7 @@ restrictbannedusers="yes" # genericoper: Setting this value to yes makes all opers on this server - # appear as 'is an IRC operator' in their WHOIS, regardless of their + # appear as 'is a server operator' in their WHOIS, regardless of their # oper type, however oper types are still used internally. This only # affects the display in WHOIS. genericoper="no" @@ -784,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 # @@ -851,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 @@ -925,10 +974,10 @@ + reason="Don't use this nick."> @@ -992,7 +1041,7 @@ # provide almost all the features of InspIRCd. :) # # # # The default does nothing -- we include it for simplicity for you. # - +# #-#-#-#-#-#-#-#-#-#-#-# SERVICES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-# # #