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

Make the <define> options in the example config actually useful.

Browse Source
This commit is contained in:
Sadie Powell 2024-09-05 12:13:29 +01:00
parent 0617fdfb65
commit bb05d0dd46
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/conf/inspircd.example.conf
View File

@ -68,8 +68,8 @@
# # # #
# See https://docs.inspircd.org/4/configuration/#define for a list of # # See https://docs.inspircd.org/4/configuration/#define for a list of #
# predefined config variables. # # predefined config variables. #
<define name="bindip" value="1.2.2.3"> <define name="networkDomain" value="example.com">
<define name="localips" value="&bindip;/24"> <define name="networkName" value="ExampleNet">
#-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#- #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
# # # #
@ -79,10 +79,10 @@
<server <server
# name: Hostname of your server. Does not need to resolve, but # name: Hostname of your server. Does not need to resolve, but
# does need to be correct syntax (something.somethingelse.tld). # does need to be correct syntax (something.somethingelse.tld).
name="penguin.omega.example.org" name="irc.&networkDomain;"
# description: Server description. Spaces are allowed. # description: Server description. Spaces are allowed.
description="Waddle World" description="&networkName; IRC server"
# id: The SID to use for this server. This should not be uncommented # id: The SID to use for this server. This should not be uncommented
# unless there is a SID conflict. This must be three characters long. # unless there is a SID conflict. This must be three characters long.
@ -92,7 +92,7 @@
# network: Network name given on connect to clients. # network: Network name given on connect to clients.
# Should be the same on all servers on the network. # Should be the same on all servers on the network.
network="Omega"> network="&networkName;">
#-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
@ -109,7 +109,7 @@
# email: An email address at which the server admin(s) can be contacted # email: An email address at which the server admin(s) can be contacted
# in case of issues. # in case of issues.
email="irc@example.com"> email="irc@&networkDomain;">
#-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
@ -649,7 +649,7 @@
# xlinemessage: This is the text that is sent to a user when they are # xlinemessage: This is the text that is sent to a user when they are
# banned from the server. # banned from the server.
xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help." xlinemessage="You're banned! Email irc@&networkDomain; with the ERROR line below for help."
# xlinequit: The quit message to show to opers and affected users when # xlinequit: The quit message to show to opers and affected users when
# a user is [KGZ]-lined. The variables you can use in this are: # a user is [KGZ]-lined. The variables you can use in this are:
@ -790,7 +790,7 @@
# #
# NOTE: enabling this will cause users' idle times to only be shown # NOTE: enabling this will cause users' idle times to only be shown
# when a remote whois (/WHOIS <nick> <nick>) is used. # when a remote whois (/WHOIS <nick> <nick>) is used.
#hideserver="*.example.com" #hideserver="irc.&networkDomain;"
# publicxlinequit: The quit message to show to unprivileged users when # publicxlinequit: The quit message to show to unprivileged users when
# a user is [KGZ]-lined. The variables you can use in this are: # a user is [KGZ]-lined. The variables you can use in this are: