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

Make some config strings a bit more professional and use RFC reserved TLD's everywhere

Browse Source
This commit is contained in:
JD Horelick 2014-11-08 19:40:08 -05:00 committed by Attila Molnar
parent c35ad9206c
commit 2faf5ff670
4 changed files with 41 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -53,7 +53,7 @@
#<include executable="/path/to/executable parameters"> #
# #
# Executable include example: #
#<include executable="/usr/bin/wget -q -O - http://mynet.net/inspircd.conf">
#<include executable="/usr/bin/wget -q -O - http://example.com/inspircd.conf">
# #
@ -81,7 +81,7 @@
<server
# name: Hostname of your server. Does not need to resolve, but
# does need to be correct syntax (something.somethingelse.tld).
name="penguin.omega.org.za"
name="penguin.omega.example.org"
# description: Server description. Spaces are allowed.
description="Waddle World"
@ -170,7 +170,7 @@
#-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
# #
# You can configure the passwords here which you wish to use for #
# the /DIE and /RESTART commands. Only trusted IRCop's who will #
# the /DIE and /RESTART commands. Only trusted ircops who will #
# need this ability should know the die and restart password. #
# #
@ -262,7 +262,7 @@
# globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
globalmax="3"
# maxconnwarn: Enable warnings when localmax or globalmax is hit (defaults to on)
# maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
maxconnwarn="off"
# usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
@ -484,7 +484,7 @@
# matched, the banlist size defaults to 64 entries. #
# #
<banlist chan="#morons" limit="128">
<banlist chan="#largechan" limit="128">
<banlist chan="*" limit="69">
#-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
@ -572,7 +572,7 @@
# allowmismatch: Setting this option to yes will allow servers to link even
# if they don't have the same "optionally common" modules loaded. Setting this to
# yes may introduce some desyncs and weirdness.
# yes may introduce some desyncs and unwanted behaviour.
allowmismatch="no"
# defaultbind: Sets the default for <bind> tags without an address. Choices are
@ -887,10 +887,10 @@
<badhost
# host: ident@hostname to ban.
# Wildcards and CIDR (if you specify an IP) can be used.
host="*@hundredz.n.hundredz.o.1337.kiddies.example.net"
host="*@banneduser.example.net"
# reason: Reason to display when user is disconnected
reason="Too many 1337 kiddiots">
reason="Evading Bans">
<badhost host="root@*" reason="Don't IRC as root!">
<badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
@ -937,7 +937,7 @@
# #
# You should already know what to do here :) #
<die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
<die value="User error. You didn't edit your config properly. Go back and try again.">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# ____ _ _____ _ _ ____ _ _ _ #

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

@ -17,11 +17,11 @@
<link
# name: The name of the remote server. This must match
# the <server:name> value of the remote server.
name="hub.penguin.org"
name="hub.example.org"
# ipaddr: The IP address of the remote server.
# Can also be a hostname, but hostname must resolve.
ipaddr="penguin.box.com"
ipaddr="penguin.example.org"
# port: The port to connect to the server on.
# It must be bound as a server port on the other server.
@ -71,8 +71,8 @@
# A duplicate of the first link block without comments
# if you like copying & pasting.
<link name="hub.penguin.org"
ipaddr="penguin.box.com"
<link name="hub.example.org"
ipaddr="penguin.example.org"
port="7000"
allowmask="203.0.113.0/24"
timeout="300"
@ -85,7 +85,7 @@
# Link block for services. Options are the same as for the first
# link block (depending on what your services package supports).
<link name="services.antarctic.com"
<link name="services.example.com"
ipaddr="localhost"
port="7000"
allowmask="127.0.0.0/8"
@ -95,7 +95,7 @@
# Simple autoconnect block. This enables automatic connection of a server
# Recommended setup is to have leaves connect to the hub, and have no
# automatic connections started by the hub.
<autoconnect period="300" server="hub.penguin.org">
<autoconnect period="300" server="hub.example.org">
# Failover autoconnect block. If you have multiple hubs, or want your network
# to automatically link even if the hub is down, you can specify multiple
@ -103,7 +103,7 @@
# robin fashion until one succeeds. Period defines the time for restarting
# a single loop.
<autoconnect period="120"
server="hub.us.penguin.org hub.eu.penguin.org leaf.eu.penguin.org">
server="hub.us.example.org hub.eu.example.org leaf.eu.example.org">
#-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
@ -115,4 +115,4 @@
# not generate quit and connect notices, which can cut down on noise #
# to opers on the network. #
# #
<uline server="services.antarctic.com" silent="yes">
<uline server="services.example.com" silent="yes">

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

@ -22,7 +22,8 @@
# To link servers to InspIRCd, you MUST load the m_spanningtree #
# module. If you don't do this, server links will NOT work at all. #
# This is by design, to allow for the implementation of other linking #
# protocols in modules in the future. #
# protocols in modules in the future. This module is at the bottom of #
# this file. #
# #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@ -293,8 +294,9 @@
# cooldown="60">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# CAP module: Provides the CAP negotiation mechanism seen in
# ratbox-derived ircds.
# CAP module: Provides the CAP negotiation mechanism required by the
# m_sasl, m_namesx, m_uhnames, and m_ircv3 modules.
# It is also recommended for the STARTTLS support in m_ssl_gnutls.
#<module name="m_cap.so">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@ -335,12 +337,12 @@
# CGI:IRC documentation.
#
# Old style:
# <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
# <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
# <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
# <cgihost type="pass" mask="www.example.com"> # Get IP from PASS
# <cgihost type="ident" mask="otherbox.example.com"> # Get IP from ident
# <cgihost type="passfirst" mask="www.example.com"> # See the docs
# New style:
# <cgihost type="webirc" password="foobar"
# mask="somebox.mysite.com"> # Get IP from WEBIRC
# mask="somebox.example.com"> # Get IP from WEBIRC
#
# IMPORTANT NOTE:
# ---------------
@ -654,7 +656,7 @@
# vhost - Displayed host (optional).
#
#<title name="foo" password="bar" title="Official Chat Helper">
#<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
#<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
#<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@ -713,13 +715,13 @@
# redirect - Redirect the user to a different channel. #
# #
#<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
#<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
#<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
# #
# Redirects will not work if the target channel is set +L. #
# #
# Additionally, you may specify channels which are allowed, even if #
# a badchan tag specifies it would be denied: #
#<goodchan name="#godsleeps"> #
#<goodchan name="#funtimes"> #
# Glob masks are accepted here also. #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@ -854,10 +856,10 @@
# #
# See http://wiki.inspircd.org/Modules/hostchange for help. #
# #
#<host suffix="polarbears.org" separator="." prefix="">
#<hostchange mask="*@fbi.gov" action="addnick">
#<hostchange mask="*r00t@*" action="suffix">
#<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
#<host suffix="invalid.org" separator="." prefix="">
#<hostchange mask="*@42.theanswer.example.org" action="addnick">
#<hostchange mask="*root@*" action="suffix">
#<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
#<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@ -885,7 +887,7 @@
# Restrict access to the m_httpd_stats module to all but the local
# network and when the correct password is specified:
# <httpdacl path="/stats*" types="password,whitelist"
# username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
# username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
#
# Deny all connections to all but the main index page:
# <httpdacl path="/*" types="blacklist" blacklist="*">
@ -921,7 +923,7 @@
# Invite exception module: Adds support for channel invite exceptions
# (+I).
#<module name="m_inviteexception.so">
# Does a +I bypass channel +k in addition to +i?
# bypasskey: If this is enabled, exceptions will bypass +k as well as +i
#<inviteexception bypasskey="yes">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@ -1082,7 +1084,7 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Map hiding module: replaces /MAP and /LINKS output to users with a #
# message to see a website, set by maphide="http://link.to/site" in #
# message to see a website, set by maphide="http://test.org/map" in #
# the <security> tag, instead. #
#<module name="m_maphide.so">
@ -1333,7 +1335,7 @@
# password you want to hash. For example:
#
# <oper name="Brain"
# host="ident@dialup15.isp.com"
# host="ident@dialup15.isp.test.com"
# hash="sha256"
# password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
# type="NetAdmin">
@ -1849,8 +1851,8 @@
# #
# host - Vhost to set. #
#
#<vhost user="some_username" pass="some_password" host="some.host">
#<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
#<vhost user="some_username" pass="some_password" host="some.host.test.cc">
#<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host.example.com">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Watch module: Adds the WATCH command, which is used by clients to

4
docs/conf/opers.conf.example
View File

@ -129,8 +129,8 @@
# Operator with a plaintext password and no comments, for easy copy & paste.
<oper
name="Brain"
password="s3cret"
host="brain@dialup15.isp.com *@localhost *@example.com *@2001:db8::/32"
password="youshouldhashthis"
host="brain@dialup15.isp.test.com *@localhost *@example.com *@2001:db8::/32"
#fingerprint="67cb9dc013248a829bb2171ed11becd4"
type="NetAdmin">