From f2acdbc3820f0f4f5ef76a0a64e73d2a320df91f Mon Sep 17 00:00:00 2001 From: peavey Date: Mon, 16 Jul 2007 17:30:04 +0000 Subject: [PATCH] OOPS! We try again, since I'm smoking craq. LF is 0x0a NOT CR. git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7456 e03df62e-2008-0410-955e-edbf42e46eb7 --- conf/aliases/anope.conf.example | 26 +- conf/aliases/atheme.conf.example | 20 +- conf/aliases/ircservices.conf.example | 20 +- conf/inspircd.censor.example | 16 +- conf/inspircd.filter.example | 53 +- conf/inspircd.helpop-full.example | 520 ++- conf/inspircd.helpop.example | 84 +- conf/inspircd.motd.example | 41 +- conf/inspircd.quotes.example | 176 +- conf/inspircd.rules.example | 4 +- configure | 1803 +++++++- docs/COPYING | 347 +- docs/README | 11 +- docs/inspircd.conf.example | 2196 +++++++++- docs/rfc/rfc1035.txt | 3078 +++++++++++++- docs/rfc/rfc1413.txt | 452 +- docs/rfc/rfc1459.txt | 3644 ++++++++++++++++- extras/m_sqllog.mysql.sql | 79 +- extras/m_sqllog.postgresql.sql | 52 +- extras/m_sqllog.sqlite3.sql | 35 +- extras/m_sqloper.mysql.sql | 25 +- extras/m_sqloper.postgresql.sql | 15 +- extras/m_sqloper.sqlite3.sql | 8 +- http/index.html | 13 +- include/base.h | 229 +- include/channels.h | 552 ++- include/command_parse.h | 245 +- include/commands/cmd_admin.h | 45 +- include/commands/cmd_away.h | 46 +- include/commands/cmd_clearcache.h | 45 +- include/commands/cmd_commands.h | 46 +- include/commands/cmd_connect.h | 46 +- include/commands/cmd_die.h | 46 +- include/commands/cmd_eline.h | 46 +- include/commands/cmd_gline.h | 46 +- include/commands/cmd_info.h | 46 +- include/commands/cmd_invite.h | 46 +- include/commands/cmd_ison.h | 46 +- include/commands/cmd_join.h | 46 +- include/commands/cmd_kick.h | 46 +- include/commands/cmd_kill.h | 46 +- include/commands/cmd_kline.h | 46 +- include/commands/cmd_links.h | 46 +- include/commands/cmd_list.h | 46 +- include/commands/cmd_loadmodule.h | 46 +- include/commands/cmd_lusers.h | 46 +- include/commands/cmd_map.h | 46 +- include/commands/cmd_mode.h | 45 +- include/commands/cmd_modules.h | 46 +- include/commands/cmd_motd.h | 49 +- include/commands/cmd_names.h | 46 +- include/commands/cmd_nick.h | 46 +- include/commands/cmd_notice.h | 46 +- include/commands/cmd_oper.h | 48 +- include/commands/cmd_part.h | 46 +- include/commands/cmd_pass.h | 49 +- include/commands/cmd_ping.h | 46 +- include/commands/cmd_pong.h | 47 +- include/commands/cmd_privmsg.h | 46 +- include/commands/cmd_qline.h | 46 +- include/commands/cmd_quit.h | 46 +- include/commands/cmd_rehash.h | 46 +- include/commands/cmd_reloadmodule.h | 46 +- include/commands/cmd_restart.h | 49 +- include/commands/cmd_rules.h | 49 +- include/commands/cmd_server.h | 46 +- include/commands/cmd_squit.h | 49 +- include/commands/cmd_stats.h | 49 +- include/commands/cmd_summon.h | 49 +- include/commands/cmd_time.h | 46 +- include/commands/cmd_topic.h | 46 +- include/commands/cmd_trace.h | 46 +- include/commands/cmd_unloadmodule.h | 46 +- include/commands/cmd_user.h | 46 +- include/commands/cmd_userhost.h | 46 +- include/commands/cmd_users.h | 49 +- include/commands/cmd_version.h | 46 +- include/commands/cmd_wallops.h | 46 +- include/commands/cmd_who.h | 60 +- include/commands/cmd_whois.h | 49 +- include/commands/cmd_whowas.h | 145 +- include/commands/cmd_zline.h | 46 +- include/configreader.h | 791 +++- include/connection.h | 80 +- include/ctables.h | 173 +- include/cull_list.h | 163 +- include/dns.h | 521 ++- include/dynamic.h | 128 +- include/exitcodes.h | 46 +- include/globals.h | 40 +- include/hash_map.h | 34 +- include/hashcomp.h | 711 +++- include/inspircd.h | 1280 +++++- include/inspsocket.h | 438 +- include/inspstring.h | 57 +- include/mode.h | 520 ++- include/modes/cmode_b.h | 36 +- include/modes/cmode_h.h | 35 +- include/modes/cmode_i.h | 26 +- include/modes/cmode_k.h | 30 +- include/modes/cmode_l.h | 28 +- include/modes/cmode_m.h | 26 +- include/modes/cmode_n.h | 26 +- include/modes/cmode_o.h | 35 +- include/modes/cmode_p.h | 26 +- include/modes/cmode_s.h | 26 +- include/modes/cmode_t.h | 26 +- include/modes/cmode_v.h | 35 +- include/modes/umode_i.h | 27 +- include/modes/umode_n.h | 26 +- include/modes/umode_o.h | 27 +- include/modes/umode_s.h | 27 +- include/modes/umode_w.h | 27 +- include/modules.h | 1697 +++++++- include/snomasks.h | 86 +- include/socket.h | 226 +- include/socketengine.h | 297 +- include/socketengine_epoll.h | 65 +- include/socketengine_iocp.h | 227 +- include/socketengine_kqueue.h | 69 +- include/socketengine_ports.h | 69 +- include/socketengine_select.h | 70 +- include/timer.h | 157 +- include/typedefs.h | 54 +- include/u_listmode.h | 475 ++- include/users.h | 1032 ++++- include/wildcard.h | 46 +- include/xline.h | 531 ++- make/configure.pm | 283 +- make/gnutlscert.pm | 116 +- make/opensslcert.pm | 37 +- make/utilities.pm | 384 +- src/base.cpp | 96 +- src/channels.cpp | 1068 ++++- src/cmd_admin.cpp | 36 +- src/cmd_away.cpp | 43 +- src/cmd_clearcache.cpp | 32 +- src/cmd_commands.cpp | 34 +- src/cmd_connect.cpp | 34 +- src/cmd_die.cpp | 48 +- src/cmd_eline.cpp | 78 +- src/cmd_gline.cpp | 90 +- src/cmd_info.cpp | 76 +- src/cmd_invite.cpp | 99 +- src/cmd_ison.cpp | 87 +- src/cmd_join.cpp | 53 +- src/cmd_kick.cpp | 59 +- src/cmd_kill.cpp | 118 +- src/cmd_kline.cpp | 89 +- src/cmd_links.cpp | 33 +- src/cmd_list.cpp | 86 +- src/cmd_loadmodule.cpp | 40 +- src/cmd_lusers.cpp | 43 +- src/cmd_map.cpp | 36 +- src/cmd_mode.cpp | 32 +- src/cmd_modules.cpp | 76 +- src/cmd_motd.cpp | 30 +- src/cmd_names.cpp | 55 +- src/cmd_nick.cpp | 190 +- src/cmd_notice.cpp | 159 +- src/cmd_oper.cpp | 154 +- src/cmd_part.cpp | 44 +- src/cmd_pass.cpp | 43 +- src/cmd_ping.cpp | 29 +- src/cmd_pong.cpp | 29 +- src/cmd_privmsg.cpp | 165 +- src/cmd_qline.cpp | 81 +- src/cmd_quit.cpp | 49 +- src/cmd_rehash.cpp | 57 +- src/cmd_reloadmodule.cpp | 40 +- src/cmd_restart.cpp | 50 +- src/cmd_rules.cpp | 28 +- src/cmd_server.cpp | 31 +- src/cmd_squit.cpp | 33 +- src/cmd_stats.cpp | 319 +- src/cmd_summon.cpp | 28 +- src/cmd_time.cpp | 41 +- src/cmd_topic.cpp | 119 +- src/cmd_trace.cpp | 47 +- src/cmd_unloadmodule.cpp | 40 +- src/cmd_user.cpp | 70 +- src/cmd_userhost.cpp | 64 +- src/cmd_users.cpp | 28 +- src/cmd_version.cpp | 32 +- src/cmd_wallops.cpp | 32 +- src/cmd_who.cpp | 329 +- src/cmd_whois.cpp | 145 +- src/cmd_whowas.cpp | 342 +- src/cmd_zline.cpp | 81 +- src/command_parse.cpp | 564 ++- src/commands.cpp | 112 +- src/configreader.cpp | 1715 +++++++- src/cull_list.cpp | 203 +- src/dns.cpp | 1170 +++++- src/dynamic.cpp | 90 +- src/hashcomp.cpp | 620 ++- src/helperfuncs.cpp | 535 ++- src/inspircd.cpp | 1308 +++++- src/inspsocket.cpp | 751 +++- src/inspstring.cpp | 138 +- src/mode.cpp | 1067 ++++- src/modes/Makefile | 66 +- src/modes/cmode_b.cpp | 186 +- src/modes/cmode_h.cpp | 163 +- src/modes/cmode_i.cpp | 36 +- src/modes/cmode_k.cpp | 104 +- src/modes/cmode_l.cpp | 98 +- src/modes/cmode_m.cpp | 37 +- src/modes/cmode_n.cpp | 37 +- src/modes/cmode_o.cpp | 154 +- src/modes/cmode_p.cpp | 36 +- src/modes/cmode_s.cpp | 36 +- src/modes/cmode_t.cpp | 37 +- src/modes/cmode_v.cpp | 153 +- src/modes/umode_i.cpp | 46 +- src/modes/umode_n.cpp | 59 +- src/modes/umode_o.cpp | 50 +- src/modes/umode_s.cpp | 46 +- src/modes/umode_w.cpp | 47 +- src/modules.cpp | 733 +++- src/modules/extra/README | 8 +- src/modules/extra/m_filter_pcre.cpp | 183 +- src/modules/extra/m_httpclienttest.cpp | 82 +- src/modules/extra/m_mysql.cpp | 890 +++- src/modules/extra/m_pgsql.cpp | 985 ++++- src/modules/extra/m_sqlauth.cpp | 195 +- src/modules/extra/m_sqlite3.cpp | 661 ++- src/modules/extra/m_sqllog.cpp | 311 +- src/modules/extra/m_sqloper.cpp | 284 +- src/modules/extra/m_sqlutils.cpp | 239 +- src/modules/extra/m_sqlutils.h | 144 +- src/modules/extra/m_sqlv2.h | 606 ++- src/modules/extra/m_ssl_gnutls.cpp | 844 +++- src/modules/extra/m_ssl_openssl.cpp | 902 +++- src/modules/extra/m_ssl_oper_cert.cpp | 181 +- src/modules/extra/m_sslinfo.cpp | 95 +- src/modules/extra/m_testclient.cpp | 111 +- src/modules/extra/m_ziplink.cpp | 453 +- src/modules/httpclient.h | 128 +- src/modules/httpd.h | 167 +- src/modules/m_alias.cpp | 273 +- src/modules/m_alltime.cpp | 84 +- src/modules/m_antibear.cpp | 79 +- src/modules/m_antibottler.cpp | 100 +- src/modules/m_auditorium.cpp | 192 +- src/modules/m_banexception.cpp | 154 +- src/modules/m_banredirect.cpp | 344 +- src/modules/m_blockamsg.cpp | 192 +- src/modules/m_blockcaps.cpp | 144 +- src/modules/m_blockcolor.cpp | 119 +- src/modules/m_botmode.cpp | 96 +- src/modules/m_cban.cpp | 252 +- src/modules/m_censor.cpp | 197 +- src/modules/m_cgiirc.cpp | 512 ++- src/modules/m_chancreate.cpp | 56 +- src/modules/m_chanfilter.cpp | 156 +- src/modules/m_chanprotect.cpp | 532 ++- src/modules/m_check.cpp | 189 +- src/modules/m_chghost.cpp | 121 +- src/modules/m_chgident.cpp | 93 +- src/modules/m_chgname.cpp | 90 +- src/modules/m_cloaking.cpp | 316 +- src/modules/m_clones.cpp | 101 +- src/modules/m_conn_join.cpp | 97 +- src/modules/m_conn_umodes.cpp | 105 +- src/modules/m_conn_waitpong.cpp | 149 +- src/modules/m_connflood.cpp | 121 +- src/modules/m_cycle.cpp | 100 +- src/modules/m_dccallow.cpp | 490 ++- src/modules/m_deaf.cpp | 136 +- src/modules/m_denychans.cpp | 81 +- src/modules/m_devoice.cpp | 82 +- src/modules/m_dnsbl.cpp | 354 +- src/modules/m_filter.cpp | 136 +- src/modules/m_filter.h | 454 +- src/modules/m_foobar.cpp | 99 +- src/modules/m_globalload.cpp | 142 +- src/modules/m_globops.cpp | 77 +- src/modules/m_hash.h | 197 +- src/modules/m_helpop.cpp | 192 +- src/modules/m_hidechans.cpp | 96 +- src/modules/m_hideoper.cpp | 95 +- src/modules/m_hostchange.cpp | 149 +- src/modules/m_http_client.cpp | 347 +- src/modules/m_httpd.cpp | 420 +- src/modules/m_httpd_stats.cpp | 242 +- src/modules/m_ident.cpp | 327 +- src/modules/m_invisible.cpp | 278 +- src/modules/m_inviteexception.cpp | 151 +- src/modules/m_joinflood.cpp | 286 +- src/modules/m_jumpserver.cpp | 165 +- src/modules/m_kicknorejoin.cpp | 225 +- src/modules/m_knock.cpp | 130 +- src/modules/m_lockserv.cpp | 132 +- src/modules/m_md5.cpp | 323 +- src/modules/m_messageflood.cpp | 305 +- src/modules/m_namesx.cpp | 128 +- src/modules/m_nicklock.cpp | 160 +- src/modules/m_noctcp.cpp | 108 +- src/modules/m_noinvite.cpp | 89 +- src/modules/m_nokicks.cpp | 106 +- src/modules/m_nonicks.cpp | 103 +- src/modules/m_nonotice.cpp | 104 +- src/modules/m_oper_hash.cpp | 164 +- src/modules/m_operchans.cpp | 98 +- src/modules/m_operjoin.cpp | 91 +- src/modules/m_operlevels.cpp | 123 +- src/modules/m_operlog.cpp | 76 +- src/modules/m_opermodes.cpp | 110 +- src/modules/m_opermotd.cpp | 117 +- src/modules/m_override.cpp | 295 +- src/modules/m_randquote.cpp | 139 +- src/modules/m_redirect.cpp | 161 +- src/modules/m_regonlycreate.cpp | 62 +- src/modules/m_remove.cpp | 289 +- src/modules/m_restrictbanned.cpp | 99 +- src/modules/m_restrictchans.cpp | 86 +- src/modules/m_restrictmsg.cpp | 76 +- src/modules/m_safelist.cpp | 269 +- src/modules/m_sajoin.cpp | 115 +- src/modules/m_samode.cpp | 99 +- src/modules/m_sanick.cpp | 98 +- src/modules/m_sapart.cpp | 114 +- src/modules/m_saquit.cpp | 83 +- src/modules/m_securelist.cpp | 98 +- src/modules/m_seenicks.cpp | 56 +- src/modules/m_services.cpp | 311 +- src/modules/m_services_account.cpp | 333 +- src/modules/m_sethost.cpp | 109 +- src/modules/m_setident.cpp | 84 +- src/modules/m_setidle.cpp | 75 +- src/modules/m_setname.cpp | 81 +- src/modules/m_sha256.cpp | 297 +- src/modules/m_showwhois.cpp | 110 +- src/modules/m_silence.cpp | 216 +- src/modules/m_silence_ext.cpp | 373 +- src/modules/m_spanningtree/README | 25 +- src/modules/m_spanningtree/handshaketimer.cpp | 63 +- src/modules/m_spanningtree/handshaketimer.h | 38 +- src/modules/m_spanningtree/link.h | 43 +- src/modules/m_spanningtree/main.cpp | 1393 ++++++- src/modules/m_spanningtree/main.h | 199 +- src/modules/m_spanningtree/rconnect.cpp | 68 +- src/modules/m_spanningtree/rconnect.h | 29 +- src/modules/m_spanningtree/resolvers.cpp | 89 +- src/modules/m_spanningtree/resolvers.h | 91 +- src/modules/m_spanningtree/rsquit.cpp | 124 +- src/modules/m_spanningtree/rsquit.h | 30 +- src/modules/m_spanningtree/timesynctimer.cpp | 53 +- src/modules/m_spanningtree/timesynctimer.h | 48 +- src/modules/m_spanningtree/treeserver.cpp | 326 +- src/modules/m_spanningtree/treeserver.h | 187 +- src/modules/m_spanningtree/treesocket.h | 414 +- src/modules/m_spanningtree/treesocket1.cpp | 1274 +++++- src/modules/m_spanningtree/treesocket2.cpp | 1555 ++++++- src/modules/m_spanningtree/utils.cpp | 650 ++- src/modules/m_spanningtree/utils.h | 195 +- src/modules/m_spy.cpp | 164 +- src/modules/m_ssl_dummy.cpp | 85 +- src/modules/m_sslmodes.cpp | 146 +- src/modules/m_stripcolor.cpp | 186 +- src/modules/m_svshold.cpp | 283 +- src/modules/m_swhois.cpp | 268 +- src/modules/m_taxonomy.cpp | 100 +- src/modules/m_testcommand.cpp | 68 +- src/modules/m_timedbans.cpp | 205 +- src/modules/m_tline.cpp | 96 +- src/modules/m_uhnames.cpp | 99 +- src/modules/m_uninvite.cpp | 108 +- src/modules/m_userip.cpp | 87 +- src/modules/m_vhost.cpp | 96 +- src/modules/m_watch.cpp | 473 ++- src/modules/m_xmlsocket.cpp | 171 +- src/modules/transport.h | 232 +- src/snomasks.cpp | 103 +- src/socket.cpp | 569 ++- src/socketengine.cpp | 94 +- src/socketengine_epoll.cpp | 158 +- src/socketengine_iocp.cpp | 377 +- src/socketengine_kqueue.cpp | 159 +- src/socketengine_ports.cpp | 130 +- src/socketengine_select.cpp | 168 +- src/timer.cpp | 136 +- src/userprocess.cpp | 306 +- src/users.cpp | 2008 ++++++++- src/version.sh | 3 +- src/wildcard.cpp | 149 +- src/xline.cpp | 898 +++- win/cert.pem | 19 +- win/colours.h | 110 +- win/configure.cpp | 510 ++- win/inspircd.nsi | 273 +- win/inspircd_memory_functions.cpp | 45 +- win/inspircd_win32wrapper.cpp | 514 ++- win/inspircd_win32wrapper.h | 190 +- win/key.pem | 16 +- win/makeinstaller.bat | 8 +- 397 files changed, 84229 insertions(+), 397 deletions(-) diff --git a/conf/aliases/anope.conf.example b/conf/aliases/anope.conf.example index 9b20fafcb..03e68d9d8 100644 --- a/conf/aliases/anope.conf.example +++ b/conf/aliases/anope.conf.example @@ -1 +1,25 @@ -# Aliases for nickserv, chanserv, operserv, memoserv # Note: We can't have a shorthand version of this, it conflicts with HS for helpserv # Shorthand aliases for nickserv, chanserv, operserv, memoserv # /id [channel] # Identify for a channel or nickname \ No newline at end of file +# Aliases for nickserv, chanserv, operserv, memoserv + + + + + + + +# Note: We can't have a shorthand version of this, it conflicts with HS for helpserv + + +# Shorthand aliases for nickserv, chanserv, operserv, memoserv + + + + + + + + +# /id [channel] +# Identify for a channel or nickname + + + diff --git a/conf/aliases/atheme.conf.example b/conf/aliases/atheme.conf.example index 17f6d2907..d6771f965 100644 --- a/conf/aliases/atheme.conf.example +++ b/conf/aliases/atheme.conf.example @@ -1 +1,19 @@ -# Aliases for nickserv, chanserv, operserv, memoserv # Shorthand aliases for nickserv, chanserv, operserv, memoserv # /id [channel] # Identify for a channel or nickname \ No newline at end of file +# Aliases for nickserv, chanserv, operserv, memoserv + + + + + + +# Shorthand aliases for nickserv, chanserv, operserv, memoserv + + + + + + +# /id [channel] +# Identify for a channel or nickname + + + diff --git a/conf/aliases/ircservices.conf.example b/conf/aliases/ircservices.conf.example index 52512a9e5..edfe784a2 100644 --- a/conf/aliases/ircservices.conf.example +++ b/conf/aliases/ircservices.conf.example @@ -1 +1,19 @@ -# Aliases for nickserv, chanserv, operserv, memoserv # Shorthand aliases for nickserv, chanserv, operserv, memoserv # /id [channel] # Identify for a channel or nickname \ No newline at end of file +# Aliases for nickserv, chanserv, operserv, memoserv + + + + + + +# Shorthand aliases for nickserv, chanserv, operserv, memoserv + + + + + + +# /id [channel] +# Identify for a channel or nickname + + + diff --git a/conf/inspircd.censor.example b/conf/inspircd.censor.example index 108f88c12..05d9ce6fa 100644 --- a/conf/inspircd.censor.example +++ b/conf/inspircd.censor.example @@ -1 +1,15 @@ -# Configuration file for m_censor.so (1.0.0.0) # C.J.Edwards May 2004. # # The tags for this module are formatted as follows: # # # # You can specify # to block lines containing the word \ No newline at end of file +# Configuration file for m_censor.so (1.0.0.0) +# C.J.Edwards May 2004. +# + +# The tags for this module are formatted as follows: +# +# +# +# You can specify +# to block lines containing the word + + + + diff --git a/conf/inspircd.filter.example b/conf/inspircd.filter.example index f4487a719..7623a4472 100644 --- a/conf/inspircd.filter.example +++ b/conf/inspircd.filter.example @@ -1 +1,52 @@ -# Configuration file for m_filter.so and m_filter_pcre.so # The tags for this module are formatted as follows: # # # # Valid actions for 'action' are: # # block This blocks the line, sends out a notice to all opers with # +s and informs the user that their message was blocked. # # silent This blocks the line only, and informs the user their message # was blocked, but does not notify opers. # # none This action causes nothing to be done except logging. This # is the default action if none is specified. # # kill This disconnects the user, with the 'reason' parameter as # the kill reason. # # gline G-LINE the user for 'duration' length of time. Durations may # be specified using the notation 1y2d3h4m6s in a similar way to # other glines, omitting the duration or setting it to 0 makes # any glines set by this filter be permanent. # # You can add filters from IRC using the /FILTER command. If you do this, they # will be set globally to your entire network. # # Valid characters for 'flags' are one or more of: # # p: Block private and channel messages # n: Block private and channel notices # P: Block part messages # q: Block quit messages # o: Don't match against opers # *: Represents all of the above flags # -: Does nothing, a non-op for when you do not want to specify any flags # Example filters for m_filter: # # # # # An example regexp filter for m_filter_pcre: # # \ No newline at end of file +# Configuration file for m_filter.so and m_filter_pcre.so + +# The tags for this module are formatted as follows: +# +# +# +# Valid actions for 'action' are: +# +# block This blocks the line, sends out a notice to all opers with +# +s and informs the user that their message was blocked. +# +# silent This blocks the line only, and informs the user their message +# was blocked, but does not notify opers. +# +# none This action causes nothing to be done except logging. This +# is the default action if none is specified. +# +# kill This disconnects the user, with the 'reason' parameter as +# the kill reason. +# +# gline G-LINE the user for 'duration' length of time. Durations may +# be specified using the notation 1y2d3h4m6s in a similar way to +# other glines, omitting the duration or setting it to 0 makes +# any glines set by this filter be permanent. +# +# You can add filters from IRC using the /FILTER command. If you do this, they +# will be set globally to your entire network. +# +# Valid characters for 'flags' are one or more of: +# +# p: Block private and channel messages +# n: Block private and channel notices +# P: Block part messages +# q: Block quit messages +# o: Don't match against opers +# *: Represents all of the above flags +# -: Does nothing, a non-op for when you do not want to specify any flags + +# Example filters for m_filter: +# +# +# +# + +# An example regexp filter for m_filter_pcre: +# +# + diff --git a/conf/inspircd.helpop-full.example b/conf/inspircd.helpop-full.example index 64437a4d7..a4b4f1e11 100644 --- a/conf/inspircd.helpop-full.example +++ b/conf/inspircd.helpop-full.example @@ -1 +1,519 @@ -##################### # Helpop Standard # ##################### ##################### # User Commands # ##################### ##################### # Oper Commands # ##################### ###################### # User/Channel Modes # ###################### ###################### # Stats Symbols # ###################### \ No newline at end of file +##################### +# Helpop Standard # +##################### + + + + + +##################### +# User Commands # +##################### + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +##################### +# Oper Commands # +##################### + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +###################### +# User/Channel Modes # +###################### + + + + + +###################### +# Stats Symbols # +###################### + + + diff --git a/conf/inspircd.helpop.example b/conf/inspircd.helpop.example index 109a934a3..a02847ad0 100644 --- a/conf/inspircd.helpop.example +++ b/conf/inspircd.helpop.example @@ -1 +1,83 @@ -# Sample configuration file for m_helpop.so # You can either copy this into your conf folder and set up the module to use it, # or you can customize the responses for your network and/or add more. # # The way the new helpop system works is simple. You use one or more helpop tags. # . # key is what the user is looking for (i.e. /helpop moo), and value is what they get back # (note that it can span multiple lines!). # -- w00t 16/dec/2006 # \ No newline at end of file +# Sample configuration file for m_helpop.so +# You can either copy this into your conf folder and set up the module to use it, +# or you can customize the responses for your network and/or add more. +# +# The way the new helpop system works is simple. You use one or more helpop tags. +# . +# key is what the user is looking for (i.e. /helpop moo), and value is what they get back +# (note that it can span multiple lines!). +# -- w00t 16/dec/2006 +# + + + + + + + + + + + + diff --git a/conf/inspircd.motd.example b/conf/inspircd.motd.example index 06f1e5d66..6653792ac 100644 --- a/conf/inspircd.motd.example +++ b/conf/inspircd.motd.example @@ -1 +1,40 @@ - _____ _____ _____ _____ _ |_ _| |_ _| | __ \ / ____| | | | | _ __ ___ _ __ | | | |__) || | __| | | | | '_ \ / __| | '_ \ | | | _ / | | / _` | _| |_ | | | | \__ \ | |_) | _| |_ | | \ \ | |____ | (_| | |_____| |_| |_| |___/ | .__/ |_____| |_| \_\ \_____| \__,_| __________________| |_______________________________ |__________________|_|_______________________________| Putting the ricer in IRCer since 2007 //\ V \ WELCOME TO AN INSPIRCD NETWORK \ \_ If you see this, I am probably new \,'.`-. If I'm not new, my owner is lazy. |\ `. `. ( \ `. `-. _,.-:\ \ \ `. `-._ __..--' ,-';/ \ `. `-. `-..___..---' _.--' ,'/ `. `. `-._ __..--' ,' / `. `-_ ``--..'' _.-' ,' `-_ `-.___ __,--' ,' `-.__ `----""" __.-' `--..____..--' -- To change, see inspircd.motd.example -- / \ / * Web: http://www.inspircd.org \ | * Blog: http://www.inspircd.com | | * IRC: irc.inspircd.org #inspircd | | * Docs: http://www.inspircd.org/wiki | | | | We hope you like this software. Please do | | make sure you put some effort into | | your configuration though so you like it. | | Enjoy. | | | \ -- The InspIRCd Team / ------------------------------------------- \ No newline at end of file + + _____ _____ _____ _____ _ +|_ _| |_ _| | __ \ / ____| | | + | | _ __ ___ _ __ | | | |__) || | __| | + | | | '_ \ / __| | '_ \ | | | _ / | | / _` | + _| |_ | | | | \__ \ | |_) | _| |_ | | \ \ | |____ | (_| | +|_____| |_| |_| |___/ | .__/ |_____| |_| \_\ \_____| \__,_| + __________________| |_______________________________ + |__________________|_|_______________________________| + + Putting the ricer in IRCer since 2007 + + //\ + V \ WELCOME TO AN INSPIRCD NETWORK + \ \_ If you see this, I am probably new + \,'.`-. If I'm not new, my owner is lazy. + |\ `. `. + ( \ `. `-. _,.-:\ + \ \ `. `-._ __..--' ,-';/ + \ `. `-. `-..___..---' _.--' ,'/ + `. `. `-._ __..--' ,' / + `. `-_ ``--..'' _.-' ,' + `-_ `-.___ __,--' ,' + `-.__ `----""" __.-' + `--..____..--' + + -- To change, see inspircd.motd.example -- + / \ + / * Web: http://www.inspircd.org \ + | * Blog: http://www.inspircd.com | + | * IRC: irc.inspircd.org #inspircd | + | * Docs: http://www.inspircd.org/wiki | + | | + | We hope you like this software. Please do | + | make sure you put some effort into | + | your configuration though so you like it. | + | Enjoy. | + | | + \ -- The InspIRCd Team / + ------------------------------------------- \ No newline at end of file diff --git a/conf/inspircd.quotes.example b/conf/inspircd.quotes.example index 12ff74e4b..9b2bc0f6a 100644 --- a/conf/inspircd.quotes.example +++ b/conf/inspircd.quotes.example @@ -1 +1,175 @@ -Men are from Mars. Women are from Venus. Computers are from hell Computer /nm./: a device designed to speed and automate errors Hardware /nm./: the part of the computer that you can kick. Maniac /n./ An early computer built by nuts. RAM /abr./: Rarely Adequate Memory. Programmer /n./ A red-eyed, mumbling mammal capable of conversing with inanimate objects Multitasking /adj./ 3 PCs and a chair with wheels Plonk /excl./: The sound a newbie makes as he falls to the bottom of a kill file hURL /n./: a link to a web site that makes you want to puke SUPERCOMPUTER: what it sounded like before you bought it. If it's really a supercomputer, how come the bullets don't bounce off when I shoot it? . The Covert Comic. A computer is like an Old Testament god, with a lot of rules and no mercy. . Joseph Campbell I dropped my computer on my foot! That Megahurtz!! A computer's attention span is as long as it's power cord 586: The average IQ needed to understand a PC Memory is like an orgasm. It's a lot better if you don't have to fake it If it jams, force it. If it breaks, it needed replacing anyway. A bus station is where a bus stops. A train station is where a train stops. On my desk I have a workstation.. Want to come see my HARD DRIVE ? I promise it isn't 3.5 inches and it ain't floppy. . Geek pick-up line. If you torture the data enough, it will confess. . Ronald Coase If you give someone a program, you will frustrate them for a day; if you teach them how to program, you will frustrate them for a lifetime ASCII stupid question, get a stupid ANSI! Use the source, Luke... Programming is an art form that fights back MacOS, Windows, BeOS: they're all just Xerox copies Whenever you think you have a clever programming trick... forget it! Managing senior programmers is like herding cats. . Dave Platt Your program is sick ! Shoot it and put it out of its memory /* You are not expected to understand this */ To define recursion, we must first define recursion ERROR: Computer possessed; Load EXOR.SYS ? [Y/N] Linux is only free if your time is worthless Linux: find out what you've been missing while you've been rebooting Windows NT unzip; strip; touch; finger; mount; fsck; more; yes; unmount; sleep Profanity is the one language all programmers know best It's 5.50 a.m.... Do you know where your stack pointer is? #define QUESTION ((bb) || !(bb)) . Shakespeare The more I C, the less I see. Confucius say: He who play in root, eventually kill tree. Unix is the answer, but only if you phrase the question very carefully C++: Hard to learn and built to stay that way Java is, in many ways, C++-- . Michael Feldman. They don't make bugs like Bunny anymore . Olav Mjelde If debugging is the process of removing software bugs, then programming must be the process of putting them in When the only tool you own is a hammer, every problem you encounter resembles a nail System Error: press F13 to continue... To err is human, but for a real disaster you need a computer Computers make very fast, very accurate mistakes Life would be so much easier if we only had the source code Who is this 'General Failure' and why is he reading my disk? hAS aNYONE sEEN MY cAPSLOCK kEY? InspIRCd, now with excessive ammounts of Cheeze I'm in the computer business, I make Out-Of-Order signs Kevorkian Virus: helps your computer shut down whenever it wants to. [OUT OF QUOTES, PLEASE ORDER MORE] Error, no keyboard . press F1 to continue. Insert Something Funkeh.. err.. There! --> Cannot delete tmp150---3.tmp: There is not enough free disk space. Delete one or more files to free disk space, and then try again File not found. Should I fake it ? (Y/N) The definition of an upgrade: Take old bugs out, put new ones in If it's not on fire, it's a software problem My software never has bugs. It just develops random features It's a little-known fact that the Y1K problem caused the Dark Ages Artificial Intelligence usually beats natural stupidity Making fun of AOL users is like making fun of the kid in the wheel chair Daddy, why doesn't this magnet pick up this floppy disk? Daddy, what does FORMATTING DRIVE C mean? See daddy ? All the keys are in alphabetical order now. If you can't beat your computer at chess, do what I did . try kick-boxing. Enter any 11-digit prime number to continue... ASCII and ye shall receive. The web is a dominatrix. Every where I turn, I see little buttons ordering me to Submit. NO, You cannot dial 999, I'm downloading my mail ;/ 640K ought to be enough for anybody. . Bill Gates, 1981 Windows not found, [P]arty, [C]elebrate, [D]rink? English, the Microsoft of languages... It's been said that Bill Gates named his company after his dick... Ever notice how fast Windows runs ? -- Neither did I If at first you don't succeed, work for Microsoft We are Microsoft. Resistance Is Futile. You Will Be Assimilated "Microsoft Works." . Oxymoron Windows isn't a virus, viruses do something PANIC! buffer = :NickServ WRITE_DB(3). <-- JUST KIDDING! It just keeps going and going and going and going and goi All that I know is that nukes are comming from 127.0.0.1 I know all about the irc and the mirc cops. M re ink n ed d, ple s r fil Please refrain from feeding the IRC Operators. Thank you. I know all about mirc stuff, hmm.. I think this channel is experiencing packet loss.. MacDonalds claims Macintosh stole their next idea of the iMac I can't hold her any longer, captain, she's gonna bl.. sorry, got caught up in the moment I recommend purchasing a Cyrix CPU for testing nuclear meltdowns Is it an international rule to have the worst picture possible on your driver license? Have you hugged your services coder, today? Ever wonder why they make the colon flash on alarm clocks? Whats this?.. blue screen with a VXD error?!.. I'VE BEEN NUKED! do-do-bop-doo-doo-do-do-doo.. For those of you who know that song, you have problems.. be wery wery quiet... hunting wabbit... I've been IRC Nuked"Great warrior? War does not make one great." - Yoda "I find your lack of faith.....disturbing." - Darth Vader "I have a bad feeling about this.."--All of the Star Wars characters. Can I upgrade my Hard Drive to a WARP drive? Canadian DOS prompt: EH?\> Canadian DOS: "Yer sure, eh?" [y/n] CONGRESS.SYS Corrupted: Re-boot Washington D.C (Y/n)? I don't have a solution but I admire the problem. Famous Last Words: Trust me. I know what I'm doing. Hey Captain, I just created a black ho-÷p!%$û NO CARRIER I like work ... I can sit and watch it for hours. Access denied--nah nah na nah nah! Bad command. Bad, bad command! Sit! Stay! Staaay.. Error: Keyboard not attached. Press F1 to continue. *grumble* "You're just supposed to sit here?" "Hey, what's this button d.." -W. Crusher "He has become One with Himself!" "He's passed out!" "That too."-B5 For a funny quote, call back later. Famous last words: 'You saw a WHAT around the corner?!' I like work ... I can sit and watch it for hours. If debugging is the process of removing bugs, then programming must be the process of putting them in. Copywight 1994 Elmer Fudd. All wights wesewved. Cannot find REALITY.SYS. Universe halted. BUFFERS=20 FILES=15 2nd down, 4th quarter, 5 yards to go! My software never has bugs. It just develops random features. Why doesn't DOS ever say 'EXCELLENT command or filename!? Who's General Failure & why's he reading my disk? Shell to DOS... Come in DOS, do you copy? Shell to DOS... Computing Definition - Network-Admin: Primary person who just got set up for the blame of the system crash. An expert is a person who has made all the mistakes which can be made in a very narrow field. Famous last words: This is the safe way to do it....... Famous Last Words: Trust me. I know what I'm doing. Clinton, "I didn't say that - er, well - yes, but I didn't mean..." CLINTON LEGACY??...even Pharaoh had only ten plagues... IBM I Bought McIntosh IBM I Bring Manuals IBM I've Been Moved IBM Idolized By Management IBM Impenetrable Brain Matter IBM Imperialism By Marketing IBM Incorrigible Boisterous Mammoth IBM Inertia Breeds Mediocrity IBM Ingenuity Becomes Mysterious IBM Ingrained Batch Mentality IBM Innovation By Management IBM Insipid Belligerent Mossbacks IBM Insipidly Bankrolling Millions IBM Inspect Before Multiusing IBM Install Bigger Memory IBM Institution By Machiavelli IBM Insultingly Boring Merchandisers IBM Intellectuals Being Moronized IBM Intelligence Belittling Meaning IBM Intimidated, Buffaloed Management IBM Into Building Money IBM Intolerant of Beards & Moustaches IBM Invest Before Multi-tasking IBM Investigate Baffling Malodor IBM Irresponsible Behave Multinational IBM It Beats Mattel IBM It's a Big Mess IBM It's Better Manually IBM Itty Bitty Machine IBM Institute for Black Magic 100,000 lemmings can't be wrong. Murphy's Eighth Law: If everything seems to be going well, you have obviously overlooked something. Rules of the game: Do not believe in miracles - rely on them. Rules of the game: Any given program, once running, is obsolete. Computing Definition - Error: What someone else has made when they disagree with your computer output. Backup not found: (A)bort (R)etry (P)anic WinErr 653: Multitasking attempted - system confused. Cannot join #real_life (invite only) "Unfortunatly, no one can be told what the Matrix is. You have to see it for yourself." - Matrix "Reality is a thing of the past" - Matrix "The future will not be user friendly" - Matrix "The general idea in chat is to make yourself understandable... ..." - Peer "heh i am talkin to someone...she not dead...yet anyways" - Stinky \ No newline at end of file +Men are from Mars. Women are from Venus. Computers are from hell +Computer /nm./: a device designed to speed and automate errors +Hardware /nm./: the part of the computer that you can kick. +Maniac /n./ An early computer built by nuts. +RAM /abr./: Rarely Adequate Memory. +Programmer /n./ A red-eyed, mumbling mammal capable of conversing with inanimate objects +Multitasking /adj./ 3 PCs and a chair with wheels +Plonk /excl./: The sound a newbie makes as he falls to the bottom of a kill file +hURL /n./: a link to a web site that makes you want to puke +SUPERCOMPUTER: what it sounded like before you bought it. +If it's really a supercomputer, how come the bullets don't bounce off when I shoot it? . The Covert Comic. +A computer is like an Old Testament god, with a lot of rules and no mercy. . Joseph Campbell +I dropped my computer on my foot! That Megahurtz!! +A computer's attention span is as long as it's power cord +586: The average IQ needed to understand a PC +Memory is like an orgasm. It's a lot better if you don't have to fake it +If it jams, force it. If it breaks, it needed replacing anyway. +A bus station is where a bus stops. A train station is where a train stops. On my desk I have a workstation.. +Want to come see my HARD DRIVE ? I promise it isn't 3.5 inches and it ain't floppy. . Geek pick-up line. +If you torture the data enough, it will confess. . Ronald Coase +If you give someone a program, you will frustrate them for a day; if you teach them how to program, you will frustrate them for a lifetime +ASCII stupid question, get a stupid ANSI! +Use the source, Luke... +Programming is an art form that fights back +MacOS, Windows, BeOS: they're all just Xerox copies +Whenever you think you have a clever programming trick... forget it! +Managing senior programmers is like herding cats. . Dave Platt +Your program is sick ! Shoot it and put it out of its memory +/* You are not expected to understand this */ +To define recursion, we must first define recursion +ERROR: Computer possessed; Load EXOR.SYS ? [Y/N] +Linux is only free if your time is worthless +Linux: find out what you've been missing while you've been rebooting Windows NT +unzip; strip; touch; finger; mount; fsck; more; yes; unmount; sleep +Profanity is the one language all programmers know best +It's 5.50 a.m.... Do you know where your stack pointer is? +#define QUESTION ((bb) || !(bb)) . Shakespeare +The more I C, the less I see. +Confucius say: He who play in root, eventually kill tree. +Unix is the answer, but only if you phrase the question very carefully +C++: Hard to learn and built to stay that way +Java is, in many ways, C++-- . Michael Feldman. +They don't make bugs like Bunny anymore . Olav Mjelde +If debugging is the process of removing software bugs, then programming must be the process of putting them in +When the only tool you own is a hammer, every problem you encounter resembles a nail +System Error: press F13 to continue... +To err is human, but for a real disaster you need a computer +Computers make very fast, very accurate mistakes +Life would be so much easier if we only had the source code +Who is this 'General Failure' and why is he reading my disk? +hAS aNYONE sEEN MY cAPSLOCK kEY? +InspIRCd, now with excessive ammounts of Cheeze +I'm in the computer business, I make Out-Of-Order signs +Kevorkian Virus: helps your computer shut down whenever it wants to. + [OUT OF QUOTES, PLEASE ORDER MORE] +Error, no keyboard . press F1 to continue. +Insert Something Funkeh.. err.. There! --> +Cannot delete tmp150---3.tmp: There is not enough free disk space. Delete one or more files to free disk space, and then try again +File not found. Should I fake it ? (Y/N) +The definition of an upgrade: Take old bugs out, put new ones in +If it's not on fire, it's a software problem +My software never has bugs. It just develops random features +It's a little-known fact that the Y1K problem caused the Dark Ages +Artificial Intelligence usually beats natural stupidity +Making fun of AOL users is like making fun of the kid in the wheel chair +Daddy, why doesn't this magnet pick up this floppy disk? +Daddy, what does FORMATTING DRIVE C mean? +See daddy ? All the keys are in alphabetical order now. +If you can't beat your computer at chess, do what I did . try kick-boxing. +Enter any 11-digit prime number to continue... +ASCII and ye shall receive. +The web is a dominatrix. Every where I turn, I see little buttons ordering me to Submit. + NO, You cannot dial 999, I'm downloading my mail ;/ +640K ought to be enough for anybody. . Bill Gates, 1981 +Windows not found, [P]arty, [C]elebrate, [D]rink? +English, the Microsoft of languages... +It's been said that Bill Gates named his company after his dick... +Ever notice how fast Windows runs ? -- Neither did I +If at first you don't succeed, work for Microsoft +We are Microsoft. Resistance Is Futile. You Will Be Assimilated +"Microsoft Works." . Oxymoron +Windows isn't a virus, viruses do something +PANIC! buffer = :NickServ WRITE_DB(3). <-- JUST KIDDING! +It just keeps going and going and going and going and goi +All that I know is that nukes are comming from 127.0.0.1 +I know all about the irc and the mirc cops. +M re ink n ed d, ple s r fil +Please refrain from feeding the IRC Operators. Thank you. +I know all about mirc stuff, hmm.. I think this channel is experiencing packet loss.. +MacDonalds claims Macintosh stole their next idea of the iMac +I can't hold her any longer, captain, she's gonna bl.. sorry, got caught up in the moment +I recommend purchasing a Cyrix CPU for testing nuclear meltdowns +Is it an international rule to have the worst picture possible on your driver license? +Have you hugged your services coder, today? +Ever wonder why they make the colon flash on alarm clocks? +Whats this?.. blue screen with a VXD error?!.. I'VE BEEN NUKED! +do-do-bop-doo-doo-do-do-doo.. For those of you who know that song, you have problems.. +be wery wery quiet... hunting wabbit... +I've been IRC Nuked"Great warrior? War does not make one great." - Yoda +"I find your lack of faith.....disturbing." - Darth Vader +"I have a bad feeling about this.."--All of the Star Wars characters. +Can I upgrade my Hard Drive to a WARP drive? +Canadian DOS prompt: EH?\> +Canadian DOS: "Yer sure, eh?" [y/n] +CONGRESS.SYS Corrupted: Re-boot Washington D.C (Y/n)? +I don't have a solution but I admire the problem. +Famous Last Words: Trust me. I know what I'm doing. +Hey Captain, I just created a black ho-÷p!%$û NO CARRIER +I like work ... I can sit and watch it for hours. +Access denied--nah nah na nah nah! +Bad command. Bad, bad command! Sit! Stay! Staaay.. +Error: Keyboard not attached. Press F1 to continue. +*grumble* "You're just supposed to sit here?" +"Hey, what's this button d.." -W. Crusher +"He has become One with Himself!" "He's passed out!" "That too."-B5 +For a funny quote, call back later. +Famous last words: 'You saw a WHAT around the corner?!' +I like work ... I can sit and watch it for hours. +If debugging is the process of removing bugs, then programming must be the process of putting them in. +Copywight 1994 Elmer Fudd. All wights wesewved. +Cannot find REALITY.SYS. Universe halted. +BUFFERS=20 FILES=15 2nd down, 4th quarter, 5 yards to go! +My software never has bugs. It just develops random features. +Why doesn't DOS ever say 'EXCELLENT command or filename!? +Who's General Failure & why's he reading my disk? +Shell to DOS... Come in DOS, do you copy? Shell to DOS... +Computing Definition - Network-Admin: Primary person who just got set up for the blame of the system crash. +An expert is a person who has made all the mistakes which can be made in a very narrow field. +Famous last words: This is the safe way to do it....... +Famous Last Words: Trust me. I know what I'm doing. +Clinton, "I didn't say that - er, well - yes, but I didn't mean..." +CLINTON LEGACY??...even Pharaoh had only ten plagues... +IBM I Bought McIntosh +IBM I Bring Manuals +IBM I've Been Moved +IBM Idolized By Management +IBM Impenetrable Brain Matter +IBM Imperialism By Marketing +IBM Incorrigible Boisterous Mammoth +IBM Inertia Breeds Mediocrity +IBM Ingenuity Becomes Mysterious +IBM Ingrained Batch Mentality +IBM Innovation By Management +IBM Insipid Belligerent Mossbacks +IBM Insipidly Bankrolling Millions +IBM Inspect Before Multiusing +IBM Install Bigger Memory +IBM Institution By Machiavelli +IBM Insultingly Boring Merchandisers +IBM Intellectuals Being Moronized +IBM Intelligence Belittling Meaning +IBM Intimidated, Buffaloed Management +IBM Into Building Money +IBM Intolerant of Beards & Moustaches +IBM Invest Before Multi-tasking +IBM Investigate Baffling Malodor +IBM Irresponsible Behave Multinational +IBM It Beats Mattel +IBM It's a Big Mess +IBM It's Better Manually +IBM Itty Bitty Machine +IBM Institute for Black Magic +100,000 lemmings can't be wrong. +Murphy's Eighth Law: If everything seems to be going well, you have obviously overlooked something. +Rules of the game: Do not believe in miracles - rely on them. +Rules of the game: Any given program, once running, is obsolete. +Computing Definition - Error: What someone else has made when they disagree with your computer output. +Backup not found: (A)bort (R)etry (P)anic +WinErr 653: Multitasking attempted - system confused. +Cannot join #real_life (invite only) +"Unfortunatly, no one can be told what the Matrix is. You have to see it for yourself." - Matrix +"Reality is a thing of the past" - Matrix +"The future will not be user friendly" - Matrix +"The general idea in chat is to make yourself understandable... ..." - Peer +"heh i am talkin to someone...she not dead...yet anyways" - Stinky diff --git a/conf/inspircd.rules.example b/conf/inspircd.rules.example index 100db84d0..e51f0afd9 100644 --- a/conf/inspircd.rules.example +++ b/conf/inspircd.rules.example @@ -1 +1,3 @@ -This is the InspIRCd rules file. Place any network or server rules here :) \ No newline at end of file +This is the InspIRCd rules file. + +Place any network or server rules here :) diff --git a/configure b/configure index 28cf97967..0e9511b87 100755 --- a/configure +++ b/configure @@ -1 +1,1802 @@ -#!/usr/bin/perl ################################################### # InspIRCd Configuration Script # # Copyright 2002-2007 The InspIRCd Development Team # http://www.inspircd.org/wiki/index.php/Credits # # Licensed under GPL, please see the COPYING file # for more information # # $Id$ # ################################################### require 5.6.0; use Socket; use Cwd; use Getopt::Long; # Utility functions for our buildsystem use make::utilities; use make::configure; use make::gnutlscert; use make::opensslcert; GetOptions ( 'enable-gnutls' => \$opt_use_gnutls, 'rebuild' => \$opt_rebuild, 'enable-openssl' => \$opt_use_openssl, 'disable-interactive' => \$opt_nointeractive, 'with-nick-length=i' => \$opt_nick_length, 'with-channel-length=i' => \$opt_chan_length, 'with-max-clients=i' => \$opt_maxclients, 'enable-ports' => \$opt_ports, 'enable-epoll' => \$opt_epoll, 'enable-kqueue' => \$opt_kqueue, 'disable-ports' => \$opt_noports, 'disable-epoll' => \$opt_noepoll, 'disable-kqueue' => \$opt_nokqueue, 'enable-ipv6' => \$opt_ipv6, 'enable-remote-ipv6' => \$opt_ipv6links, 'disable-remote-ipv6' => \$opt_noipv6links, 'with-cc=s' => \$opt_cc, 'with-ident-length=i' => \$opt_ident, 'with-quit-length=i' => \$opt_quit, 'with-topic-length=i' => \$opt_topic, 'with-maxbuf=i' => \$opt_maxbuf, 'with-kick-length=i' => \$opt_kick, 'with-gecos-length=i' => \$opt_gecos, 'with-away-length=i' => \$opt_away, 'with-max-modes=i' => \$opt_modes, 'prefix=s' => \$opt_base_dir, 'config-dir=s' => \$opt_config_dir, 'module-dir=s' => \$opt_module_dir, 'binary-dir=s' => \$opt_binary_dir, 'library-dir=s' => \$opt_library_dir, 'disable-debuginfo' => sub { $opt_disable_debug = 1 }, 'help' => sub { showhelp(); }, 'modupdate' => sub { modupdate(); }, 'update' => sub { update(); }, 'svnupdate' => sub { svnupdate(); }, 'clean' => sub { clean(); }, ); my $non_interactive = ( (defined $opt_library_dir) || (defined $opt_base_dir) || (defined $opt_config_dir) || (defined $opt_module_dir) || (defined $opt_base_dir) || (defined $opt_binary_dir) || (defined $opt_nointeractive) || (defined $opt_away) || (defined $opt_gecos) || (defined $opt_kick) || (defined $opt_maxclients) || (defined $opt_modes) || (defined $opt_topic) || (defined $opt_quit) || (defined $opt_ident) || (defined $opt_cc) || (defined $opt_ipv6) || (defined $opt_ipv6links) || (defined $opt_noipv6links) || (defined $opt_kqueue) || (defined $opt_epoll) || (defined $opt_ports) || (defined $opt_maxchans) || (defined $opt_opermaxchans) || (defined $opt_chan_length) || (defined $opt_nick_length) || (defined $opt_use_openssl) || (defined $opt_nokqueue) || (defined $opt_noepoll) || (defined $opt_noports) || (defined $opt_maxbuf) || (defined $opt_use_gnutls) ); my $interactive = !$non_interactive; chomp($topdir = getcwd()); $this = resolve_directory($topdir); # PWD, Regardless. @modlist = (); # Declare for Module List.. %config = (); # Initiate Configuration Hash.. $config{ME} = resolve_directory($topdir); # Present Working Directory $config{BASE_DIR} = $config{ME}; if (defined $opt_base_dir) { $config{BASE_DIR} = $opt_base_dir; } $config{CONFIG_DIR} = resolve_directory($config{BASE_DIR}."/conf"); # Configuration Directory $config{MODULE_DIR} = resolve_directory($config{BASE_DIR}."/modules"); # Modules Directory $config{BINARY_DIR} = resolve_directory($config{BASE_DIR}."/bin"); # Binary Directory $config{LIBRARY_DIR} = resolve_directory($config{BASE_DIR}."/lib"); # Library Directory if (defined $opt_config_dir) { $config{CONFIG_DIR} = $opt_config_dir; } if (defined $opt_module_dir) { $config{MODULE_DIR} = $opt_module_dir; } if (defined $opt_binary_dir) { $config{BINARY_DIR} = $opt_binary_dir; } if (defined $opt_library_dir) { $config{LIBRARY_DIR} = $opt_library_dir; } chomp($config{HAS_GNUTLS} = `libgnutls-config --version 2>/dev/null | cut -c 1,2,3`); # GNUTLS Version. chomp($config{HAS_OPENSSL} = `pkg-config --modversion openssl 2>/dev/null`); # Openssl version chomp($gnutls_ver = $config{HAS_GNUTLS}); chomp($openssl_ver = $config{HAS_OPENSSL}); $config{USE_GNUTLS} = "n"; if (defined $opt_use_gnutls) { $config{USE_GNUTLS} = "y"; # Use gnutls. } $config{USE_OPENSSL} = "n"; # Use openssl. if (defined $opt_use_openssl) { $config{USE_OPENSSL} = "y"; } # no, let's not change these. $config{OPTIMITEMP} = "0"; # Default Optimisation Value if (!defined $opt_disable_debug) { $config{OPTIMISATI} = "-g1"; # Optimisation Flag } else { $config{OPTIMISATI} = "-O2"; # DEBUGGING OFF! } $config{NICK_LENGT} = "31"; # Default Nick Length if (defined $opt_nick_length) { $config{NICK_LENGT} = $opt_nick_length; } $config{CHAN_LENGT} = "64"; # Default Channel Name Length if (defined $opt_chan_length) { $config{CHAN_LENGT} = $opt_chan_length; } $config{MAXI_MODES} = "20"; # Default Max. Number of Modes set at once. if (defined $opt_modes) { $config{MAXI_MODES} = $opt_modes; } $config{HAS_STRLCPY} = "false"; # strlcpy Check. $config{HAS_STDINT} = "false"; # stdint.h check $config{USE_KQUEUE} = "y"; # kqueue enabled if (defined $opt_kqueue) { $config{USE_KQUEUE} = "y"; } if (defined $opt_nokqueue) { $config{USE_KQUEUE} = "n"; } $config{USE_EPOLL} = "y"; # epoll enabled if (defined $opt_epoll) { $config{USE_EPOLL} = "y"; } if (defined $opt_noepoll) { $config{USE_EPOLL} = "n"; } $config{USE_PORTS} = "y"; # epoll enabled if (defined $opt_ports) { $config{USE_PORTS} = "y"; } if (defined $opt_noports) { $config{USE_PORTS} = "n"; } $config{IPV6} = "n"; # IPv6 support (experimental) if (defined $opt_ipv6) { $config{IPV6} = "y"; } $config{SUPPORT_IP6LINKS} = "y"; # IPv4 supporting IPv6 links (experimental) if (defined $opt_ipv6links) { $config{SUPPORT_IP6LINKS} = "y"; } if (defined $opt_noipv6links) { $config{SUPPORT_IP6LINKS} = "n"; } $config{STATIC_LINK} = "no"; # are doing static modules? chomp($config{MAX_CLIENT_T} = `sh -c \"ulimit -n\"`); # FD Limit chomp($config{MAX_DESCRIPTORS} = `sh -c \"ulimit -n\"`); # Hard FD Limit chomp($config{GCCVER} = `g++ -dumpversion | cut -c 1`); # Major GCC Version $config{_SOMAXCONN} = SOMAXCONN; # Max connections in accept queue $config{OSNAME} = $^O; # Operating System Name $config{IS_DARWIN} = "NO"; # Is OSX? $config{STARTSCRIPT} = "inspircd"; # start script? $config{DESTINATION} = "BASE"; # Is target path. $config{EXTRA_DIR} = ""; # Is empty. if ($config{OSNAME} =~ /darwin/i) { $config{IS_DARWIN} = "YES"; $config{STARTSCRIPT} = "org.inspircd.plist"; # start script for OSX. $config{DESTINATION} = "LAUNCHDPATH"; # Is OSX target. $config{EXTRA_DIR} = " launchd_dir"; # Is OSX specific path. } $config{CC} = "g++"; # C++ compiler if (defined $opt_cc) { $config{CC} = $opt_cc; } $exec = $config{CC} . " -dumpversion | cut -c 1"; chomp($config{GCCVER} = `$exec`); # Major GCC Version $config{MAKEORDER} = "ircd mods"; # build order $config{STATICLIBS} = ""; # library archive path $config{MAX_IDENT} = "12"; # max ident size $config{MAX_QUIT} = "255"; # max quit message size $config{MAX_TOPIC} = "307"; # max topic size $config{MAX_KICK} = "255"; # max kick message size $config{MAX_GECOS} = "128"; # max GECOS size $config{MAX_AWAY} = "200"; # max AWAY size $config{MAXBUF} = "512"; # Max buffer size if (defined $opt_ident) { $config{MAX_IDENT} = $opt_ident; } if (defined $opt_quit) { $config{MAX_QUIT} = $opt_quit; } if (defined $opt_topic) { $config{MAX_TOPIC} = $opt_topic; } if (defined $opt_kick) { $config{MAX_KICK} = $opt_kick; } if (defined $opt_gecos) { $config{MAX_GECOS} = $opt_gecos; } if (defined $opt_away) { $config{MAX_AWAY} = $opt_away; } $config{HAS_OPENSSL} =~ /^([-[:digit:].]+)([a-z])?(\-[a-z][0-9])?$/; $config{HAS_OPENSSL} = $1; if ($config{GCCVER} eq "") { print $config{CC} . " was not found! You require g++ (the GNU C++ compiler, part of GCC) to build InspIRCd!\n"; exit; } # Minihack! Convert Cygwin to 'Cyg-Static' so i can # Keep my dynamic module experiments here for later # consideration! if ($config{OSNAME} =~ /CYGWIN/i) { $config{OSNAME} = "CYG-STATIC"; } if (!$config{MAX_CLIENT_T}) { $config{MAX_CLIENT_T} = 1024; # Set a reasonable 'Default' $fd_scan_fail = "true"; # Used Later } # Get and Set some important vars.. getmodules(); sub clean { system("rm -rf .config.cache"); } sub update { eval { chomp($topdir = getcwd()); $this = resolve_directory($topdir); # PWD, Regardless. getmodules(); # Does the cache file exist? if (!getcache()) { # No, No it doesn't.. *BASH* print "You have not run ./configure before. Please do this before trying to run the update script.\n"; exit 0; } else { # We've Loaded the cache file and all our variables.. print "Updating Files..\n"; getosflags(); if ($opt_disable_debug == 1) { print "Disabling debug information (-g).\n"; $config{OPTIMISATI} = ""; getosflags(); } $has_epoll = $config{HAS_EPOLL}; $has_ports = $config{HAS_PORTS}; $has_kqueue = $config{HAS_KQUEUE}; writefiles(1); makecache(); print "Complete.\n"; exit; } }; if ($@) { print "Configure update failed: $@\n"; } exit; } sub modupdate { eval { chomp($topdir = getcwd()); $this = resolve_directory($topdir); # PWD, Regardless. getmodules(); # Does the cache file exist? if (!getcache()) { # No, No it doesn't.. *BASH* print "You have not run ./configure before. Please do this before trying to run the update script.\n"; exit 0; } else { # We've Loaded the cache file and all our variables.. print "Updating Files..\n"; getosflags(); $has_epoll = $config{HAS_EPOLL}; $has_ports = $config{HAS_PORTS}; $has_kqueue = $config{HAS_KQUEUE}; writefiles(0); makecache(); print "Complete.\n"; exit; } }; if ($@) { print "Module update failed: $@\n"; } exit; } sub svnupdate { my $fail = 0; open(FH,"<.svn/entries") or $fail = 1; if ($fail) { print "This is not an SVN copy of InspIRCd.\n"; exit; } else { close(FH); } system("svn update"); system("perl configure -update"); if (defined $opt_rebuild) { system("make install"); } exit; } print "Running non-interactive configure...\n" unless $interactive; print "Checking for cache from previous configure... "; print ((getcache() eq "true") ? "found\n" : "not found\n"); print "Checking operating system version... "; print getosflags() . "\n"; if (defined $opt_maxclients) { $config{MAX_CLIENT} = $opt_maxclients; } if (!$config{MAX_CLIENT}) { # If the cache hasn't set the max clients, copy the variable of MAX_CLIENT_T, this # allows us to keep _T for testing purposes. (ie. "Are you sure you want to go # higher than the found value" :)) $config{MAX_CLIENT} = $config{MAX_CLIENT_T}; } printf "Checking if stdint.h exists... "; $config{HAS_STDINT} = "true"; my $fail = 0; open(STDINT, ")) { # try and find the delcaration of: # size_t strlcpy(...) if ($line =~ /size_t(\0x9|\s)+strlcpy/) { $config{HAS_STRLCPY} = "true"; } } close(STRLCPY); } print "yes\n" if $config{HAS_STRLCPY} eq "true"; print "no\n" if $config{HAS_STRLCPY} eq "false"; printf "Checking if kqueue exists... "; $has_kqueue = 0; $fail = 0; open(KQUEUE, ")) { # try and find the delcaration of: # int kqueue(void); if ($line =~ /int(\0x9|\s)+kqueue/) { $has_kqueue = 1; } } close(KQUEUE); } print "yes\n" if $has_kqueue == 1; print "no\n" if $has_kqueue == 0; printf "Checking if epoll exists... "; $has_epoll = 0; $fail = 0; open(EPOLL, "= 1.2) || ($config{HAS_GNUTLS} eq "y"))) { print "yes\n"; $config{HAS_GNUTLS} = "y"; } else { print "no\n"; $config{HAS_GNUTLS} = "n"; } printf "Checking for openssl... "; if (($config{HAS_OPENSSL}) && (($config{HAS_OPENSSL} >= 0.8) || ($config{HAS_OPENSSL} eq "y"))) { print "yes\n"; $config{HAS_OPENSSL} = "y"; } else { print "no\n"; $config{HAS_OPENSSL} = "n"; } ################################################################################ # BEGIN INTERACTIVE PART # ################################################################################ # Clear the Screen.. if ($interactive) { system("clear"); $wholeos = $^O; my $rev = getrevision(); # Display Introduction Message.. print " Welcome to the \033[1mInspIRCd\033[0m Configuration program! (\033[1minteractive mode\033[0m) \033[1mPackage maintainers: Type ./configure --help for non-interactive help\033[0m *** If you are unsure of any of these values, leave it blank for *** *** standard settings that will work, and your server will run *** *** using them. Please consult your IRC network admin if in doubt. *** Press \033[1m\033[0m to accept the default for any option, or enter a new value. Please note: You will \033[1mHAVE\033[0m to read the docs dir, otherwise you won't have a config file! Your operating system is: \033[1;32m$config{OSNAME}\033[0m ($wholeos) Maximum file descriptors: \033[1;32m$config{MAX_CLIENT_T}\033[0m Your InspIRCd revision ID is \033[1;32mr$rev\033[0m"; if ($rev eq "r0") { print " (Non-SVN build)"; } print ".\n\n"; $config{CHANGE_COMPILER} = "n"; print "I have detected the following compiler: \033[1;32m$config{CC}\033[0m (version \033[1;32m$config{GCCVER}.x\033[0m)\n"; while (($config{GCCVER} < 3) || ($config{GCCVER} eq "")) { print "\033[1;32mIMPORTANT!\033[0m A GCC 2.x compiler has been detected, and should NOT be used. You should probably specify a newer compiler.\n\n"; yesno(CHANGE_COMPILER,"Do you want to change the compiler?"); if ($config{CHANGE_COMPILER} =~ /y/i) { print "What command do you want to use to invoke your compiler?\n"; print "[\033[1;32m$config{CC}\033[0m] -> "; chomp($config{CC} = ); if ($config{CC} eq "") { $config{CC} = "g++"; } chomp($foo = `$config{CC} -dumpversion | cut -c 1`); if ($foo ne "") { chomp($config{GCCVER} = `$config{CC} -dumpversion | cut -c 1`); # we must redo these if we change compilers print "Queried compiler: \033[1;32m$config{CC}\033[0m (version \033[1;32m$config{GCCVER}.x\033[0m)\n"; if ($config{GCCVER} < 3) { print "\033[1;32mGCC 2.x WILL NOT WORK!\033[0m. Let's try that again, shall we?\n"; } } else { print "\033[1;32mWARNING!\033[0m Could not execute the compiler you specified. You may want to try again.\n"; } } } print "\n"; # Directory Settings.. my $tmpbase = $config{BASE_DIR}; dir_check("do you wish to install the InspIRCd base", "BASE_DIR"); if ($tmpbase ne $config{BASE_DIR}) { $config{CONFIG_DIR} = resolve_directory($config{BASE_DIR}."/conf"); # Configuration Dir $config{MODULE_DIR} = resolve_directory($config{BASE_DIR}."/modules"); # Modules Directory $config{BINARY_DIR} = resolve_directory($config{BASE_DIR}."/bin"); # Binary Directory $config{LIBRARY_DIR} = resolve_directory($config{BASE_DIR}."/lib"); # Library Directory } dir_check("are the configuration files", "CONFIG_DIR"); dir_check("are the modules to be compiled to", "MODULE_DIR"); dir_check("is the IRCd binary to be placed", "BINARY_DIR"); dir_check("are the IRCd libraries to be placed", "LIBRARY_DIR"); if ($has_kqueue) { yesno(USE_KQUEUE,"You are running a BSD operating system, and kqueue\nwas detected. Would you like to enable kqueue support?\nThis is likely to increase performance.\nIf you are unsure, answer yes.\n\nEnable kqueue?"); print "\n"; } if ($has_epoll) { yesno(USE_EPOLL,"You are running a Linux 2.6+ operating system, and epoll\nwas detected. Would you like to enable epoll support?\nThis is likely to increase performance.\nIf you are unsure, answer yes.\n\nEnable epoll?"); print "\n"; } if ($has_ports) { yesno(USE_PORTS,"You are running Solaris 10.\nWould you like to enable I/O completion ports support?\nThis is likely to increase performance.\nIf you are unsure, answer yes.\n\nEnable support for I/O completion ports?"); print "\n"; } $chose_hiperf = (($config{USE_EPOLL} eq "y") || ($config{USE_KQUEUE} eq "y") || ($config{USE_PORTS} eq "y")); if (!$chose_hiperf) { print "No high-performance socket engines are available, or you chose\n"; print "not to enable one. Defaulting to select() engine.\n\n"; } yesno(IPV6,"Would you like to build InspIRCd with IPv6 support?"); print "\n"; if ($config{IPV6} eq "y") { print "You have chosen to build an \033[1;32mIPV6-enabled\033[0m server.\nTo accept IPV4 users, you can still use IPV4 addresses\nin your port bindings..\n\n"; $config{SUPPORT_IP6LINKS} = "y"; } else { yesno(SUPPORT_IP6LINKS,"You have chosen to build an \033[1;32mIPV4-only\033[0m server.\nWould you like to enable support for linking to IPV6-enabled\nInspIRCd servers?\nIf you are using a recent operating\nsystem and are unsure, answer yes.\nIf you answer 'no' here, your InspIRCd server will be unable\nto parse IPV6 addresses (e.g. for CIDR bans)"); print "\n"; } if (($config{HAS_GNUTLS} eq "y") && ($config{HAS_OPENSSL} eq "y")) { print "I have detected both \033[1;32mGnuTLS\033[0m and \033[1;32mOpenSSL\033[0m on your system.\n"; print "I will default to GnuTLS. If you wish to use OpenSSL\n"; print "instead, you should enable the OpenSSL module yourself\n"; print "by copying it from src/modules/extra to src/modules.\n\n"; print "Detected GnuTLS version: \033[1;32m" . $gnutls_ver . "\033[0m\n"; print "Detected OpenSSL version: \033[1;32m" . $openssl_ver . "\033[0m\n\n"; } if ($config{HAS_GNUTLS} eq "y") { yesno(USE_GNUTLS, "Would you like to enable SSL Support?"); if ($config{USE_GNUTLS} eq "y") { print "\nUsing GnuTLS SSL module.\n"; } } elsif ($config{HAS_OPENSSL} eq "y") { yesno(USE_OPENSSL, "Would you like to enable SSL Support?"); if ($config{USE_OPENSSL} eq "y") { print "\nUsing OpenSSL SSL module.\nYou will get better performance if you move to GnuTLS in the future.\n"; } } else { print "\nCould not detect OpenSSL or GnuTLS. Make sure pkg-config is installed if\nyou intend to use OpenSSL, or that GnuTLS is in your path if you intend\nto use GnuTLS.\n\n"; } print "\nThe following questions will ask you for various figures relating\n"; print "To your IRCd install. Please note that these should usually be left\n"; print "as defaults unless you have a real reason to change them. If they\n"; print "changed, then the values must be identical on all servers on your\n"; print "network, or malfunctions and/or crashes may occur, with the exception\n"; print "of the 'maximum number of clients' setting which may be different on\n"; print "different servers on the network.\n\n"; # File Descriptor Settings.. promptnumeric("number of clients at any one time", "MAX_CLIENT_T"); $config{MAX_CLIENT} = $config{MAX_CLIENT_T}; $config{MAX_DESCRIPTORS} = $config{MAX_CLIENT_T}; promptnumeric("length of nicknames", "NICK_LENGT"); promptnumeric("length of channel names", "CHAN_LENGT"); promptnumeric("number of mode changes in one line", "MAXI_MODES"); promptnumeric("length of an ident (username)", "MAX_IDENT"); promptnumeric("length of a quit message", "MAX_QUIT"); promptnumeric("length of a channel topic", "MAX_TOPIC"); promptnumeric("length of a kick message", "MAX_KICK"); promptnumeric("length of a GECOS (real name)", "MAX_GECOS"); promptnumeric("length of an away message", "MAX_AWAY"); } dumphash(); if (($config{USE_GNUTLS} eq "y") && ($config{HAS_GNUTLS} ne "y")) { print "Sorry, but i couldn't detect gnutls. Make sure gnutls-config is in your path.\n"; exit(0); } if (($config{USE_OPENSSL} eq "y") && ($config{HAS_OPENSSL} ne "y")) { print "Sorry, but i couldn't detect openssl. Make sure openssl is in your path.\n"; exit(0); } if ($config{USE_GNUTLS} eq "y") { $failed = 0; open(TMP, ") { chomp; # Ignore Blank lines, and comments.. next if /^\s*$/; next if /^\s*#/; my ($key, $value) = split("=", $_, 2); $value =~ /^\"(.*)\"$/; # Do something with data here! $config{$key} = $1; } close(CONFIG); return "true"; } sub makecache { # Dump the contents of %config print "Writing \033[1;32mcache file\033[0m for future ./configures ...\n"; open(FILEHANDLE, ">.config.cache"); foreach $key (keys %config) { print FILEHANDLE "$key=\"$config{$key}\"\n"; } close(FILEHANDLE); } sub dir_check { my ($desc, $hash_key) = @_; my $complete = 0; while (!$complete) { print "In what directory $desc?\n"; print "[\033[1;32m$config{$hash_key}\033[0m] -> "; chomp($var = ); if ($var eq "") { $var = $config{$hash_key}; } if ($var =~ /^\~\/(.+)$/) { # Convert it to a full path.. $var = resolve_directory($ENV{HOME} . "/" . $1); } elsif ((($config{OSNAME} =~ /MINGW32/i) and ($var !~ /^[A-Z]{1}:\\.*/)) and (substr($var,0,1) ne "/")) { # Assume relative Path was given.. fill in the rest. $var = $this . "/$var"; } $var = resolve_directory($var); if (! -e $var) { print "$var does not exist. Create it?\n[\033[1;32my\033[0m] "; chomp($tmp = ); if (($tmp eq "") || ($tmp =~ /^y/i)) { # Attempt to Create the Dir.. system("mkdir -p \"$var\" >> /dev/null 2>&1"); $chk = system("mkdir -p \"$var\" >> /dev/null 2>&1") / 256; if ($chk != 0) { print "Unable to create directory. ($var)\n\n"; # Restart Loop.. next; } } else { # They said they don't want to create, and we can't install there. print "\n\n"; next; } } else { if (!is_dir($var)) { # Target exists, but is not a directory. print "File $var exists, but is not a directory.\n\n"; next; } } # Either Dir Exists, or was created fine. $config{$hash_key} = $var; $complete = 1; print "\n"; } } sub getosflags { $config{LDLIBS} = "-lstdc++"; $config{FLAGS} = "-fno-strict-aliasing -fPIC -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; $config{DEVELOPER} = "-fno-strict-aliasing -fPIC -Wall -Woverloaded-virtual -Wno-deprecated -g"; $SHARED = "-Wl,--rpath -Wl,$config{LIBRARY_DIR} -shared"; $config{MAKEPROG} = "make"; if ($config{OSNAME} =~ /darwin/i) { $config{FLAGS} = "-DDARWIN -frtti -fPIC -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; $SHARED = "-bundle -twolevel_namespace -undefined dynamic_lookup"; $config{LDLIBS} = "-ldl -lstdc++"; } if ($config{OSNAME} =~ /OpenBSD/i) { $config{MAKEPROG} = "gmake"; chomp($foo = `eg++ -dumpversion | cut -c 1`); # theyre running the package version of gcc (eg++)... detect it and set up its version numbers. # if theyre not running this, configure lets the build continue but they probably wont manage to # compile as this standard version is 2.95.3! if ($foo ne "") { $config{CC} = "eg++"; chomp($config{GCCVER} = `eg++ -dumpversion | cut -c 1`); # we must redo these if we change the compiler path } return "OpenBSD"; } if ($config{OSNAME} =~ /Linux/i) { $config{LDLIBS} = "-ldl -lstdc++"; $config{FLAGS} = "-fno-strict-aliasing -fPIC -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; $config{FLAGS} .= " " . $ENV{CXXFLAGS} if exists($ENV{CXXFLAGS}); $config{LDLIBS} .= " " . $ENV{LDLIBS} if exists($ENV{LDLIBS}); $config{MAKEPROG} = "make"; if ($config{OSNAME} =~ /CYGWIN/) { $config{FLAGS} = "-fno-strict-aliasing -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; $config{LDLIBS} = ""; $config{MAKEPROG} = "/usr/bin/make"; $config{MAKEORDER} = "ircd mods"; return "Cygwin"; } elsif ($config{OSNAME} eq "CYG-STATIC") { $config{FLAGS} = "-fno-strict-aliasing -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; $config{LDLIBS} = ""; $config{MAKEPROG} = "/usr/bin/make"; $config{MAKEORDER} = "mods ircd"; $config{STATICLIBS} = "modules/mods.a"; $config{STATIC_LINK} = "yes"; return "Cygwin-Static"; } } if ($config{OSNAME} =~ /FreeBSD/i) { $config{FLAGS} .= " " . $ENV{CXXFLAGS} if exists($ENV{CXXFLAGS}); $config{LDLIBS} .= " " . $ENV{LDLIBS} if exists($ENV{LDLIBS}); } if ($config{OSNAME} =~ /SunOS/i or $config{OSNAME} =~ /solaris/i) { # solaris/sunos needs these # socket = bsd sockets api # nsl = dns stuff # rt = POSIX realtime extensions # resolv = inet_aton only (why isnt this in nsl?!) $config{MAKEPROG} = "gmake"; $config{LDLIBS} .= " -lsocket -lnsl -lrt -lresolv"; return "Solaris"; } if($config{OSNAME} =~ /MINGW32/i) { # All code is position-independent on windows $config{FLAGS} =~ s/-fPIC //; return "MinGW"; } return $config{OSNAME}; } sub writefiles { my($writeheader) = @_; # First File.. inspircd_config.h chomp(my $incos = `uname -n -s -r`); chomp($version = `sh src/version.sh`); chomp(my $revision2 = getrevision()); if ($writeheader == 1) { print "Writing \033[1;32minspircd_config.h\033[0m\n"; open(FILEHANDLE, ">include/inspircd_config.h"); my $NL = $config{NICK_LENGT}+1; my $CL = $config{CHAN_LENGT}+1; print FILEHANDLE <= 3) { print FILEHANDLE "#define GCC3\n"; } if ($config{HAS_STRLCPY} eq "true") { print FILEHANDLE "#define HAS_STRLCPY\n"; } if ($config{HAS_STDINT} eq "true") { print FILEHANDLE "#define HAS_STDINT\n"; } if ($config{IPV6} =~ /y/i) { print FILEHANDLE "#define IPV6\n"; } if ($config{SUPPORT_IP6LINKS} =~ /y/i) { print FILEHANDLE "#define SUPPORT_IP6LINKS\n"; } my $use_hiperf = 0; if (($has_kqueue) && ($config{USE_KQUEUE} eq "y")) { print FILEHANDLE "#define USE_KQUEUE\n"; $se = "socketengine_kqueue"; $use_hiperf = 1; } if (($has_epoll) && ($config{USE_EPOLL} eq "y")) { print FILEHANDLE "#define USE_EPOLL\n"; $se = "socketengine_epoll"; $use_hiperf = 1; } if (($has_ports) && ($config{USE_PORTS} eq "y")) { print FILEHANDLE "#define USE_PORTS\n"; $se = "socketengine_ports"; $use_hiperf = 1; } # user didn't choose either epoll or select for their OS. # default them to USE_SELECT (ewwy puke puke) if (!$use_hiperf) { print FILEHANDLE "#define USE_SELECT\n"; $se = "socketengine_select"; } print FILEHANDLE "\n#endif\n"; close(FILEHANDLE); } if ($writeheader) { open(FILEHANDLE, ">include/inspircd_se_config.h"); print FILEHANDLE <) { $tmp .= $_; } close(FILEHANDLE); $tmp =~ s/\@CC\@/$config{CC}/; $tmp =~ s/\@MAKEPROG\@/$config{MAKEPROG}/; $tmp =~ s/\@FLAGS\@/$config{FLAGS}/; $tmp =~ s/\@DEVELOPER\@/$config{DEVELOPER}/; $tmp =~ s/\@LDLIBS\@/$config{LDLIBS}/; $tmp =~ s/\@BASE_DIR\@/$config{BASE_DIR}/; $tmp =~ s/\@CONFIG_DIR\@/$config{CONFIG_DIR}/; $tmp =~ s/\@MODULE_DIR\@/$config{MODULE_DIR}/; $tmp =~ s/\@BINARY_DIR\@/$config{BINARY_DIR}/; $tmp =~ s/\@LIBRARY_DIR\@/$config{LIBRARY_DIR}/; $tmp =~ s/\@LIBRARY_EXT\@/$LIBEXT/; $tmp =~ s/\@MODULES\@/$modules/; $tmp =~ s/\@STARTSCRIPT\@/$config{STARTSCRIPT}/; $tmp =~ s/\@DESTINATION\@/$config{DESTINATION}/; $tmp =~ s/\@EXTRA_DIR\@/$config{EXTRA_DIR}/; $tmp =~ s/\@EXECUTABLE\@/$exe/; $tmp =~ s/\@MAKEORDER\@/$config{MAKEORDER}/; $tmp =~ s/\@STATICLIBS\@/$config{STATICLIBS}/; $tmp =~ s/\@VERSION\@/$version/; print "Writing \033[1;32m$file\033[0m\n"; open(FILEHANDLE, ">$file"); print FILEHANDLE $tmp; } } closedir(DIRHANDLE); # Make inspircd executable! chmod 0744, 'inspircd'; if ($config{STATIC_LINK} eq "yes") { print "Writing static-build \033[1;32msrc/Makefile\033[0m\n"; write_static_makefile(); write_static_modules_makefile(); } elsif ($config{OSNAME} =~ /CYGWIN/i) { print "Writing cygwin-build \033[1;32msrc/Makefile\033[0m\n"; write_static_makefile(); write_dynamic_modules_makefile(); } else { print "Writing dynamic-build \033[1;32msrc/Makefile\033[0m\n"; write_dynamic_makefile(); write_dynamic_modules_makefile(); } } sub write_static_modules_makefile { # Modules Makefile.. print "Writing \033[1;32msrc/modules/Makefile\033[0m\n"; open(FILEHANDLE, ">src/modules/Makefile"); ### # Module Makefile Header ### print FILEHANDLE < # Many Thanks to Andrew Church # for assisting with making this work right. # # Automatically Generated by ./configure to add a modules # please run ./configure --update all: \$(MODULES) EOF ### # End Module Makefile Header ### # Create a Modules List.. my $modules = ""; my $cmflags = ""; my $liflags = ""; open(MODLIST,">include/modlist.h"); ### # Include File Header ### print MODLIST <src/modules/.m_".$i."_static.cpp") or die("Could not create .m_".$i."_static.cpp"); while (chomp($a = )) { $a =~ s/init_module/$i\_init/g; print MUNGED "$a\n"; } close(MODULE); close(MUNGED); print MODLIST <src/modules/Makefile"); my $extra = ""; if ($config{OSNAME} =~ /CYGWIN/i) { $extra = "../inspircd.dll.a"; } ### # Module Makefile Header ### print FILEHANDLE < # Many Thanks to Andrew Church # for assisting with making this work right. # # Automatically Generated by ./configure to add a modules # please run ./configure -update or ./configure -modupdate all: \$(MODULES) EOF ### # End Module Makefile Header ### # Create a Modules List.. my $modules = ""; my $cmflags = ""; my $liflags = ""; my $crud = ""; foreach $i (@modlist) { ### # Write Entry to the MakeFile ### $cmflags = getcompilerflags("src/modules/m_".$i.".cpp"); $liflags = getlinkerflags("src/modules/m_".$i.".cpp"); $deps = getdependencies("src/modules/m_".$i.".cpp"); #print "file: $i: cmflags=$cmflags; liflags=$liflags; deps=$deps\n"; print FILEHANDLE <src/Makefile") or die("Could not write src/Makefile!"); my $i = 0; my @cmdlist = (); opendir(DIRHANDLE, "src"); foreach $name (sort readdir(DIRHANDLE)) { if ($name =~ /^cmd_(.+)\.cpp$/) { $cmdlist[$i++] = $1; } } closedir(DIRHANDLE); my $cmdobjs = ""; my $srcobjs = ""; foreach my $cmd (@cmdlist) { $cmdobjs = $cmdobjs . "cmd_$cmd.o "; $srcobjs = $srcobjs . "cmd_$cmd.cpp "; } print FH < # Makefile version 2 (statically linked core) by # CC = im a cheezeball CXXFLAGS = -I../include \${FLAGS} CPPFILES = \$(shell /bin/ls -l modes/ | grep '\\.cpp' | sed 's/^.* //' | grep -v svn) RELCPPFILES = \$(shell /bin/ls -l modes/ | grep '\\.cpp' | sed 's/^.* /modes\\//' | grep -v svn) EOM $se = "socketengine_select"; if (($has_kqueue) && ($config{USE_KQUEUE} eq "y")) { $se = "socketengine_kqueue"; } elsif (($has_epoll) && ($config{USE_EPOLL} eq "y")) { $se = "socketengine_epoll"; } elsif (($has_ports) && ($config{USE_PORTS} eq "y")) { $se = "socketengine_ports"; } ### # This next section is for cygwin dynamic module builds. # Basically, what we do, is build the inspircd core as a library # then the main executable uses that. the library is capable of # loading / unloading the modules dynamically :) # Massive thanks to the guys on #cygwin @ irc.freenode.net for helping # make this work :) ### if ($config{OSNAME} =~ /CYGWIN/i) { print FH <src/Makefile") or die("Could not write src/Makefile"); print FH < # Makefile version 2 (dynamically linked core) by # CC = im a cheezeball CXXFLAGS = -I../include \${FLAGS} CPPFILES = \$(shell /bin/ls -l modes/ | grep '\\.cpp' | sed 's/^.* //' | grep -v svn) RELCPPFILES = \$(shell /bin/ls -l modes/ | grep '\\.cpp' | sed 's/^.* /modes\\//' | grep -v svn) EOM if ($config{IS_DARWIN} eq "YES") { print FH < \$opt_use_gnutls, + 'rebuild' => \$opt_rebuild, + 'enable-openssl' => \$opt_use_openssl, + 'disable-interactive' => \$opt_nointeractive, + 'with-nick-length=i' => \$opt_nick_length, + 'with-channel-length=i' => \$opt_chan_length, + 'with-max-clients=i' => \$opt_maxclients, + 'enable-ports' => \$opt_ports, + 'enable-epoll' => \$opt_epoll, + 'enable-kqueue' => \$opt_kqueue, + 'disable-ports' => \$opt_noports, + 'disable-epoll' => \$opt_noepoll, + 'disable-kqueue' => \$opt_nokqueue, + 'enable-ipv6' => \$opt_ipv6, + 'enable-remote-ipv6' => \$opt_ipv6links, + 'disable-remote-ipv6' => \$opt_noipv6links, + 'with-cc=s' => \$opt_cc, + 'with-ident-length=i' => \$opt_ident, + 'with-quit-length=i' => \$opt_quit, + 'with-topic-length=i' => \$opt_topic, + 'with-maxbuf=i' => \$opt_maxbuf, + 'with-kick-length=i' => \$opt_kick, + 'with-gecos-length=i' => \$opt_gecos, + 'with-away-length=i' => \$opt_away, + 'with-max-modes=i' => \$opt_modes, + 'prefix=s' => \$opt_base_dir, + 'config-dir=s' => \$opt_config_dir, + 'module-dir=s' => \$opt_module_dir, + 'binary-dir=s' => \$opt_binary_dir, + 'library-dir=s' => \$opt_library_dir, + 'disable-debuginfo' => sub { $opt_disable_debug = 1 }, + 'help' => sub { showhelp(); }, + 'modupdate' => sub { modupdate(); }, + 'update' => sub { update(); }, + 'svnupdate' => sub { svnupdate(); }, + 'clean' => sub { clean(); }, +); + +my $non_interactive = ( + (defined $opt_library_dir) || + (defined $opt_base_dir) || + (defined $opt_config_dir) || + (defined $opt_module_dir) || + (defined $opt_base_dir) || + (defined $opt_binary_dir) || + (defined $opt_nointeractive) || + (defined $opt_away) || + (defined $opt_gecos) || + (defined $opt_kick) || + (defined $opt_maxclients) || + (defined $opt_modes) || + (defined $opt_topic) || + (defined $opt_quit) || + (defined $opt_ident) || + (defined $opt_cc) || + (defined $opt_ipv6) || + (defined $opt_ipv6links) || + (defined $opt_noipv6links) || + (defined $opt_kqueue) || + (defined $opt_epoll) || + (defined $opt_ports) || + (defined $opt_maxchans) || + (defined $opt_opermaxchans) || + (defined $opt_chan_length) || + (defined $opt_nick_length) || + (defined $opt_use_openssl) || + (defined $opt_nokqueue) || + (defined $opt_noepoll) || + (defined $opt_noports) || + (defined $opt_maxbuf) || + (defined $opt_use_gnutls) +); +my $interactive = !$non_interactive; + + +chomp($topdir = getcwd()); +$this = resolve_directory($topdir); # PWD, Regardless. +@modlist = (); # Declare for Module List.. +%config = (); # Initiate Configuration Hash.. +$config{ME} = resolve_directory($topdir); # Present Working Directory + +$config{BASE_DIR} = $config{ME}; + +if (defined $opt_base_dir) +{ + $config{BASE_DIR} = $opt_base_dir; +} + +$config{CONFIG_DIR} = resolve_directory($config{BASE_DIR}."/conf"); # Configuration Directory +$config{MODULE_DIR} = resolve_directory($config{BASE_DIR}."/modules"); # Modules Directory +$config{BINARY_DIR} = resolve_directory($config{BASE_DIR}."/bin"); # Binary Directory +$config{LIBRARY_DIR} = resolve_directory($config{BASE_DIR}."/lib"); # Library Directory + +if (defined $opt_config_dir) +{ + $config{CONFIG_DIR} = $opt_config_dir; +} +if (defined $opt_module_dir) +{ + $config{MODULE_DIR} = $opt_module_dir; +} +if (defined $opt_binary_dir) +{ + $config{BINARY_DIR} = $opt_binary_dir; +} +if (defined $opt_library_dir) +{ + $config{LIBRARY_DIR} = $opt_library_dir; +} +chomp($config{HAS_GNUTLS} = `libgnutls-config --version 2>/dev/null | cut -c 1,2,3`); # GNUTLS Version. +chomp($config{HAS_OPENSSL} = `pkg-config --modversion openssl 2>/dev/null`); # Openssl version +chomp($gnutls_ver = $config{HAS_GNUTLS}); +chomp($openssl_ver = $config{HAS_OPENSSL}); +$config{USE_GNUTLS} = "n"; +if (defined $opt_use_gnutls) +{ + $config{USE_GNUTLS} = "y"; # Use gnutls. +} +$config{USE_OPENSSL} = "n"; # Use openssl. +if (defined $opt_use_openssl) +{ + $config{USE_OPENSSL} = "y"; +} + +# no, let's not change these. +$config{OPTIMITEMP} = "0"; # Default Optimisation Value +if (!defined $opt_disable_debug) +{ + $config{OPTIMISATI} = "-g1"; # Optimisation Flag +} +else +{ + $config{OPTIMISATI} = "-O2"; # DEBUGGING OFF! +} + +$config{NICK_LENGT} = "31"; # Default Nick Length +if (defined $opt_nick_length) +{ + $config{NICK_LENGT} = $opt_nick_length; +} +$config{CHAN_LENGT} = "64"; # Default Channel Name Length +if (defined $opt_chan_length) +{ + $config{CHAN_LENGT} = $opt_chan_length; +} +$config{MAXI_MODES} = "20"; # Default Max. Number of Modes set at once. +if (defined $opt_modes) +{ + $config{MAXI_MODES} = $opt_modes; +} +$config{HAS_STRLCPY} = "false"; # strlcpy Check. +$config{HAS_STDINT} = "false"; # stdint.h check +$config{USE_KQUEUE} = "y"; # kqueue enabled +if (defined $opt_kqueue) +{ + $config{USE_KQUEUE} = "y"; +} +if (defined $opt_nokqueue) +{ + $config{USE_KQUEUE} = "n"; +} +$config{USE_EPOLL} = "y"; # epoll enabled +if (defined $opt_epoll) +{ + $config{USE_EPOLL} = "y"; +} +if (defined $opt_noepoll) +{ + $config{USE_EPOLL} = "n"; +} +$config{USE_PORTS} = "y"; # epoll enabled +if (defined $opt_ports) +{ + $config{USE_PORTS} = "y"; +} +if (defined $opt_noports) +{ + $config{USE_PORTS} = "n"; +} +$config{IPV6} = "n"; # IPv6 support (experimental) +if (defined $opt_ipv6) +{ + $config{IPV6} = "y"; +} +$config{SUPPORT_IP6LINKS} = "y"; # IPv4 supporting IPv6 links (experimental) +if (defined $opt_ipv6links) +{ + $config{SUPPORT_IP6LINKS} = "y"; +} +if (defined $opt_noipv6links) +{ + $config{SUPPORT_IP6LINKS} = "n"; +} +$config{STATIC_LINK} = "no"; # are doing static modules? +chomp($config{MAX_CLIENT_T} = `sh -c \"ulimit -n\"`); # FD Limit +chomp($config{MAX_DESCRIPTORS} = `sh -c \"ulimit -n\"`); # Hard FD Limit +chomp($config{GCCVER} = `g++ -dumpversion | cut -c 1`); # Major GCC Version +$config{_SOMAXCONN} = SOMAXCONN; # Max connections in accept queue +$config{OSNAME} = $^O; # Operating System Name +$config{IS_DARWIN} = "NO"; # Is OSX? +$config{STARTSCRIPT} = "inspircd"; # start script? +$config{DESTINATION} = "BASE"; # Is target path. +$config{EXTRA_DIR} = ""; # Is empty. +if ($config{OSNAME} =~ /darwin/i) +{ + $config{IS_DARWIN} = "YES"; + $config{STARTSCRIPT} = "org.inspircd.plist"; # start script for OSX. + $config{DESTINATION} = "LAUNCHDPATH"; # Is OSX target. + $config{EXTRA_DIR} = " launchd_dir"; # Is OSX specific path. +} +$config{CC} = "g++"; # C++ compiler +if (defined $opt_cc) +{ + $config{CC} = $opt_cc; +} +$exec = $config{CC} . " -dumpversion | cut -c 1"; +chomp($config{GCCVER} = `$exec`); # Major GCC Version +$config{MAKEORDER} = "ircd mods"; # build order +$config{STATICLIBS} = ""; # library archive path +$config{MAX_IDENT} = "12"; # max ident size +$config{MAX_QUIT} = "255"; # max quit message size +$config{MAX_TOPIC} = "307"; # max topic size +$config{MAX_KICK} = "255"; # max kick message size +$config{MAX_GECOS} = "128"; # max GECOS size +$config{MAX_AWAY} = "200"; # max AWAY size +$config{MAXBUF} = "512"; # Max buffer size +if (defined $opt_ident) +{ + $config{MAX_IDENT} = $opt_ident; +} +if (defined $opt_quit) +{ + $config{MAX_QUIT} = $opt_quit; +} +if (defined $opt_topic) +{ + $config{MAX_TOPIC} = $opt_topic; +} +if (defined $opt_kick) +{ + $config{MAX_KICK} = $opt_kick; +} +if (defined $opt_gecos) +{ + $config{MAX_GECOS} = $opt_gecos; +} +if (defined $opt_away) +{ + $config{MAX_AWAY} = $opt_away; +} + +$config{HAS_OPENSSL} =~ /^([-[:digit:].]+)([a-z])?(\-[a-z][0-9])?$/; +$config{HAS_OPENSSL} = $1; + +if ($config{GCCVER} eq "") { + print $config{CC} . " was not found! You require g++ (the GNU C++ compiler, part of GCC) to build InspIRCd!\n"; + exit; +} + +# Minihack! Convert Cygwin to 'Cyg-Static' so i can +# Keep my dynamic module experiments here for later +# consideration! + +if ($config{OSNAME} =~ /CYGWIN/i) +{ + $config{OSNAME} = "CYG-STATIC"; +} + +if (!$config{MAX_CLIENT_T}) { + $config{MAX_CLIENT_T} = 1024; # Set a reasonable 'Default' + $fd_scan_fail = "true"; # Used Later +} + +# Get and Set some important vars.. +getmodules(); + +sub clean +{ + system("rm -rf .config.cache"); +} + +sub update +{ + eval { + chomp($topdir = getcwd()); + $this = resolve_directory($topdir); # PWD, Regardless. + getmodules(); + # Does the cache file exist? + if (!getcache()) { + # No, No it doesn't.. *BASH* + print "You have not run ./configure before. Please do this before trying to run the update script.\n"; + exit 0; + } else { + # We've Loaded the cache file and all our variables.. + print "Updating Files..\n"; + getosflags(); + if ($opt_disable_debug == 1) + { + print "Disabling debug information (-g).\n"; + $config{OPTIMISATI} = ""; + getosflags(); + } + $has_epoll = $config{HAS_EPOLL}; + $has_ports = $config{HAS_PORTS}; + $has_kqueue = $config{HAS_KQUEUE}; + writefiles(1); + makecache(); + print "Complete.\n"; + exit; + } + }; + if ($@) + { + print "Configure update failed: $@\n"; + } + exit; +} + +sub modupdate +{ + eval { + chomp($topdir = getcwd()); + $this = resolve_directory($topdir); # PWD, Regardless. + getmodules(); + # Does the cache file exist? + if (!getcache()) { + # No, No it doesn't.. *BASH* + print "You have not run ./configure before. Please do this before trying to run the update script.\n"; + exit 0; + } else { + # We've Loaded the cache file and all our variables.. + print "Updating Files..\n"; + getosflags(); + $has_epoll = $config{HAS_EPOLL}; + $has_ports = $config{HAS_PORTS}; + $has_kqueue = $config{HAS_KQUEUE}; + writefiles(0); + makecache(); + print "Complete.\n"; + exit; + } + }; + if ($@) + { + print "Module update failed: $@\n"; + } + exit; +} + + + +sub svnupdate +{ + my $fail = 0; + open(FH,"<.svn/entries") or $fail = 1; + if ($fail) { + print "This is not an SVN copy of InspIRCd.\n"; + exit; + } + else + { + close(FH); + } + system("svn update"); + system("perl configure -update"); + if (defined $opt_rebuild) { + system("make install"); + } + exit; +} + +print "Running non-interactive configure...\n" unless $interactive; +print "Checking for cache from previous configure... "; +print ((getcache() eq "true") ? "found\n" : "not found\n"); +print "Checking operating system version... "; +print getosflags() . "\n"; + +if (defined $opt_maxclients) +{ + $config{MAX_CLIENT} = $opt_maxclients; +} + +if (!$config{MAX_CLIENT}) { + # If the cache hasn't set the max clients, copy the variable of MAX_CLIENT_T, this + # allows us to keep _T for testing purposes. (ie. "Are you sure you want to go + # higher than the found value" :)) + $config{MAX_CLIENT} = $config{MAX_CLIENT_T}; +} + +printf "Checking if stdint.h exists... "; +$config{HAS_STDINT} = "true"; +my $fail = 0; +open(STDINT, ")) { + # try and find the delcaration of: + # size_t strlcpy(...) + if ($line =~ /size_t(\0x9|\s)+strlcpy/) { + $config{HAS_STRLCPY} = "true"; + } + } + close(STRLCPY); +} +print "yes\n" if $config{HAS_STRLCPY} eq "true"; +print "no\n" if $config{HAS_STRLCPY} eq "false"; + + +printf "Checking if kqueue exists... "; +$has_kqueue = 0; +$fail = 0; +open(KQUEUE, ")) { + # try and find the delcaration of: + # int kqueue(void); + if ($line =~ /int(\0x9|\s)+kqueue/) { + $has_kqueue = 1; + } + } + close(KQUEUE); +} +print "yes\n" if $has_kqueue == 1; +print "no\n" if $has_kqueue == 0; + +printf "Checking if epoll exists... "; +$has_epoll = 0; +$fail = 0; +open(EPOLL, "= 1.2) || ($config{HAS_GNUTLS} eq "y"))) { + print "yes\n"; + $config{HAS_GNUTLS} = "y"; +} else { + print "no\n"; + $config{HAS_GNUTLS} = "n"; +} + +printf "Checking for openssl... "; +if (($config{HAS_OPENSSL}) && (($config{HAS_OPENSSL} >= 0.8) || ($config{HAS_OPENSSL} eq "y"))) { + print "yes\n"; + $config{HAS_OPENSSL} = "y"; +} else { + print "no\n"; + $config{HAS_OPENSSL} = "n"; +} + +################################################################################ +# BEGIN INTERACTIVE PART # +################################################################################ + +# Clear the Screen.. +if ($interactive) +{ + system("clear"); + $wholeos = $^O; + + my $rev = getrevision(); + # Display Introduction Message.. + print " +Welcome to the \033[1mInspIRCd\033[0m Configuration program! (\033[1minteractive mode\033[0m) +\033[1mPackage maintainers: Type ./configure --help for non-interactive help\033[0m + +*** If you are unsure of any of these values, leave it blank for *** +*** standard settings that will work, and your server will run *** +*** using them. Please consult your IRC network admin if in doubt. *** + +Press \033[1m\033[0m to accept the default for any option, or enter +a new value. Please note: You will \033[1mHAVE\033[0m to read the docs +dir, otherwise you won't have a config file! + +Your operating system is: \033[1;32m$config{OSNAME}\033[0m ($wholeos) +Maximum file descriptors: \033[1;32m$config{MAX_CLIENT_T}\033[0m +Your InspIRCd revision ID is \033[1;32mr$rev\033[0m"; + if ($rev eq "r0") { + print " (Non-SVN build)"; + } + print ".\n\n"; + + $config{CHANGE_COMPILER} = "n"; + print "I have detected the following compiler: \033[1;32m$config{CC}\033[0m (version \033[1;32m$config{GCCVER}.x\033[0m)\n"; + + while (($config{GCCVER} < 3) || ($config{GCCVER} eq "")) { + print "\033[1;32mIMPORTANT!\033[0m A GCC 2.x compiler has been detected, and +should NOT be used. You should probably specify a newer compiler.\n\n"; + yesno(CHANGE_COMPILER,"Do you want to change the compiler?"); + if ($config{CHANGE_COMPILER} =~ /y/i) { + print "What command do you want to use to invoke your compiler?\n"; + print "[\033[1;32m$config{CC}\033[0m] -> "; + chomp($config{CC} = ); + if ($config{CC} eq "") { + $config{CC} = "g++"; + } + chomp($foo = `$config{CC} -dumpversion | cut -c 1`); + if ($foo ne "") { + chomp($config{GCCVER} = `$config{CC} -dumpversion | cut -c 1`); # we must redo these if we change compilers + print "Queried compiler: \033[1;32m$config{CC}\033[0m (version \033[1;32m$config{GCCVER}.x\033[0m)\n"; + if ($config{GCCVER} < 3) { + print "\033[1;32mGCC 2.x WILL NOT WORK!\033[0m. Let's try that again, shall we?\n"; + } + } + else { + print "\033[1;32mWARNING!\033[0m Could not execute the compiler you specified. You may want to try again.\n"; + } + } + } + + print "\n"; + + # Directory Settings.. + my $tmpbase = $config{BASE_DIR}; + dir_check("do you wish to install the InspIRCd base", "BASE_DIR"); + if ($tmpbase ne $config{BASE_DIR}) { + $config{CONFIG_DIR} = resolve_directory($config{BASE_DIR}."/conf"); # Configuration Dir + $config{MODULE_DIR} = resolve_directory($config{BASE_DIR}."/modules"); # Modules Directory + $config{BINARY_DIR} = resolve_directory($config{BASE_DIR}."/bin"); # Binary Directory + $config{LIBRARY_DIR} = resolve_directory($config{BASE_DIR}."/lib"); # Library Directory + } + + dir_check("are the configuration files", "CONFIG_DIR"); + dir_check("are the modules to be compiled to", "MODULE_DIR"); + dir_check("is the IRCd binary to be placed", "BINARY_DIR"); + dir_check("are the IRCd libraries to be placed", "LIBRARY_DIR"); + + if ($has_kqueue) { + yesno(USE_KQUEUE,"You are running a BSD operating system, and kqueue\nwas detected. Would you like to enable kqueue support?\nThis is likely to increase performance.\nIf you are unsure, answer yes.\n\nEnable kqueue?"); + print "\n"; + } + if ($has_epoll) { + yesno(USE_EPOLL,"You are running a Linux 2.6+ operating system, and epoll\nwas detected. Would you like to enable epoll support?\nThis is likely to increase performance.\nIf you are unsure, answer yes.\n\nEnable epoll?"); + print "\n"; + } + if ($has_ports) { + yesno(USE_PORTS,"You are running Solaris 10.\nWould you like to enable I/O completion ports support?\nThis is likely to increase performance.\nIf you are unsure, answer yes.\n\nEnable support for I/O completion ports?"); + print "\n"; + } + $chose_hiperf = (($config{USE_EPOLL} eq "y") || ($config{USE_KQUEUE} eq "y") || ($config{USE_PORTS} eq "y")); + if (!$chose_hiperf) { + print "No high-performance socket engines are available, or you chose\n"; + print "not to enable one. Defaulting to select() engine.\n\n"; + } + + yesno(IPV6,"Would you like to build InspIRCd with IPv6 support?"); + print "\n"; + + if ($config{IPV6} eq "y") { + print "You have chosen to build an \033[1;32mIPV6-enabled\033[0m server.\nTo accept IPV4 users, you can still use IPV4 addresses\nin your port bindings..\n\n"; + $config{SUPPORT_IP6LINKS} = "y"; + } else { + yesno(SUPPORT_IP6LINKS,"You have chosen to build an \033[1;32mIPV4-only\033[0m server.\nWould you like to enable support for linking to IPV6-enabled\nInspIRCd servers?\nIf you are using a recent operating\nsystem and are unsure, answer yes.\nIf you answer 'no' here, your InspIRCd server will be unable\nto parse IPV6 addresses (e.g. for CIDR bans)"); + print "\n"; + } + + if (($config{HAS_GNUTLS} eq "y") && ($config{HAS_OPENSSL} eq "y")) { + print "I have detected both \033[1;32mGnuTLS\033[0m and \033[1;32mOpenSSL\033[0m on your system.\n"; + print "I will default to GnuTLS. If you wish to use OpenSSL\n"; + print "instead, you should enable the OpenSSL module yourself\n"; + print "by copying it from src/modules/extra to src/modules.\n\n"; + print "Detected GnuTLS version: \033[1;32m" . $gnutls_ver . "\033[0m\n"; + print "Detected OpenSSL version: \033[1;32m" . $openssl_ver . "\033[0m\n\n"; + } + + if ($config{HAS_GNUTLS} eq "y") { + yesno(USE_GNUTLS, "Would you like to enable SSL Support?"); + if ($config{USE_GNUTLS} eq "y") { + print "\nUsing GnuTLS SSL module.\n"; + } + } elsif ($config{HAS_OPENSSL} eq "y") { + yesno(USE_OPENSSL, "Would you like to enable SSL Support?"); + if ($config{USE_OPENSSL} eq "y") { + print "\nUsing OpenSSL SSL module.\nYou will get better performance if you move to GnuTLS in the future.\n"; + } + } + else { + print "\nCould not detect OpenSSL or GnuTLS. Make sure pkg-config is installed if\nyou intend to use OpenSSL, or that GnuTLS is in your path if you intend\nto use GnuTLS.\n\n"; + } + + print "\nThe following questions will ask you for various figures relating\n"; + print "To your IRCd install. Please note that these should usually be left\n"; + print "as defaults unless you have a real reason to change them. If they\n"; + print "changed, then the values must be identical on all servers on your\n"; + print "network, or malfunctions and/or crashes may occur, with the exception\n"; + print "of the 'maximum number of clients' setting which may be different on\n"; + print "different servers on the network.\n\n"; + + # File Descriptor Settings.. + promptnumeric("number of clients at any one time", "MAX_CLIENT_T"); + $config{MAX_CLIENT} = $config{MAX_CLIENT_T}; + $config{MAX_DESCRIPTORS} = $config{MAX_CLIENT_T}; + + promptnumeric("length of nicknames", "NICK_LENGT"); + promptnumeric("length of channel names", "CHAN_LENGT"); + promptnumeric("number of mode changes in one line", "MAXI_MODES"); + promptnumeric("length of an ident (username)", "MAX_IDENT"); + promptnumeric("length of a quit message", "MAX_QUIT"); + promptnumeric("length of a channel topic", "MAX_TOPIC"); + promptnumeric("length of a kick message", "MAX_KICK"); + promptnumeric("length of a GECOS (real name)", "MAX_GECOS"); + promptnumeric("length of an away message", "MAX_AWAY"); +} + +dumphash(); + +if (($config{USE_GNUTLS} eq "y") && ($config{HAS_GNUTLS} ne "y")) +{ + print "Sorry, but i couldn't detect gnutls. Make sure gnutls-config is in your path.\n"; + exit(0); +} +if (($config{USE_OPENSSL} eq "y") && ($config{HAS_OPENSSL} ne "y")) +{ + print "Sorry, but i couldn't detect openssl. Make sure openssl is in your path.\n"; + exit(0); +} + +if ($config{USE_GNUTLS} eq "y") { + $failed = 0; + open(TMP, ") { + chomp; + # Ignore Blank lines, and comments.. + next if /^\s*$/; + next if /^\s*#/; + my ($key, $value) = split("=", $_, 2); + $value =~ /^\"(.*)\"$/; + # Do something with data here! + $config{$key} = $1; + } + close(CONFIG); + return "true"; +} + +sub makecache { + # Dump the contents of %config + print "Writing \033[1;32mcache file\033[0m for future ./configures ...\n"; + open(FILEHANDLE, ">.config.cache"); + foreach $key (keys %config) { + print FILEHANDLE "$key=\"$config{$key}\"\n"; + } + close(FILEHANDLE); +} + +sub dir_check { + my ($desc, $hash_key) = @_; + my $complete = 0; + while (!$complete) { + print "In what directory $desc?\n"; + print "[\033[1;32m$config{$hash_key}\033[0m] -> "; + chomp($var = ); + if ($var eq "") { + $var = $config{$hash_key}; + } + if ($var =~ /^\~\/(.+)$/) { + # Convert it to a full path.. + $var = resolve_directory($ENV{HOME} . "/" . $1); + } + elsif ((($config{OSNAME} =~ /MINGW32/i) and ($var !~ /^[A-Z]{1}:\\.*/)) and (substr($var,0,1) ne "/")) + { + # Assume relative Path was given.. fill in the rest. + $var = $this . "/$var"; + } + + $var = resolve_directory($var); + if (! -e $var) { + print "$var does not exist. Create it?\n[\033[1;32my\033[0m] "; + chomp($tmp = ); + if (($tmp eq "") || ($tmp =~ /^y/i)) { + # Attempt to Create the Dir.. + + system("mkdir -p \"$var\" >> /dev/null 2>&1"); + $chk = system("mkdir -p \"$var\" >> /dev/null 2>&1") / 256; + if ($chk != 0) { + print "Unable to create directory. ($var)\n\n"; + # Restart Loop.. + next; + } + } else { + # They said they don't want to create, and we can't install there. + print "\n\n"; + next; + } + } else { + if (!is_dir($var)) { + # Target exists, but is not a directory. + print "File $var exists, but is not a directory.\n\n"; + next; + } + } + # Either Dir Exists, or was created fine. + $config{$hash_key} = $var; + $complete = 1; + print "\n"; + } +} + +sub getosflags { + + $config{LDLIBS} = "-lstdc++"; + $config{FLAGS} = "-fno-strict-aliasing -fPIC -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; + $config{DEVELOPER} = "-fno-strict-aliasing -fPIC -Wall -Woverloaded-virtual -Wno-deprecated -g"; + $SHARED = "-Wl,--rpath -Wl,$config{LIBRARY_DIR} -shared"; + $config{MAKEPROG} = "make"; + + if ($config{OSNAME} =~ /darwin/i) { + $config{FLAGS} = "-DDARWIN -frtti -fPIC -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; + $SHARED = "-bundle -twolevel_namespace -undefined dynamic_lookup"; + $config{LDLIBS} = "-ldl -lstdc++"; + } + + if ($config{OSNAME} =~ /OpenBSD/i) { + $config{MAKEPROG} = "gmake"; + chomp($foo = `eg++ -dumpversion | cut -c 1`); + # theyre running the package version of gcc (eg++)... detect it and set up its version numbers. + # if theyre not running this, configure lets the build continue but they probably wont manage to + # compile as this standard version is 2.95.3! + if ($foo ne "") { + $config{CC} = "eg++"; + chomp($config{GCCVER} = `eg++ -dumpversion | cut -c 1`); # we must redo these if we change the compiler path + } + return "OpenBSD"; + } + + if ($config{OSNAME} =~ /Linux/i) { + $config{LDLIBS} = "-ldl -lstdc++"; + $config{FLAGS} = "-fno-strict-aliasing -fPIC -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; + $config{FLAGS} .= " " . $ENV{CXXFLAGS} if exists($ENV{CXXFLAGS}); + $config{LDLIBS} .= " " . $ENV{LDLIBS} if exists($ENV{LDLIBS}); + $config{MAKEPROG} = "make"; + if ($config{OSNAME} =~ /CYGWIN/) { + $config{FLAGS} = "-fno-strict-aliasing -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; + $config{LDLIBS} = ""; + $config{MAKEPROG} = "/usr/bin/make"; + $config{MAKEORDER} = "ircd mods"; + return "Cygwin"; + } elsif ($config{OSNAME} eq "CYG-STATIC") { + $config{FLAGS} = "-fno-strict-aliasing -Wall -Woverloaded-virtual -Wno-deprecated $config{OPTIMISATI}"; + $config{LDLIBS} = ""; + $config{MAKEPROG} = "/usr/bin/make"; + $config{MAKEORDER} = "mods ircd"; + $config{STATICLIBS} = "modules/mods.a"; + $config{STATIC_LINK} = "yes"; + return "Cygwin-Static"; + } + } + + if ($config{OSNAME} =~ /FreeBSD/i) { + $config{FLAGS} .= " " . $ENV{CXXFLAGS} if exists($ENV{CXXFLAGS}); + $config{LDLIBS} .= " " . $ENV{LDLIBS} if exists($ENV{LDLIBS}); + } + + if ($config{OSNAME} =~ /SunOS/i or $config{OSNAME} =~ /solaris/i) + { + # solaris/sunos needs these + # socket = bsd sockets api + # nsl = dns stuff + # rt = POSIX realtime extensions + # resolv = inet_aton only (why isnt this in nsl?!) + $config{MAKEPROG} = "gmake"; + $config{LDLIBS} .= " -lsocket -lnsl -lrt -lresolv"; + return "Solaris"; + } + + if($config{OSNAME} =~ /MINGW32/i) + { + # All code is position-independent on windows + $config{FLAGS} =~ s/-fPIC //; + return "MinGW"; + } + + return $config{OSNAME}; +} + +sub writefiles { + my($writeheader) = @_; + # First File.. inspircd_config.h + chomp(my $incos = `uname -n -s -r`); + chomp($version = `sh src/version.sh`); + chomp(my $revision2 = getrevision()); + if ($writeheader == 1) + { + print "Writing \033[1;32minspircd_config.h\033[0m\n"; + open(FILEHANDLE, ">include/inspircd_config.h"); + my $NL = $config{NICK_LENGT}+1; + my $CL = $config{CHAN_LENGT}+1; + print FILEHANDLE <= 3) { + print FILEHANDLE "#define GCC3\n"; + } + if ($config{HAS_STRLCPY} eq "true") { + print FILEHANDLE "#define HAS_STRLCPY\n"; + } + if ($config{HAS_STDINT} eq "true") { + print FILEHANDLE "#define HAS_STDINT\n"; + } + if ($config{IPV6} =~ /y/i) { + print FILEHANDLE "#define IPV6\n"; + } + if ($config{SUPPORT_IP6LINKS} =~ /y/i) { + print FILEHANDLE "#define SUPPORT_IP6LINKS\n"; + } + my $use_hiperf = 0; + if (($has_kqueue) && ($config{USE_KQUEUE} eq "y")) { + print FILEHANDLE "#define USE_KQUEUE\n"; + $se = "socketengine_kqueue"; + $use_hiperf = 1; + } + if (($has_epoll) && ($config{USE_EPOLL} eq "y")) { + print FILEHANDLE "#define USE_EPOLL\n"; + $se = "socketengine_epoll"; + $use_hiperf = 1; + } + if (($has_ports) && ($config{USE_PORTS} eq "y")) { + print FILEHANDLE "#define USE_PORTS\n"; + $se = "socketengine_ports"; + $use_hiperf = 1; + } + # user didn't choose either epoll or select for their OS. + # default them to USE_SELECT (ewwy puke puke) + if (!$use_hiperf) { + print FILEHANDLE "#define USE_SELECT\n"; + $se = "socketengine_select"; + } + print FILEHANDLE "\n#endif\n"; + close(FILEHANDLE); + } + + if ($writeheader) + { + open(FILEHANDLE, ">include/inspircd_se_config.h"); + print FILEHANDLE <) { + $tmp .= $_; + } + close(FILEHANDLE); + + $tmp =~ s/\@CC\@/$config{CC}/; + $tmp =~ s/\@MAKEPROG\@/$config{MAKEPROG}/; + $tmp =~ s/\@FLAGS\@/$config{FLAGS}/; + $tmp =~ s/\@DEVELOPER\@/$config{DEVELOPER}/; + $tmp =~ s/\@LDLIBS\@/$config{LDLIBS}/; + $tmp =~ s/\@BASE_DIR\@/$config{BASE_DIR}/; + $tmp =~ s/\@CONFIG_DIR\@/$config{CONFIG_DIR}/; + $tmp =~ s/\@MODULE_DIR\@/$config{MODULE_DIR}/; + $tmp =~ s/\@BINARY_DIR\@/$config{BINARY_DIR}/; + $tmp =~ s/\@LIBRARY_DIR\@/$config{LIBRARY_DIR}/; + $tmp =~ s/\@LIBRARY_EXT\@/$LIBEXT/; + $tmp =~ s/\@MODULES\@/$modules/; + $tmp =~ s/\@STARTSCRIPT\@/$config{STARTSCRIPT}/; + $tmp =~ s/\@DESTINATION\@/$config{DESTINATION}/; + $tmp =~ s/\@EXTRA_DIR\@/$config{EXTRA_DIR}/; + $tmp =~ s/\@EXECUTABLE\@/$exe/; + $tmp =~ s/\@MAKEORDER\@/$config{MAKEORDER}/; + $tmp =~ s/\@STATICLIBS\@/$config{STATICLIBS}/; + $tmp =~ s/\@VERSION\@/$version/; + + print "Writing \033[1;32m$file\033[0m\n"; + open(FILEHANDLE, ">$file"); + print FILEHANDLE $tmp; + } + } + closedir(DIRHANDLE); + + # Make inspircd executable! + chmod 0744, 'inspircd'; + + if ($config{STATIC_LINK} eq "yes") { + print "Writing static-build \033[1;32msrc/Makefile\033[0m\n"; + write_static_makefile(); + write_static_modules_makefile(); + } elsif ($config{OSNAME} =~ /CYGWIN/i) { + print "Writing cygwin-build \033[1;32msrc/Makefile\033[0m\n"; + write_static_makefile(); + write_dynamic_modules_makefile(); + } else { + print "Writing dynamic-build \033[1;32msrc/Makefile\033[0m\n"; + write_dynamic_makefile(); + write_dynamic_modules_makefile(); + } +} + +sub write_static_modules_makefile { + # Modules Makefile.. + print "Writing \033[1;32msrc/modules/Makefile\033[0m\n"; + open(FILEHANDLE, ">src/modules/Makefile"); + + ### + # Module Makefile Header + ### + print FILEHANDLE < +# Many Thanks to Andrew Church +# for assisting with making this work right. +# +# Automatically Generated by ./configure to add a modules +# please run ./configure --update + +all: \$(MODULES) + +EOF + ### + # End Module Makefile Header + ### + + # Create a Modules List.. + my $modules = ""; + my $cmflags = ""; + my $liflags = ""; + + open(MODLIST,">include/modlist.h"); + + ### + # Include File Header + ### + print MODLIST <src/modules/.m_".$i."_static.cpp") or die("Could not create .m_".$i."_static.cpp"); + while (chomp($a = )) { + $a =~ s/init_module/$i\_init/g; + print MUNGED "$a\n"; + } + close(MODULE); + close(MUNGED); + print MODLIST <src/modules/Makefile"); + my $extra = ""; + + if ($config{OSNAME} =~ /CYGWIN/i) { + $extra = "../inspircd.dll.a"; + } + +### +# Module Makefile Header +### + print FILEHANDLE < +# Many Thanks to Andrew Church +# for assisting with making this work right. +# +# Automatically Generated by ./configure to add a modules +# please run ./configure -update or ./configure -modupdate + +all: \$(MODULES) + +EOF + ### + # End Module Makefile Header + ### + + # Create a Modules List.. + my $modules = ""; + my $cmflags = ""; + my $liflags = ""; + my $crud = ""; + + foreach $i (@modlist) { + ### + # Write Entry to the MakeFile + ### + $cmflags = getcompilerflags("src/modules/m_".$i.".cpp"); + $liflags = getlinkerflags("src/modules/m_".$i.".cpp"); + $deps = getdependencies("src/modules/m_".$i.".cpp"); + + #print "file: $i: cmflags=$cmflags; liflags=$liflags; deps=$deps\n"; + + print FILEHANDLE <src/Makefile") or die("Could not write src/Makefile!"); + my $i = 0; + my @cmdlist = (); + opendir(DIRHANDLE, "src"); + foreach $name (sort readdir(DIRHANDLE)) { + if ($name =~ /^cmd_(.+)\.cpp$/) { + $cmdlist[$i++] = $1; + } + } + closedir(DIRHANDLE); + my $cmdobjs = ""; + my $srcobjs = ""; + foreach my $cmd (@cmdlist) { + $cmdobjs = $cmdobjs . "cmd_$cmd.o "; + $srcobjs = $srcobjs . "cmd_$cmd.cpp "; + } + print FH < +# Makefile version 2 (statically linked core) by +# + +CC = im a cheezeball + +CXXFLAGS = -I../include \${FLAGS} +CPPFILES = \$(shell /bin/ls -l modes/ | grep '\\.cpp' | sed 's/^.* //' | grep -v svn) +RELCPPFILES = \$(shell /bin/ls -l modes/ | grep '\\.cpp' | sed 's/^.* /modes\\//' | grep -v svn) + +EOM + +$se = "socketengine_select"; +if (($has_kqueue) && ($config{USE_KQUEUE} eq "y")) { + $se = "socketengine_kqueue"; +} +elsif (($has_epoll) && ($config{USE_EPOLL} eq "y")) { + $se = "socketengine_epoll"; +} +elsif (($has_ports) && ($config{USE_PORTS} eq "y")) { + $se = "socketengine_ports"; +} + + ### + # This next section is for cygwin dynamic module builds. + # Basically, what we do, is build the inspircd core as a library + # then the main executable uses that. the library is capable of + # loading / unloading the modules dynamically :) + # Massive thanks to the guys on #cygwin @ irc.freenode.net for helping + # make this work :) + ### + + if ($config{OSNAME} =~ /CYGWIN/i) { + print FH <src/Makefile") or die("Could not write src/Makefile"); + print FH < +# Makefile version 2 (dynamically linked core) by +# + +CC = im a cheezeball + +CXXFLAGS = -I../include \${FLAGS} +CPPFILES = \$(shell /bin/ls -l modes/ | grep '\\.cpp' | sed 's/^.* //' | grep -v svn) +RELCPPFILES = \$(shell /bin/ls -l modes/ | grep '\\.cpp' | sed 's/^.* /modes\\//' | grep -v svn) + +EOM + +if ($config{IS_DARWIN} eq "YES") { + print FH < Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19yy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. \ No newline at end of file +NOTE: InspIRCd is licensed under GPL version 2 only. + "upgrading" to a later version of the GENERAL PUBLIC + LICENSE is not permitted. For further information on + this, please contact us at irc.inspircd.org on #inspircd. + +---------------------------------------------------------------------- + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 675 Mass Ave, Cambridge, MA 02139, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 19yy + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19yy name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/docs/README b/docs/README index 25423247a..fdc6ac3b2 100644 --- a/docs/README +++ b/docs/README @@ -1 +1,10 @@ -Because of the dynamic nature of InspIRCd, we do not have traditional documentation in our tarball. The documentation for InspIRCd can be found on our wiki, at http://www.inspircd.org/wiki Our bugtracker can be found at http://www.inspircd.org/bugtrack Our forums can be found at http://www.inspircd.org/forum Our development blog can be found at http://www.inspircd.com For online support, please connect to irc.inspircd.org, and join #inspircd. -- The InspIRCd Team \ No newline at end of file +Because of the dynamic nature of InspIRCd, we do not have traditional documentation in our tarball. + +The documentation for InspIRCd can be found on our wiki, at http://www.inspircd.org/wiki +Our bugtracker can be found at http://www.inspircd.org/bugtrack +Our forums can be found at http://www.inspircd.org/forum +Our development blog can be found at http://www.inspircd.com + +For online support, please connect to irc.inspircd.org, and join #inspircd. + + -- The InspIRCd Team diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example index 973f22301..1fef8f707 100644 --- a/docs/inspircd.conf.example +++ b/docs/inspircd.conf.example @@ -1 +1,2195 @@ -######################################################################## # # # ___ ___ ____ ____ _ # # |_ _|_ __ ___ _ __|_ _| _ \ / ___|__| | # # | || '_ \/ __| '_ \| || |_) | | / _` | # # | || | | \__ \ |_) | || _ <| |__| (_| | # # |___|_| |_|___/ .__/___|_| \_\\____\__,_| # # |_| # # ____ __ _ _ _ # # / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ # # | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ # # | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | # # \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| # # |___/ # # # ##################################||#################################### #||# ##################################||#################################### # # # This is an example of the config file for InspIRCd. # # Change the options to suit your network # # # # $Id$ # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT # # lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even # # if you've configured InspIRCd before, these probably indicate # # something new or different to this version and you SHOULD READ IT. # # # ######################################################################## # # # Unalphabeticalise the modules list at your own risk # # # ######################################################################## #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#- # # # Here is where you enter the information about your server. # # # # Syntax is as follows: # # # # # # # #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-# # # # Describes the Server Administrator's real name (optionally), # # nick, and email address. # # # # Syntax is as follows: # # # # # #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- # # # Enter the port and address bindings here. # # # # bind address - specifies which address ports bind to. Leaving this # # field blank binds the port to all IPs available. # # # # port - The port number to bind to. You may specify a port # # range here, e.g. "6667-6669,7000,7001". If you do # # this, the server will count each port within your # # range as a seperate binding, making the above # # example equivalent to five seperate bind tags. # # A failure on one port in the range does not prevent # # the entire range from being bound, just that one # # port number. # # # # type - can be 'clients' or 'servers'. The clients type is # # a standard tcp based socket, the servers type is a # # also a TCP based connection but of a different # # format. SSL support is provided by modules, to # # enable SSL support, please read the module section # # of this configuration file. # # # # ssl - When using m_ssl_gnutls.so or m_ssl_openssl.so # # modules, you must define this value to use ssl on # # that port. valid values are 'gnutls' or 'openssl' # # respectively. If the module is not loaded, this # # setting is ignored. # # # # transport - If you have m_spanningtree.so loaded, along with # # either of the SSL modules (m_ssl_gnutls or # # m_ssl_openssl) or m_ziplinks.so, then you may make # # use of this value. # # setting it to 'openssl' or 'gnutls' or 'zip' # # indicates that the port should accept connections # # using the given transport name. Transports are # # layers which sit on top of a socket and change the # # way data is sent and received, e.g. encryption, # # compression, and other such things. Because this # # may not be limited in use to just encryption, # # the 'ssl' value used for client ports does not # # exist for servers, and this value is used instead. # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # If you want to link servers to InspIRCd you must load the # # m_spanningtree module! Please see the modules list below for # # information on how to load this module! If you do not load this # # module, server ports will NOT be bound! # # # # Leaving address empty binds to all available interfaces # # # # Syntax is as follows: # # # # # # # # # # If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, # # then you can specify IPV4 ip addresses here to bind. You may also # # use the 4in6 notation, ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 # # address to bind the port, but as of InspIRCd 1.1.1, this is not # # required. # # # # ------------------------------------------------------------------- # # # # PLEASE NOTE: If you have build InspIRCd as an ipv6 server, and you # # specify an empty bind address, the binding will be bound to ALL THE # # IPV6 IP ADDRESSES, and not the ipv4 addresses. If you are using an # # ipv6 enabled InspIRCd and want to bind to multiple IPV4 addresses # # in this way, you must specify them by hand. If you have built the # # server for ipv4 connections only, then specifying an empty bind # # address binds the port to all ipv4 IP addresses, as expected. # # # # When linking servers, the openssl and gnutls transports are largely # link-compatible and can be used alongside each other or either/or # on each end of the link without any significant issues. #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#- # # # You can configure the passwords here which you wish to use for # # the die and restart commands. Only trusted ircops who will # # need this ability should know the die and restart password. # # # # Syntax is as follows: # # # # # #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-# # # # This optional tag allows you to include another config file # # allowing you to keep your configuration tidy. The configuration # # 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 of the main # # config file inspircd.conf, unless the filename starts with a forward# # slash (/) in which case it is treated as an absolute path. # # # # Syntax is as follows: # # # # # #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # This is where you can configure which connections are allowed # # and denied access onto your server. The password is optional. # # You may have as many of these as you require. To allow/deny all # # connections, use a '*' or 0.0.0.0/0. # # # # Syntax is as follows: # # # # # # # # # # # # IP masks may be specified in CIDR format or wildcard format, # # for IPV4 and IPV6. You *cannot* use hostnames in the allow or # # deny field, as the state is applied before the user's DNS has # # been resolved. # # # # You may optionally include timeout="x" on any allow line, which # # specifies the amount of time given before an unknown connection # # is closed if USER/NICK/PASS are not given. This value is in secs # # # # You should also include a flood="x" line which indicates # # the number of lines a user may place into their buffer at once # # before they are disconnected for excess flood. This feature can # # not be disabled, however it can be set to extremely high values, # # rendering it effectively disabled. A recommended value is 10. # # A counter is maintained for each user which is reset every # # 'threshold' seconds and specifying this threshold value with # # threshold="X" indicates how often the counter is reset. For # # example, with flood="5" and threshold="8", the user may not send # # more than 5 lines in 8 secs. # # # # You may optionally specify the sendq size and ping frequency of # # each connect:allow line using the pingfreq="X" and sendq="X" # # settings as shown in the full example below. # # The ping frequency is specified in seconds, and the sendq size # # in bytes. It is recommended, although not enforced, that you # # should never set your sendq size to less than 8k. Send Queues are # # dynamically allocated and can grow as needed up to the maximum # # size specified. # # # # The optional recvq value is the maximum size which users in this # # group may grow their receive queue to. This is recommended to be # # kept pretty low compared to the sendq, as users will always # # receive more than they send in normal circumstances. The default # # if not specified is 4096. # # # # The sendq is the data waiting to be sent TO THE USER. # # The recvq is the data being received FROM THE USER. # # The names sendq and recvq are from the SERVER'S PERSPECTIVE not # # that of the user... Just to clear up any confusion or complaints # # that these are backwards :p # # # # The localmax and globalmax values can be used to enforce local # # and global session limits on connections. The session limits are # # counted against all users, but applied only to users within the # # class. For example, if you had a class 'A' which has a session # # limit of 3, and a class 'B' which has a session limit of 5, and # # somehow, two users managed to get into class B which also match # # class A, there is only one connection left for this IP now in A, # # but if they can connect again to B, there are three. You get the # # idea (i hope). # # # # The optional port value determines which port the connect tag is # # handling. If left out the connect tag covers all bound ports else # # only incoming connections on the specified port will match. Port # # tags may be used on connect allow and connect deny tags. # # # #-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- # # # Classes are a group of commands which are grouped together # # and given a unique name. They used to define which commands # # are available to certain types of Operators. # # # # Syntax is as follows: # # # # # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # You are not forced to give these classes the names given below. # # You can create your own named classes, if you want, in fact that # # is the whole idea of this system! # # # # Note: It is possible to make a class which covers all available # # commands. To do this, specify commands="*". This is not really # # recommended, as it negates the whole purpose of the class system, # # however it is provided for fast configuration (e.g. in test nets) # # # #-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-# # # # This is where you specify which types of operators you have on # # your server, as well as the commands they are allowed to use. # # This works alongside with the classes specified above. # # # # type name - a name for the combined class types # # a type name cannot contain spaces, however if you # # put an _ symbol in the name, it will be translated # # to a space when displayed in a WHOIS. # # # # classes - specified above, used for flexibility for the # # server admin to decide on which operators get # # what commands. Class names are case sensitive, # # seperate multiple class names with spaces. # # # # host - optional hostmask operators will receive on oper-up. # # # # Syntax is as follows: # # # # # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # You are not forced to give these types the names given below. # # You can create your own named types, if you want, in fact that # # is the whole idea of this system! # # # #-#-#-#-#-#-#-#-#-#-#- OPERATOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # Opers are defined here. This is a very important section. # # Remember to only make operators out of truthworthy people. # # # # name - oper name, This is case sensitive, so it is best to # # use lower-case. # # # # password - password to oper-up, also case sensitive. # # encryption is supported via modules. You may load # # modules for MD5 or SHA256 encryption, and if you do, # # this value will be a hash value, otherwise put a # # plaintext password in this value. # # # # host - hosts of client allowed to oper-up. # # wildcards accepted, seperate multiple hosts with a # # space. You may also specify CIDR ip addresses. # # # # fingerprint - When using the m_ssl_oper_cert.so module, you may # # specify a key fingerprint here. This can be obtained # # using the /fingerprint command whilst the module is # # loaded, or from the notice given to you when you # # connect to the ircd using a client certificate, # # and will lock this oper block to only the user who # # has that specific key/certificate pair. # # This enhances security a great deal, however it # # requires that opers use clients which can send ssl # # client certificates, if this is configured for that # # oper. Note that if the m_ssl_oper.so module is not # # loaded, and/or one of m_ssl_openssl or m_ssl_gnutls # # is not loaded, this configuration option has no # # effect and will be ignored. # # # # type - Defines the kind of operator. This must match a type # # tag you defined above, and is case sensitive. # # # # Syntax is as follows: # # # # # #-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # # Defines which servers can link to this one, and which servers this # # server may create outbound links to. # # # # name - The name is the canocial name of the server, does # # not have to resolve - but it is expected to be set # # in the remote servers connection info. # # # # ipaddr - Valid host or ip address for remote server. These # # hosts are resolved on rehash, and cached, if you # # specify a hostname, so if you find that your server # # is still trying to connect to an old IP after you # # have updated your dns, try rehashing and then # # attempting the connect again. # # # # port - The TCP port for the remote server. # # # # sendpass - Password to send to create an outbound connection # # to this server. # # # # recvpass - Password to receive to accept an inbound connection # # from this server. # # # # autoconnect - Sets the server to autoconnect. Where x is the num. # # (optional) of seconds between attempts. e.g. 300 = 5 minutes. # # # # transport - If defined, this is a transport name implemented by # # another module. Transports are layers on top of # # plaintext connections, which alter them in certain # # ways. Currently the three supported transports are # # 'openssl' and 'gnutls' which are types of SSL # # encryption, and 'zip' which is for compression. # # If you define a transport, both ends of the # # connection must use a compatible transport for the # # link to succeed. OpenSSL and GnuTLS are link- # # compatible with each other. # # # # statshidden - When using m_spanningtree.so for linking. you may # # set this to 'yes', and if you do, the IP address/ # # hostname of this connection will NEVER be shown to # # any opers on the network. In /STATS c its address # # will show as *@, and during CONNECT and # # inbound connections, its IP will show as # # UNLESS the connection fails (e.g. due to a bad # # password or servername) # # # # allowmask - When this is defined, it indicates a range of IP # # addresses to allow for this link (You may use CIDR # # or wildcard form for this address). # # e.g. if your server is going to connect to you from # # the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 # # into this value. If it is not defined, then only # # the ipaddr field of the server shall be allowed. # # # # failover - If you define this option, it must be the name of a # # different link tag in your configuration. This # # option causes the ircd to attempt a connection to # # the failover link in the event that the connection # # to this server fails. For example, you could define # # two hub uplinks to a leaf server, and set an # # american server to autoconnect, with a european # # hub as its failover. In this situation, your ircd # # will only try the link to the european hub if the # # american hub is unreachable. NOTE that for the # # intents and purposes of this option, an unreachable # # server is one which DOES NOT ANSWER THE CONNECTION. # # If the server answers the connection with accept(), # # EVEN IF THE CREDENTIALS ARE INVALID, the failover # # link will not be tried! Failover settings will also # # apply to autoconnected servers as well as manually # # connected ones. # # # # timeout - If this is defined, then outbound connections will # # time out if they are not connected within this many # # seconds. If this is not defined, the default of ten # # seconds is used. # # # # bind - If you specify this value, then when creating an # # outbound connection to the given server, the IP you # # place here will be bound to. This is for multi- # # homed servers which may have multiple IP addresses. # # If you do not define this value, the first IP that # # is not empty or localhost from your tags # # will be bound to. This is usually acceptable, # # however if your server has multiple network cards # # then you may have to manually specify the bind # # value instead of leaving it to automatic binding. # # You can usually tell if you need to set this by # # looking for the error 'Could not assign requested # # address' in your log when connecting to servers. # # # # hidden - If this is set to true, yes, or 1, then the server # # is completely hidden from non-opers. It does not # # show in LINKS and it does not show in MAP. Also, # # any servers which are child servers of this one # # in the network will *also* be hidden. Use with # # care! You can use this to 'mask off' sections of # # the network so that users only see a small portion # # of a much larger net. It should NOT be relied upon # # as a security tool, unless it is being used for # # example to hide a non-client hub, for which clients # # do not have an IP address or resolvable hostname. # # # # to u:line a server (give it extra privilages required for running # # services, Q, etc) you must include the tag as shown # # in the example below. You can have as many of these as you like. # # # # WARNING: Unlike other ircds, u:lining a server allows ALL users on # # that server to operoverride modes. This should only be used for # # services and protected oper servers! # # # # ------------------------------------------------------------------- # # # # NOTE: If you have built your server as an ipv6 server, then when a # # DNS lookup of a server's host occurs, AAAA records (ipv6) are # # priorotized over A records (ipv4). Therefore, if the server you are # # connecting to has both an IPV6 ip address and an IPV4 ip address in # # its DNS entry, the IPV6 address will *always* be selected. To # # change this behaviour simply specify the IPV4 IP address rather # # than the hostname of the server. # # # # ------------------------------------------------------------------- # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # If you want to link servers to InspIRCd you must load the # # m_spanningtree module! Please see the modules list below for # # information on how to load this module! If you do not load this # # module, server links will NOT work! # # # # Also, if you define any transports, you must load the modules for # # these transports BEFORE you load m_spanningtree, e.g. place them # # above it in the configuration file. Currently this means the three # # modules m_ssl_gnutls, m_ziplinks and m_ssl_openssl, depending on # # which you choose to use. # # # #-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# # This tag defines a ulined server. A U-Lined server has special # # permissions, and should be used with caution. Services servers are # # usually u-lined in this manner. # # # # The 'silent' value if set to yes indicates that this server should # # not generate quit and connect notices, which can cut down on noise # # to opers on the network. # # # #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # # These options let you define the path to your motd and rules # # files. If these are relative paths, they are relative to the # # configurtion directory. # # # #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # This optional configuration tag lets you define the maximum number # # of channels that both opers and users may be on at any one time. # # the default is 20 for user and 60 for opers if this tag is not # # defined. Remote users are not restricted in any manner. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # Define your DNS server address here. InspIRCd has its own resolver. # # If you do not define this value, then then InspIRCd will attempt to # # determine your DNS server from your operating system. On POSIX # # platforms, InspIRCd will read /etc/resolv.conf, and populate this # # value with the first DNS server address found. On Windows platforms # # InspIRCd will check the registry, and use the DNS server of the # # first active network interface, if one exists. # # If a DNS server cannot be determined from these checks, the default # # value '127.0.0.1' is used instead. The timeout value is in seconds. # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # When choosing a server, be sure to choose one which will do a # # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these # # recursive lookups itself, to save time and resources. The dns # # server recommended by the InspIRCd team is bind, available from the # # ISC website. If your DNS server does not do a recursive lookup, you # # will be able to notice this by the fact that none of your users are # # resolving even though the DNS server appears to be up! Most ISP and # # hosting provider DNS servers support recursive lookups. # # # # ------------------------------------------------------------------- # # # # NOTE: if you have built InspIRCd with IPV6 support, then both # # ipv6 and ipv4 addresses are allowed here, and also in the system # # resolv.conf file. Remember that an ipv4 dns server can still # # resolve ipv6 addresses, and vice versa. # # # # An example of using an IPV6 nameserver # #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # Define the path to the PID file here. The PID file can be used to # # 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. # # # # #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # Use these tags to customise the ban limits on a per channel basis. # # the tags are read from top to bottom, and any tag found which # # matches the channels name applies the banlimit to that channel. # # It is advisable to put an entry with the channel as '*' at the # # bottom of the list. If none are specified or no maxbans tag is # # matched, the banlist size defaults to 64 entries. # # # #-#-#-#-#-#-#-#-#-#-#- DISABLED COMMANDS -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # This tag is optional, and specifies one or more commands which are # # not available to non-operators. For example you may wish to disable # # NICK and prevent non-opers from changing their nicknames. # # Note that any disabled commands take effect only after the user has # # 'registered' (e.g. after the initial USER/NICK/PASS on connection) # # so for example disabling NICK will not cripple your network. # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # Just remove this... Its here to make you read ALL of the config # # file options ;) # #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# # # # Settings to define which features are useable on your server. # # # # prefixquit - A prefix to be placed on the start of a client's # # quit message # # # # suffixquit - A suffix to be placed on the end of a client's # # quit message. # # # # fixedquit - A fixed quit message to display for all client # # QUITS. If specified, overrides both prefixquit # # and suffixquit options. # # # # loglevel - specifies what detail of messages to log in the # # log file. You may select from debug, verbose, # # default, sparse and none. # # # # allowhalfop - allows the +h channel mode # # # # noservices - If noservices is true, yes, or 1, then the first # # user into a channel gets founder status. This is # # only useful on networks running the m_chanprotect # # module without services. # # # # qaprefixes - If qaprefixes is true, yes, or 1, then users # # with +q or +a will get the ~ or & prefixes # # used in unreal. This is only useful on networks # # running the m_chanprotect module # # # # deprotectself - If this value is set to yes, true, or 1, then any # # user with +q or +a may remove the +q or +a from # # themselves. The default setting is to not enable # # this feature, which stops even the founder taking # # away their founder status without using services. # # # # deprotectothers-If this value is set to yes, true, or 1, then any # # user with +q or +a may remove the +q or +a from # # other users. The default setting is to not enable # # this feature, so that only +q may remove +a, and # # nothing but services may remove +q. # # # # cyclehosts - If this is set to true, yes or 1, then when a # # user's hostname changes, they will appear to quit # # and then rejoin with their new host. This prevents # # clients from being confused by host changes, # # especially in the case of bots, and it is # # recommended that this option is enabled. # # # # netbuffersize - size of the buffer used to receive data from # # clients. The ircd may only read() this amount # # of text in one go at any time. (OPTIONAL) # # # # maxwho - The maximum number of results returned by a /WHO # # query. This is to prevent /WHO being used as a # # spam vector or means of flooding an ircd. The # # default is 128, it is not recommended to raise it # # above 1024. Values up to 65535 are permitted. If # # this value is omitted, any size WHO is allowed by # # anyone. # # # # somaxconn - The maximum number of sockets that may be waiting # # in the accept queue. This usually allows the ircd # # to soak up more connections in a shorter space of # # time when increased but please be aware there is a # # system defined maximum value to this, the same way # # there is a system defined maximum number of file # # descriptors. Some systems may only allow this to # # be up to 5 (ugh) while others such as FreeBSD will # # default to a much nicer 128. # # # # moduledir - This optional value indicates a runtime change of # # the location where modules are to be found. This # # does not add a supplementary directory. There can # # only be one module path. # # # # softlimit - This optional feature allows a defined softlimit. # # if defined sets a soft maxconnections value, has # # to be less than the ./configure maxclients # # # # userstats - The userstats field is optional and specifies # # which stats characters in /STATS may be requested # # by non-operators. Stats characters in this field # # are case sensitive and are allowed to users # # independent of if they are in a module or the core # # # # operspywhois - If this is set then when an IRC operator uses # # /WHOIS on a user they will see all channels, even # # ones if channels are secret (+s), private (+p) or # # if the target user is invisible +i. # # # # customversion - If you specify this configuration item, and it is # # not set to an empty value, then when a user does # # a /VERSION command on the ircd, this string will # # be displayed as the second portion of the output, # # replacing the system 'uname', compile flags and # # socket engine/dns engine names. You may use this # # to enhance security, or simply for vanity. # # # # maxtargets - The maxtargets field is optional, and if not # # defined, defaults to 20. It indicates the maximum # # number of targets which may be given to commands # # such as PRIVMSG, KICK etc. # # # # hidesplits - When set to 'yes', will hide split server names # # from non-opers. Non-opers will see '*.net *.split' # # instead of the server names in the quit message, # # identical to the way IRCu displays them. # # # # hidebans - When set to 'yes', will hide gline, kline, zline # # and qline quit messages from non-opers. For # # example, user A who is not an oper will just see # # (G-Lined) while user B who is an oper will see the # # text (G-Lined: Reason here) instead. # # # # hidewhois - When defined with a non-empty value, the given # # text will be used in place of the user's server # # in WHOIS, when a user is WHOISed by a non-oper. # # For example, most nets will want to set this to # # something like '*.netname.net' to conceal the # # actual server the user is on. # # # # flatlinks - When you are using m_spanningtree.so, and this # # value is set to true, yes or 1, /MAP and /LINKS # # will be flattened when shown to a non-oper. # # # # hideulines - When you are using m_spanningtree.so, and this # # value is set to true, yes or 1, then U-lined # # servers will be hidden in /LINKS and /MAP. For non # # opers. Please be aware that this will also hide # # any leaf servers of a U-lined server, e.g. jupes. # # # # nouserdns - If set to 'yes', 'true' or '1', no user dns # # lookups will be performed for connecting users. # # this can save a lot of resources on very busy irc # # servers. # # # # syntaxhints - If set to 'yes', 'true' or '1', when a user does # # not give enough parameters for a command, a syntax # # hint will be given (using the RPL_TEXT numeric) # # as well as the standard ERR_NEEDMOREPARAMS. # # # # announcets - If this value is defined to 'yes', 'true' or '1', # # then if a channel's timestamp is updated the users # # on the channel will be informed of the change via # # a server notice to the channel with the old and # # new TS values in the timestamp. If you think this # # is just pointless noise, define the value to 0. # # # # ircumsgprefix - Use undernet style message prefix for channel # # NOTICE and PRIVMSG adding the prefix to the line # # of text sent out. Eg. NOTICE @#test :@ testing # # vs. the off setting: NOTICE @#test :testing # # # # hostintopic - If this is set to yes (the default) then the full # # nick!user@host is shown for who set a TOPIC last. # # if set to no, then only the nickname is shown. # # # # announceinvites # # - If this option is set to yes (the default), then # # invites are announced to the channel when a user # # invites annother user. If you consider this to be # # unnecessary noise, explicitly set this to no. # # # # disablehmac - If you are linking your InspIRCd to older versions # # then you can specify this option and set it to # # yes. 1.1.6 and above support HMAC and challenge- # # response for password authentication. These can # # greatly enhance security of your server to server # # connections when you are not using SSL (as is the # # case with a lot of larger networks). Linking to # # older versions of InspIRCd should not *usually* be # # a problem, but if you have problems with HMAC # # authentication, this option can be used to turn it # # off. # # # # hidemodes - If this option is enabled, then the listmodes # # given (e.g. +eI), will be hidden from users below # # halfop. This is not recommended to be set on mode # # +b, as it may break some features in popular # # clients such as mIRC. # # # # quietbursts - When synching or splitting from the network, a # # server can generate a lot of connect and quit # # snotices to the +C and +Q snomasks. Setting this # # value to yes squelches those messages, which can # # make them more useful for opers, however it will # # degrade their use by certain third party programs # # such as BOPM which rely on them to scan users when # # a split heals in certain configurations. # # # # pingwarning - This should be set to a number between 1 and 59 if # # defined, and if it is defined will cause the server# # to send out a warning via snomask +l if a server # # does not answer to PING after this many seconds. # # This can be useful for finding servers which are # # at risk of pinging out due to network issues. # # # # exemptchanops - This option allows channel operators to be exempted# # from certain channel modes. # # Supported modes are +SfgNc. Defaults to off. # # # # defaultmodes - The default modes to be given to each channel on # # creation. Defaults to 'nt'. There should be no + # # or - symbols in this sequence, if you add them # # they will be ignored. You may add parameters for # # parameterised modes. # # # # moronbanner - The NOTICE to show to users who are glined, zlined # # klined or qlined when they are disconnected. This # # is totally freeform, you may place any text here # # you wish. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-# # Time sychronization options for m_spanningtree linking. # # # # Because IRC is very time and clock dependent, InspIRCd provides its # # own methods for syncronization of time between servers as shown # # in the example below, for servers that don't have ntpd running. # # # # enable - If this value is 'yes', 'true', or '1', time # # synchronization is enabled on this server. This # # means any servers you are linked to will # # automatically synchronize time, however you should # # use ntpd instead where possible, NOT this option. # # # # master - If this value is set to yes, then this server will # # act as the authoritative time source for the whole # # network. All other servers will respect its time # # without question, and match their times to it. # # only one server should have the master value set # # to 'yes'. # # # #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# # # # This tag lets you define the behaviour of the /whowas command of # # your server. # # # # groupsize - Controls the maximum entries per nick shown when # # performing a /whowas nick. Setting this to 0 dis- # # ables whowas completely. # # # # maxgroups - The maximum number of nickgroups that can be added # # to the list. If max is reached, oldest group will # # be deleted first like a FIFO. A groupsize of 3 and # # a maxgroups of 5000 will allow for 5000 nicks to # # be stored with a history of 3, thus giving a total # # of 3 * 5000 = 15000 entries. A setting of 0 dis- # # ables whowas completely. # # # # maxkeep - The maximum time a nick is kept in the whowas list # # before being pruned. Time may be specified in # # seconds, or in the following format: 1y2w3d4h5m6s # # meaning one year, two weeks, three days, 4 hours, # # 5 minutes and 6 seconds. All fields in this format # # are optional. Minimum is 1 hour, if less InspIRCd # # will default back to 1 hour. # # # # # #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# # # # These tags define which modules will be loaded on startup by your # # server. Add modules without any paths. When you make your ircd # # using the 'make' command, all compiled modules will be moved into # # the folder you specified when you ran ./configure. The module tag # # automatically looks for modules in this location. # # If you attempt to load a module outside of this location, either # # in the config, or via /LOADMODULE, you will receive an error. # # # # By default, ALL modules are commented out. You must uncomment them # # or add lines to your config to load modules. Please refer to # # http://www.inspircd.org/wiki/Modules_List for a list of modules and# # each modules link for any additional conf tags they require. # # # # You may use wildcards in a tag to load all modules which # # match a glob pattern (e.g. m_sa????.so would load m_sajoin, # # m_sapart, m_saquit and m_sanick) # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # # # # To link servers to InspIRCd, you MUST load the m_spanningtree # # module, as shown below. If you DO NOT do this, server links will # # NOT work at all. ie. The ports will NOT bind, and /connect will not # # work properly. This is by design, to allow for the implementation # # of other linking protocols in modules in the future. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Spanning Tree module - allows linking of servers using the spanning # tree protocol (see the READ THIS BIT section above). # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # MD5 Module - Allows other modules to generate MD5 hashes, usually for # cryptographic uses and security. # # IMPORTANT: # Other modules such as m_cloaking.so and m_opermd5.so may rely on # this module being loaded to function. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SHA256 Module - Allows other modules to generate SHA256 hashes, # usually for cryptographic uses and security. # # IMPORTANT: # Other modules such as m_opermd5.so may rely on this module being # loaded to function. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Alias module: Allows you to define server-side command aliases # # #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # If you have the m_alias.so module loaded, you may also define # # aliases as shown below. They are commonly used to provide shortcut # # commands to services, however they are not limited to just this use.# # An alias tag requires the following values to be defined in it: # # # # text - The text to detect as the actual command line, # # Cant contain spaces, but case insensitive. # # You may have multiple aliases with the same # # command name (text="" value), however the first # # found will be executed if its format value is # # matched, or it has no format value. Aliases are # # read from the top of the file to the bottom. # # # # format - If this is defined, the parameters of the alias # # must match this glob pattern. For example if you # # want the first parameter to start with a # for # # the alias to be executed, set format="#*" in the # # alias definition. Note that the :'s which are # # part of IRC formatted lines will be preserved # # for matching of this text. This value is # # optional. # # # # replace - The text to replace 'text' with. Usually this # # will be "PRIVMSG ServiceName :$2-" or similar. # # You may use the variables $1 through $9 in the # # replace string, which refer to the first through # # ninth word in the original string typed by the # # user. You may also use $1- through $9- which # # refer to the first word onwards, through to the # # ninth word onwards, e.g. if the user types the # # command "foo bar baz qux quz" then $3- will hold # # "baz qux quz" and $2 will contain "bar". You may # # also use the special variables: $nick, $ident, # # $host and $vhost, and you may seperate multiple # # commands with \n. If you wish to use the ACTUAL # # characters \ and n together in a line, you must # # use the sequence "\\n". # # # # requires - If you provide a value for 'requires' this means # # the given nickname MUST be online for the alias # # to successfully trigger. If they are not, then # # the user receives a 'no such nick' 401 numeric. # # # # uline - Defining this value with 'yes', 'true' or '1' # # will ensure that the user given in 'requires' # # must also be on a u-lined server, as well as # # actually being on the network. If the user is # # online, but not on a u-lined server, then an # # oper-alert is sent out as this is possibly signs # # of a user trying to impersonate a service. # # # # operonly - Defining this value, with a value of 'yes', '1' # # or true will make the alias oper only. If a non- # # oper attempts to use the alias, it will appear # # to not exist. # # # # # # # # # # # An example of using the format value to create an alias with two # different behaviours depending on the format of the parameters. # # # # # # This alias fixes a glitch in xchat 2.6.x and above and the way it # assumes IDENTIFY must be prefixed by a colon (:) character. It should # be placed ABOVE the default NICKSERV alias (the first example) listed # above. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Alltime module: Shows time on all connected servers at once # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Antibear security module: Prevents 'bear.txt' based trojans from # connecting to your network by sending them a numeric they can't handle. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Antibottler module: Labels bottler leech bots # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Auditorium module: Adds channel mode +u which makes everyone else # except you in the channel invisible, used for large meetings etc. # # # Auditorium settings: # # # # Setting this value to yes makes m_auditorium behave like unrealircd # +u channel mode, e.g. ops see users joining, parting, etc, and users # joining the channel see the ops. Without this flag, the mode acts # like ircnet's +a (anonymous channels), showing only the user in the # names list, and not even showing the ops in the list, or showing the # ops that the user has joined. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Ban except module: Adds support for channel ban exceptions (+e) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Ban redirection module: Allows bans which redirect to a specified # channel. e.g. +b nick!ident@host#channelbanneduserissentto # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block amsg module: Attempt to block all usage of /amsg and /ame # # #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # If you have the m_blockamsg.so module loaded, you can configure it # # with the tag: # # # # delay - How many seconds between two messages to force # # them to be recognised as unrelated. # # action - Any of 'notice', 'noticeopers', 'silent', 'kill' # # or 'killopers'. Define how to take action when # # a user uses /amsg or /ame. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block CAPS module: Blocking all-CAPS messages with cmode +P # # # #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # percent - How many percent of text must be caps before text # # will be blocked. # # # # minlen - The minimum length a line must be for the block # # percent to have any effect. # # # # capsmap - A list of chars to be considered CAPS, this was # # you can add CAPS for your language. Also you can # # add things like ! and space to further lock down # # on caps usage. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block colour module: Blocking colour-coded messages with cmode +c # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Botmode module: Adds the user mode +B # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CBAN module: Lets you disallow channels from being used at runtime. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Censor module: Adds the channel mode +G # # #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify to use the m_censor module, then you must # # specify some censor tags. See also: # # http://www.inspircd.org/wiki/Censor_Module # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CGI:IRC module: Adds support for automatic host changing in CGI:IRC # (http://cgiirc.sourceforge.net). # # #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# # # Optional - If you specify to use m_cgiirc, then you must specify one # or more cgihost tags which indicate authorized CGI:IRC servers which # will be connecting to your network, and an optional cgiirc tag. # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module # # Set to yes if you want to notice opers when CGI clients connect # # # The type field indicates where the module should get the real # client's IP address from, for further information, please see the # CGI:IRC documentation. # # # Get IP from PASS # # Get IP from WEBIRC # # Get IP from ident # # See the docs # # IMPORTANT NOTE: # --------------- # # When you connect CGI:IRC clients, there are two connect classes which # apply to these clients. When the client initially connects, the connect # class which matches the cgi:irc site's host is checked. Therefore you # must raise the maximum local/global clients for this ip as high as you # want to allow cgi clients. After the client has connected and is # determined to be a cgi:irc client, the class which matches the client's # real IP is then checked. You may set this class to a lower value, so that # the real IP of the client can still be restricted to, for example, 3 # sessions maximum. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel create module: Adds snomask +j, which will notify opers of # any new channels that are created # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel filter module: Allows channel-op defined message # filtering using simple string matches (channel mode +g) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Chanprotect module: gives +q and +a channel modes # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Check module: gives /check # Check is useful for looking up information on channels, # users, IP addresses and hosts. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CHGHOST module: Adds the /CHGHOST command # # #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-# # Optional - If you want to use special chars for hostnames you can # # specify your own custom list of chars with the tag: # # # # charmap - A list of chars accepted as valid by the /CHGHOST # # and /SETHOST commands. Also note that the list is # # case-sensitive. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CHGIDENT module: Adds the /CHGIDENT command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CHGNAME module: Adds the /CHGNAME command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Cloaking module: Adds usermode +x and cloaking support. # Relies on the module m_md5.so being loaded before m_cloaking.so in # the configuration file. # # #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify the m_cloaking.so module as above, you # # must define cloak keys, and optionally a cloak prefix as shown # # below. When using cloaking, the cloak keys are MANDITORY and must # # be included. However, if prefix is not included, it will default # # to your networks name from the tag. # # # # # # # # Please note that the key values will accept any number, and should # # be large numbers. Using small numbers such as "7" or "1924" will # # seriously weaken the security of your cloak. It is recommended you # # use hexdecimal numbers prefixed by "0x", as shown in this example, # # with each key eight hex digits long. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Clones module: Adds an oper command /CLONES for detecting cloned # users. Warning: This module may be resource intensive when its # command is issued, use with care. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Conn-Join: Allows you to force users to join one or more channels # automatically upon connecting to the server. # # #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # If you have m_conn_join.so loaded, you can configure it using the # follow values: # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Conn-Usermodes: Set modes on users when they connect # When this module is loaded tags may have an optional # modes="" value, which contains modes to add or remove from users # when they connect to the server. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Conn-Wait-for-Pong: Don't let a user connect until they PONG # # #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # If you have the m_conn_waitpong.so module loaded, configure it with # # the tag: # # # # sendsnotice - Whether to send a snotice on connect, like other # # older ircds # # # # killonbadreply - Whether to kill the user if they send the wrong # # PONG reply. # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel cycle module. Server side /hop, with +ilk etc bypass. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Connection throttle module. Configuration: # # #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # seconds, maxconns - Amount of connections per . # # timeout - Time to wait after the throttle was activated # before deactivating it. Be aware that the time # is seconds + timeout. # # quitmsg - The message that users get if they attempt to # connect while the throttle is active. # # bootwait - Amount of time to wait before enforcing the # throttling when the server just booted. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # DCCALLOW module: Adds the /DCCALLOW command # # #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # blockchat - Whether to block DCC CHAT as well as DCC SEND # length - Default duration of entries in DCCALLOW list # action - Default action to take if no action is specified # can be 'block' or 'allow' # # File configuration: # pattern - The glob pattern to match against # action - Action to take if a user attempts to send a file # that matches this pattern, can be 'block' or 'allow' # # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Deaf module: adds support for ircu style usermode +d - deaf to # channel messages and channel notices. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Deny Channels: Deny Channels from being used by users # # #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-# # # # If you have the m_denychans.so module loaded, you need to specify # # the channels to deny: # # # # name - The channel name to deny. # # # # allowopers - If operators are allowed to override the deny. # # # # reason - Reason given for the deny. # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Devoice Module: Let users devoice themselves. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # DNS Blacklist Module: Provides support for looking up IPs on one or # # more blacklists. # # # # # # For configuration options please see the wiki page for m_dnsbl at # # http://inspircd.org/wiki/DNS_Blacklist_Module # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Filter module: Provides glob-based message filtering # # OR # PCRE filter module: Filters messages using regular expressions # # # You may only use one or the other with these modules, network-wide. # #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify to use the m_filter or m_filter_pcre # # modules, then specfiy below the path to the filter.conf file, # # or define some tags. # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Foobar module: does nothing - historical relic # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Globops module: gives /GLOBOPS and usermode +g # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Global load module: Allows loading and unloading of modules network- # wide (USE WITH EXTREME CAUTION!) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # HELPOP module: Provides the /HELPOP command # # #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify to use the m_helpop.so module, then # # specify below the path to the helpop.conf file, or if you like to # # make a mess, define your helpop tags in this conf. # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # HIDECHANS module: Allows opers to hide their channels list from non- # opers by setting user mode +I on themselves. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # HIDEOPER module: Allows opers to hide their oper status from non- # opers by setting user mode +H on themselves. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Hostchange module: Allows a different style of cloaking # # #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # # Optional - If you choose to use the m_hostchange.so module. # # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module # # # # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # httpd module: Provides http server support for InspIRCd # # #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # Optional - If you choose to use the m_httpd.so module, then you must # specify the port number and other details of your http server: # # # # You may have as many of these tags as you wish, each with a different # IP, port, host or index file. Each one will act as an independent # HTTP server. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # http stats module: Provides basic stats pages over HTTP # Requires m_httpd.so to be loaded for it to function. # # #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Ident: Provides RFC 1413 ident lookup support # # #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you are using the m_ident.so module, then you can # # specify the timeout for ident lookups here. If not defined, it will # # default to one second. This is a non-blocking timeout which holds # # the user in a 'connecting' state until the lookup is complete. # # The bind value indicates which IP to bind outbound requests to. # # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Invite except module: Adds support for channel invite exceptions (+I) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Invisible module - Adds support for usermode +Q (quiet) which lets an # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that # opers are still able to see invisible users, and if an oper with +Q # deopers, they will become visible. # # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you # must first add the value canquiet="yes" to that oper's type tag. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Join flood module: Adds support for join flood protection (+j) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Jump Server module: Adds support for the RPL_REDIR numeric # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Knock module: adds the /KNOCK command and +K channel mode # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is # # used to temporarily close/open for new connections to the server. # # These commands require OPER status and that the LOCKSERV UNLOCKSERV # # are specified in a tag that the oper is part of. This is so # # you can control who has access to this possible dangerous command. # # If your server is locked and you got disconnected, do a REHASH from # # shell to open up again. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Msg flood module: Adds message/notice flood protection (+f) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # MySQL module: Allows other SQL modules to access MySQL databases # through a unified API. You must copy the source for this module # from the directory src/modules/extra, plus the file m_sqlv2.h # # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # # m_mysql.so is more complex than described here, see the wiki for # # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # NAMESX module: Provides support for the NAMESX extension which allows # clients to see all the prefixes set on a user without getting confused. # This is supported by mIRC, x-chat, klient, and maybe more. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Nicklock module: Let opers change a user's nick and then stop that # user from changing their nick again. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # No ctcp module: Adds the channel mode +C to block CTCPs # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Noinvite module: Gives channel mode +V # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # No kicks module: Adds the +Q channel mode # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # No nicks module: Adds the +N channel mode # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # No Notice module: adds the channel mode +T # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper channels mode: Adds the +O channel mode # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper hash module: Allows hashed oper passwords # Relies on the module m_md5.so and/or m_sha256.so being loaded before # m_oper_hash.so in the configuration file. # # #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# # # To use this module, you must define a hash type for each oper's # password you want to hash. For example: # # # # The types of hashing available vary depending on which hashing modules # you load, but usually if you load m_sha256.so and m_md5.so, both md5 # and sha256 type hashing will be available (the most secure of which # is SHA256). #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper Join module: Forces opers to join a channel on oper-up # # #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # If you are using the m_operjoin.so module, specify the channel here # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper MOTD module: Provides support for seperate message of the day # on oper-up # # #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # If you are using the m_opermotd.so module, specify the motd here # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Override module: Adds support for oper override # # #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # m_override.so is too complex it describe here, see the wiki: # # http://www.inspircd.org/wiki/Oper_Override_Module # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper levels module: Gives each oper a level and prevents # actions being taken against higher level opers # Specify the level as the 'level' parameter of the tag # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper modes module: Allows you to specify modes to add/remove on oper # Specify the modes as the 'modes' parameter of the tag # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # PostgreSQL module: Allows other SQL modules to access PgSQL databases # through a unified API. You must copy the source for this module # from the directory src/modules/extra, plus the file m_sqlv2.h # # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # # m_pgsql.so is more complex than described here, see the wiki for # # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Random Quote module: provides a random quote on connect. # NOTE: Some of these may mimic fatal errors and confuse users and # opers alike! - BEWARE! # # #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify to use the m_randquote.so module, then # # specify below the path to the randquotes.conf file. # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Redirect module: Adds channel redirection (mode +L) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Registered users only channel creation # Allows only registered users and opers to create new channels. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Remove module: Adds the /REMOVE command which is a peaceful # alternative to /KICK # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Restrict banned users module: # Disallows banned users on a channel from messaging the channel, # changing nick, or changing the topic, if loaded. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Restricted channels module: Allows only opers to create channels # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Restrict message module: Allows users to only message opers # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Provide /LIST throttling (to prevent flooding) and /LIST safety to # prevent excess flood when the list is large. # # #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # When using Safelist, you may set the following values; # # The first value, 'throttle', sets the amount of time in seconds a user # must wait between LIST commands. For example, if this is set to 60 # (the default) then the user may not /LIST more than once a minute. # If not defined, the default value is 60 seconds. # # The second value, 'maxlisters', indicates the maximum number of users # which may be retrieving a LIST at once. It is not recommended you raise # this value, as increasing it too high can make your network vulnerable # to floodbots which waste your bandwidth and CPU time with LIST requests. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SAJOIN module: Adds the /SAJOIN command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SAMODE module: Adds the oper /SAMODE command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SANICK module: Allows opers to change user's nicks # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SAPART module: Adds the oper /SAPART command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Secure list module: Prevent /LIST in the first minute of connection, # crippling most spambots and trojan spreader bots. # # #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # # Securelist can be harmful to some irc search engines such as # # netsplit.de and searchirc.com. To prevent securelist blocking these # # sites from listing, define exception tags as shown below: # # # # Define the following variable to change how long a user must wait # # before issuing a LIST. If not defined, defaults to 60 seconds. # # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # See nicks module: Allow for SNOMASK +N which shows nick changes. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Set Idle module: Adds a command for opers to change their # idle time (mainly a toy) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Services support module: Adds several usermodes such as +R and +M # this module implements the 'identified' state via user mode +r, which # is similar to the DALnet and dreamforge systems. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Services support module: Adds several usermodes such as +R and +M # this module implements the 'identified' state via account names (AC) # and is similar in operation to the way asuka and ircu handle services. # it cannot be used at the same time as m_services, above. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Sethost module: Adds the /SETHOST command # See m_chghost for how to customise valid chars for hostnames # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Setident module: Adds the /SETIDENT command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SETNAME module: Adds the /SETNAME command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Show Whois module: Adds the +W usermode which allows opers # to see when they are whois'ed (can be annoying). # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers # see who is in a +s channel, and list +s channels, show keys of keyed # channels the oper is not a member of etc. (standard 'abusive' features # of many other ircds, modulized here in InspIRCd). # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL channel mode module: Adds support for SSL-only channels (+z). # does not do anything useful without a working SSL module (see below) # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Dummy ssl module: If you have other servers on your network which # have SSL, but your server does not have ssl enabled, you should load # this module, which will handle SSL metadata (e.g. the "Is using ssl" # field in the WHOIS information). # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS, # if enabled. You must copy the source for this module from the directory # src/modules/extra, or answer 'yes' in ./configure when asked if you # want to enable this, or it will not load. # # #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # m_ssl_gnutls.so is too complex it describe here, see the wiki: # # http://www.inspircd.org/wiki/GnuTLS_SSL_Module # # # # NOTE: If you want to use this module to encrypt and sign your # # server to server traffic, you MUST load it before m_spanningtree in # # your configuration file! # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL Info module: Allows users to retrieve information about other # user's peer SSL certificates and keys. This can be used by client # scripts to validate users. For this to work, one of m_ssl_gnutls.so # or m_ssl_openssl.so must be loaded. You must symlink the source for # this module from the directory src/modules/extra. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL, # if enabled. You must copy the source for this module from the directory # src/modules/extra, or answer 'yes' in ./configure when asked if you # want to enable this, or it will not load. # # #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # m_ssl_openssl.so is too complex it describe here, see the wiki: # # http://www.inspircd.org/wiki/OpenSSL_SSL_Module # # # # NOTE: If you want to use this module to encrypt and sign your # # server to server traffic, you MUST load it before m_spanningtree in # # your configuration file! # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL Cert Oper module: Allows opers to oper up using the key fingerprint # stored within their SSL certificate and key pair. # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must # be loaded. An extra value should be added to enabled opers, which # is in the following format: fingerprint="". For more information, # see the example in the oper blocks. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Strip colour module: Adds the channel mode +S # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SILENCE module: Adds support for /SILENCE # # # Configuration tags: # # # # Sets the maximum number of entries on a users silence list. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Extended SILENCE module: Adds support for /SILENCE with additional # features to silence based on invites, channel messages, etc. # # # The configuration tags for this module are identical to those of # m_silence, shown above. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQLite3 module: Allows other SQL modules to access SQLite3 # # databases through a unified API. You must link the source for this # # module from the directory src/modules/extra to src/modules, plus # # the file m_sqlv2.h # # # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # # m_sqlite.so is more complex than described here, see the wiki for # # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQLutils module: Provides some utilities to SQL client modules, such # as mapping queries to users and channels. You must copy the source # for this module from the directory src/modules/extra/m_sqlutils.cpp # and src/modules/extra/m_sqlutils.h into /src/modules # Needed for, and loaded before: SQLauth and SQLoper # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL authentication module: Allows IRCd connections to be tied into # a database table (for example a forum). You must copy the source for # this module from the directory src/modules/extra # Depends on the SQLutils module being loaded first. # # #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # m_sqlauth.so is too complex it describe here, see the wiki: # # http://www.inspircd.org/wiki/SQL_Authentication_Module # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL logging module: Allows you to log network-wide data for your # network in a fully normalized set of SQL tables. You must copy the # source for this module from the directory src/modules/extra # # #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # dbid - Database ID to use (see m_sql) # # # # See also: http://www.inspircd.org/wiki/SQL_Logging_Module # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL oper module: Allows you to store oper credentials in an SQL table # You must copy the source for this module from the directory src/modules/extra # Depends on the SQLutils module being loaded first. # # #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # dbid - Database ID to use (see m_sql) # # # # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module # # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be # # added/removed by Services. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SWHOIS module: Allows you to add arbitary lines to user WHOIS. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Test command module: Does nothing significant. Read: pointless. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Timed bans module: Adds timed bans and the /TBAN command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Test line module: Adds the /TLINE command, used to test how many # users a /GLINE or /ZLINE etc would match. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # UHNAMES support module: Adds support for the IRCX style UHNAMES # extension, which displays ident and hostname in the names list for # each user, saving clients from doing a WHO on the channel. Note that # this module is not widely supported yet. If a client does not support # UHNAMES it will not enable it, this will not break incompatible # clients. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Uninvite module: Adds the /UNINVITE command which lets users remove # pending invites from channels without waiting for the user to join. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Userip module: Adds the /USERIP command # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Vhost module: Adds the VHOST command which allows for adding virtual # hosts which are accessible using a username and password in the config. # # #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # # user - Username for the vhost. # # # # pass - Password for the vhost. # # # # host - Vhost to set. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Watch module: Adds the WATCH command, which is used by clients to # maintain notify lists. # # # Configuration tags: # # # # Sets the maximum number of entries on a user's watch list. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # XMLSocket module: Adds support for connections using the shockwave # flash XMLSocket. Note that this does not work if the client you are # using has retarded ideas of the IRC protocol. Your client must still # send RFC-correct lines to the server, this module only changes the # line ending from newlines to null terminators. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # ZipLinks module: Adds support for zlib deflate on server to server # connections. Both ends of the connection must load this module. # # # # To use this module, you must enable it as a transport type in your # tags or tags using the transport name 'zip'. # See the documentation of and , respectively. # #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # The ban tags define nick masks, host masks and ip ranges which are # # banned from your server. All details in these tags are local to # # Your server. # # # # # # badip lines ban an ip range (same as a zline) # # # # ipmask - The ip range to ban (wildcards possible) # # CIDR is supported in the IP mask. # # reason - Reason to display when disconnected # # # # badnick lines ban a nick mask (same as a qline) # # # # nick - Nick mask to ban (wildcards possible) # # reason - Reason to display on /NICK # # # # badhost lines ban a user@host mask (same as a kline) # # # # host - ident@hostname (wildcards possible) # # If you specify an IP, CIDR is supported. # # reason - Reason to display on disconnection # # # # exception lines define a hostmask that is excempt from [kzg]lines # # # # host - ident@hostname (wildcards possible) # # If you specify an IP, CIDR is supported. # # reason - Reason, shown only in /stats e # # # #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # This optional tag allows you to specify how wide a gline, eline, # # kline, zline or qline can be before it is forbidden from being # # set. By setting hostmasks="yes", you can allow all G, K, E lines, # # no matter how many users the ban would cover. This is not # # recommended! By setting ipmasks="yes", you can allow all Z lines, # # no matter how many users these cover too. Needless to say we # # don't recommend you do this, or, set nickmasks="yes", which will # # allow any qline. # # # # The trigger value indicates how wide any mask will be before it is # # prevented from being set. The default value is 95.5% if this tag is # # not defined in your configuration file, meaning that if your # # network has 1000 users, a gline matching over 955 of them will be # # prevented from being added. # # # # Please note that remote servers (and services) are exempt from # # these restrictions and expected to enforce their own policies # # locally! # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # You should already know what to do here :) # ######################################################################### # # # - InspIRCd Development Team - # # http://www.inspircd.org # # # ######################################################################### \ No newline at end of file +######################################################################## +# # +# ___ ___ ____ ____ _ # +# |_ _|_ __ ___ _ __|_ _| _ \ / ___|__| | # +# | || '_ \/ __| '_ \| || |_) | | / _` | # +# | || | | \__ \ |_) | || _ <| |__| (_| | # +# |___|_| |_|___/ .__/___|_| \_\\____\__,_| # +# |_| # +# ____ __ _ _ _ # +# / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ # +# | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ # +# | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | # +# \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| # +# |___/ # +# # +##################################||#################################### + #||# +##################################||#################################### +# # +# This is an example of the config file for InspIRCd. # +# Change the options to suit your network # +# # +# $Id$ +# # +# ____ _ _____ _ _ ____ _ _ _ # +# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # +# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # +# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # +# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # +# # +# Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT # +# lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even # +# if you've configured InspIRCd before, these probably indicate # +# something new or different to this version and you SHOULD READ IT. # +# # +######################################################################## +# # +# Unalphabeticalise the modules list at your own risk # +# # +######################################################################## + + +#-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#- +# # +# Here is where you enter the information about your server. # +# # +# Syntax is as follows: # +# # +# # +# # + + + + +#-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# Describes the Server Administrator's real name (optionally), # +# nick, and email address. # +# # +# Syntax is as follows: # +# # +# # + + + + +#-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- +# # +# Enter the port and address bindings here. # +# # +# bind address - specifies which address ports bind to. Leaving this # +# field blank binds the port to all IPs available. # +# # +# port - The port number to bind to. You may specify a port # +# range here, e.g. "6667-6669,7000,7001". If you do # +# this, the server will count each port within your # +# range as a seperate binding, making the above # +# example equivalent to five seperate bind tags. # +# A failure on one port in the range does not prevent # +# the entire range from being bound, just that one # +# port number. # +# # +# type - can be 'clients' or 'servers'. The clients type is # +# a standard tcp based socket, the servers type is a # +# also a TCP based connection but of a different # +# format. SSL support is provided by modules, to # +# enable SSL support, please read the module section # +# of this configuration file. # +# # +# ssl - When using m_ssl_gnutls.so or m_ssl_openssl.so # +# modules, you must define this value to use ssl on # +# that port. valid values are 'gnutls' or 'openssl' # +# respectively. If the module is not loaded, this # +# setting is ignored. # +# # +# transport - If you have m_spanningtree.so loaded, along with # +# either of the SSL modules (m_ssl_gnutls or # +# m_ssl_openssl) or m_ziplinks.so, then you may make # +# use of this value. # +# setting it to 'openssl' or 'gnutls' or 'zip' # +# indicates that the port should accept connections # +# using the given transport name. Transports are # +# layers which sit on top of a socket and change the # +# way data is sent and received, e.g. encryption, # +# compression, and other such things. Because this # +# may not be limited in use to just encryption, # +# the 'ssl' value used for client ports does not # +# exist for servers, and this value is used instead. # +# ____ _ _____ _ _ ____ _ _ _ # +# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # +# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # +# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # +# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # +# # +# If you want to link servers to InspIRCd you must load the # +# m_spanningtree module! Please see the modules list below for # +# information on how to load this module! If you do not load this # +# module, server ports will NOT be bound! # +# # +# Leaving address empty binds to all available interfaces # +# # +# Syntax is as follows: # +# # +# # +# # +# # +# If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, # +# then you can specify IPV4 ip addresses here to bind. You may also # +# use the 4in6 notation, ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 # +# address to bind the port, but as of InspIRCd 1.1.1, this is not # +# required. # +# # +# ------------------------------------------------------------------- # +# # +# PLEASE NOTE: If you have build InspIRCd as an ipv6 server, and you # +# specify an empty bind address, the binding will be bound to ALL THE # +# IPV6 IP ADDRESSES, and not the ipv4 addresses. If you are using an # +# ipv6 enabled InspIRCd and want to bind to multiple IPV4 addresses # +# in this way, you must specify them by hand. If you have built the # +# server for ipv4 connections only, then specifying an empty bind # +# address binds the port to all ipv4 IP addresses, as expected. # +# # + + + + +# When linking servers, the openssl and gnutls transports are largely +# link-compatible and can be used alongside each other or either/or +# on each end of the link without any significant issues. + + + + + +#-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#- +# # +# You can configure the passwords here which you wish to use for # +# the die and restart commands. Only trusted ircops who will # +# need this ability should know the die and restart password. # +# # +# Syntax is as follows: # +# # +# # + + + + +#-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# This optional tag allows you to include another config file # +# allowing you to keep your configuration tidy. The configuration # +# 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 of the main # +# config file inspircd.conf, unless the filename starts with a forward# +# slash (/) in which case it is treated as an absolute path. # +# # +# Syntax is as follows: # +# # +# # + +#-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# This is where you can configure which connections are allowed # +# and denied access onto your server. The password is optional. # +# You may have as many of these as you require. To allow/deny all # +# connections, use a '*' or 0.0.0.0/0. # +# # +# Syntax is as follows: # +# # +# # +# # +# # +# # +# IP masks may be specified in CIDR format or wildcard format, # +# for IPV4 and IPV6. You *cannot* use hostnames in the allow or # +# deny field, as the state is applied before the user's DNS has # +# been resolved. # +# # +# You may optionally include timeout="x" on any allow line, which # +# specifies the amount of time given before an unknown connection # +# is closed if USER/NICK/PASS are not given. This value is in secs # +# # +# You should also include a flood="x" line which indicates # +# the number of lines a user may place into their buffer at once # +# before they are disconnected for excess flood. This feature can # +# not be disabled, however it can be set to extremely high values, # +# rendering it effectively disabled. A recommended value is 10. # +# A counter is maintained for each user which is reset every # +# 'threshold' seconds and specifying this threshold value with # +# threshold="X" indicates how often the counter is reset. For # +# example, with flood="5" and threshold="8", the user may not send # +# more than 5 lines in 8 secs. # +# # +# You may optionally specify the sendq size and ping frequency of # +# each connect:allow line using the pingfreq="X" and sendq="X" # +# settings as shown in the full example below. # +# The ping frequency is specified in seconds, and the sendq size # +# in bytes. It is recommended, although not enforced, that you # +# should never set your sendq size to less than 8k. Send Queues are # +# dynamically allocated and can grow as needed up to the maximum # +# size specified. # +# # +# The optional recvq value is the maximum size which users in this # +# group may grow their receive queue to. This is recommended to be # +# kept pretty low compared to the sendq, as users will always # +# receive more than they send in normal circumstances. The default # +# if not specified is 4096. # +# # +# The sendq is the data waiting to be sent TO THE USER. # +# The recvq is the data being received FROM THE USER. # +# The names sendq and recvq are from the SERVER'S PERSPECTIVE not # +# that of the user... Just to clear up any confusion or complaints # +# that these are backwards :p # +# # +# The localmax and globalmax values can be used to enforce local # +# and global session limits on connections. The session limits are # +# counted against all users, but applied only to users within the # +# class. For example, if you had a class 'A' which has a session # +# limit of 3, and a class 'B' which has a session limit of 5, and # +# somehow, two users managed to get into class B which also match # +# class A, there is only one connection left for this IP now in A, # +# but if they can connect again to B, there are three. You get the # +# idea (i hope). # +# # +# The optional port value determines which port the connect tag is # +# handling. If left out the connect tag covers all bound ports else # +# only incoming connections on the specified port will match. Port # +# tags may be used on connect allow and connect deny tags. # +# # + + + + + + + + + +#-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- +# # +# Classes are a group of commands which are grouped together # +# and given a unique name. They used to define which commands # +# are available to certain types of Operators. # +# # +# Syntax is as follows: # +# # +# # +# # +# ____ _ _____ _ _ ____ _ _ _ # +# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # +# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # +# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # +# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # +# # +# You are not forced to give these classes the names given below. # +# You can create your own named classes, if you want, in fact that # +# is the whole idea of this system! # +# # +# Note: It is possible to make a class which covers all available # +# commands. To do this, specify commands="*". This is not really # +# recommended, as it negates the whole purpose of the class system, # +# however it is provided for fast configuration (e.g. in test nets) # +# # + + + + + + + + +#-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-# +# # +# This is where you specify which types of operators you have on # +# your server, as well as the commands they are allowed to use. # +# This works alongside with the classes specified above. # +# # +# type name - a name for the combined class types # +# a type name cannot contain spaces, however if you # +# put an _ symbol in the name, it will be translated # +# to a space when displayed in a WHOIS. # +# # +# classes - specified above, used for flexibility for the # +# server admin to decide on which operators get # +# what commands. Class names are case sensitive, # +# seperate multiple class names with spaces. # +# # +# host - optional hostmask operators will receive on oper-up. # +# # +# Syntax is as follows: # +# # +# # +# # +# ____ _ _____ _ _ ____ _ _ _ # +# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # +# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # +# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # +# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # +# # +# You are not forced to give these types the names given below. # +# You can create your own named types, if you want, in fact that # +# is the whole idea of this system! # +# # + + + + + + +#-#-#-#-#-#-#-#-#-#-#- OPERATOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# Opers are defined here. This is a very important section. # +# Remember to only make operators out of truthworthy people. # +# # +# name - oper name, This is case sensitive, so it is best to # +# use lower-case. # +# # +# password - password to oper-up, also case sensitive. # +# encryption is supported via modules. You may load # +# modules for MD5 or SHA256 encryption, and if you do, # +# this value will be a hash value, otherwise put a # +# plaintext password in this value. # +# # +# host - hosts of client allowed to oper-up. # +# wildcards accepted, seperate multiple hosts with a # +# space. You may also specify CIDR ip addresses. # +# # +# fingerprint - When using the m_ssl_oper_cert.so module, you may # +# specify a key fingerprint here. This can be obtained # +# using the /fingerprint command whilst the module is # +# loaded, or from the notice given to you when you # +# connect to the ircd using a client certificate, # +# and will lock this oper block to only the user who # +# has that specific key/certificate pair. # +# This enhances security a great deal, however it # +# requires that opers use clients which can send ssl # +# client certificates, if this is configured for that # +# oper. Note that if the m_ssl_oper.so module is not # +# loaded, and/or one of m_ssl_openssl or m_ssl_gnutls # +# is not loaded, this configuration option has no # +# effect and will be ignored. # +# # +# type - Defines the kind of operator. This must match a type # +# tag you defined above, and is case sensitive. # +# # +# Syntax is as follows: # +# # +# # + + + + +#-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# # +# Defines which servers can link to this one, and which servers this # +# server may create outbound links to. # +# # +# name - The name is the canocial name of the server, does # +# not have to resolve - but it is expected to be set # +# in the remote servers connection info. # +# # +# ipaddr - Valid host or ip address for remote server. These # +# hosts are resolved on rehash, and cached, if you # +# specify a hostname, so if you find that your server # +# is still trying to connect to an old IP after you # +# have updated your dns, try rehashing and then # +# attempting the connect again. # +# # +# port - The TCP port for the remote server. # +# # +# sendpass - Password to send to create an outbound connection # +# to this server. # +# # +# recvpass - Password to receive to accept an inbound connection # +# from this server. # +# # +# autoconnect - Sets the server to autoconnect. Where x is the num. # +# (optional) of seconds between attempts. e.g. 300 = 5 minutes. # +# # +# transport - If defined, this is a transport name implemented by # +# another module. Transports are layers on top of # +# plaintext connections, which alter them in certain # +# ways. Currently the three supported transports are # +# 'openssl' and 'gnutls' which are types of SSL # +# encryption, and 'zip' which is for compression. # +# If you define a transport, both ends of the # +# connection must use a compatible transport for the # +# link to succeed. OpenSSL and GnuTLS are link- # +# compatible with each other. # +# # +# statshidden - When using m_spanningtree.so for linking. you may # +# set this to 'yes', and if you do, the IP address/ # +# hostname of this connection will NEVER be shown to # +# any opers on the network. In /STATS c its address # +# will show as *@, and during CONNECT and # +# inbound connections, its IP will show as # +# UNLESS the connection fails (e.g. due to a bad # +# password or servername) # +# # +# allowmask - When this is defined, it indicates a range of IP # +# addresses to allow for this link (You may use CIDR # +# or wildcard form for this address). # +# e.g. if your server is going to connect to you from # +# the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 # +# into this value. If it is not defined, then only # +# the ipaddr field of the server shall be allowed. # +# # +# failover - If you define this option, it must be the name of a # +# different link tag in your configuration. This # +# option causes the ircd to attempt a connection to # +# the failover link in the event that the connection # +# to this server fails. For example, you could define # +# two hub uplinks to a leaf server, and set an # +# american server to autoconnect, with a european # +# hub as its failover. In this situation, your ircd # +# will only try the link to the european hub if the # +# american hub is unreachable. NOTE that for the # +# intents and purposes of this option, an unreachable # +# server is one which DOES NOT ANSWER THE CONNECTION. # +# If the server answers the connection with accept(), # +# EVEN IF THE CREDENTIALS ARE INVALID, the failover # +# link will not be tried! Failover settings will also # +# apply to autoconnected servers as well as manually # +# connected ones. # +# # +# timeout - If this is defined, then outbound connections will # +# time out if they are not connected within this many # +# seconds. If this is not defined, the default of ten # +# seconds is used. # +# # +# bind - If you specify this value, then when creating an # +# outbound connection to the given server, the IP you # +# place here will be bound to. This is for multi- # +# homed servers which may have multiple IP addresses. # +# If you do not define this value, the first IP that # +# is not empty or localhost from your tags # +# will be bound to. This is usually acceptable, # +# however if your server has multiple network cards # +# then you may have to manually specify the bind # +# value instead of leaving it to automatic binding. # +# You can usually tell if you need to set this by # +# looking for the error 'Could not assign requested # +# address' in your log when connecting to servers. # +# # +# hidden - If this is set to true, yes, or 1, then the server # +# is completely hidden from non-opers. It does not # +# show in LINKS and it does not show in MAP. Also, # +# any servers which are child servers of this one # +# in the network will *also* be hidden. Use with # +# care! You can use this to 'mask off' sections of # +# the network so that users only see a small portion # +# of a much larger net. It should NOT be relied upon # +# as a security tool, unless it is being used for # +# example to hide a non-client hub, for which clients # +# do not have an IP address or resolvable hostname. # +# # +# to u:line a server (give it extra privilages required for running # +# services, Q, etc) you must include the tag as shown # +# in the example below. You can have as many of these as you like. # +# # +# WARNING: Unlike other ircds, u:lining a server allows ALL users on # +# that server to operoverride modes. This should only be used for # +# services and protected oper servers! # +# # +# ------------------------------------------------------------------- # +# # +# NOTE: If you have built your server as an ipv6 server, then when a # +# DNS lookup of a server's host occurs, AAAA records (ipv6) are # +# priorotized over A records (ipv4). Therefore, if the server you are # +# connecting to has both an IPV6 ip address and an IPV4 ip address in # +# its DNS entry, the IPV6 address will *always* be selected. To # +# change this behaviour simply specify the IPV4 IP address rather # +# than the hostname of the server. # +# # +# ------------------------------------------------------------------- # +# # +# ____ _ _____ _ _ ____ _ _ _ # +# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # +# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # +# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # +# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # +# # +# If you want to link servers to InspIRCd you must load the # +# m_spanningtree module! Please see the modules list below for # +# information on how to load this module! If you do not load this # +# module, server links will NOT work! # +# # +# Also, if you define any transports, you must load the modules for # +# these transports BEFORE you load m_spanningtree, e.g. place them # +# above it in the configuration file. Currently this means the three # +# modules m_ssl_gnutls, m_ziplinks and m_ssl_openssl, depending on # +# which you choose to use. # +# # + + + + + + +#-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# +# This tag defines a ulined server. A U-Lined server has special # +# permissions, and should be used with caution. Services servers are # +# usually u-lined in this manner. # +# # +# The 'silent' value if set to yes indicates that this server should # +# not generate quit and connect notices, which can cut down on noise # +# to opers on the network. # +# # + + + +#-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# # +# These options let you define the path to your motd and rules # +# files. If these are relative paths, they are relative to the # +# configurtion directory. # +# # + + + +#-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# This optional configuration tag lets you define the maximum number # +# of channels that both opers and users may be on at any one time. # +# the default is 20 for user and 60 for opers if this tag is not # +# defined. Remote users are not restricted in any manner. # +# # + + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# Define your DNS server address here. InspIRCd has its own resolver. # +# If you do not define this value, then then InspIRCd will attempt to # +# determine your DNS server from your operating system. On POSIX # +# platforms, InspIRCd will read /etc/resolv.conf, and populate this # +# value with the first DNS server address found. On Windows platforms # +# InspIRCd will check the registry, and use the DNS server of the # +# first active network interface, if one exists. # +# If a DNS server cannot be determined from these checks, the default # +# value '127.0.0.1' is used instead. The timeout value is in seconds. # +# # +# ____ _ _____ _ _ ____ _ _ _ # +# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # +# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # +# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # +# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # +# # +# When choosing a server, be sure to choose one which will do a # +# RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these # +# recursive lookups itself, to save time and resources. The dns # +# server recommended by the InspIRCd team is bind, available from the # +# ISC website. If your DNS server does not do a recursive lookup, you # +# will be able to notice this by the fact that none of your users are # +# resolving even though the DNS server appears to be up! Most ISP and # +# hosting provider DNS servers support recursive lookups. # +# # +# ------------------------------------------------------------------- # +# # +# NOTE: if you have built InspIRCd with IPV6 support, then both # +# ipv6 and ipv4 addresses are allowed here, and also in the system # +# resolv.conf file. Remember that an ipv4 dns server can still # +# resolve ipv6 addresses, and vice versa. # +# # + + + +# An example of using an IPV6 nameserver +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# Define the path to the PID file here. The PID file can be used to # +# 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. # +# # + +# + +#-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# Use these tags to customise the ban limits on a per channel basis. # +# the tags are read from top to bottom, and any tag found which # +# matches the channels name applies the banlimit to that channel. # +# It is advisable to put an entry with the channel as '*' at the # +# bottom of the list. If none are specified or no maxbans tag is # +# matched, the banlist size defaults to 64 entries. # +# # + + + + +#-#-#-#-#-#-#-#-#-#-#- DISABLED COMMANDS -#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# This tag is optional, and specifies one or more commands which are # +# not available to non-operators. For example you may wish to disable # +# NICK and prevent non-opers from changing their nicknames. # +# Note that any disabled commands take effect only after the user has # +# 'registered' (e.g. after the initial USER/NICK/PASS on connection) # +# so for example disabling NICK will not cripple your network. # +# # + +# + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# Just remove this... Its here to make you read ALL of the config # +# file options ;) # + + + + + +#-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# Settings to define which features are useable on your server. # +# # +# prefixquit - A prefix to be placed on the start of a client's # +# quit message # +# # +# suffixquit - A suffix to be placed on the end of a client's # +# quit message. # +# # +# fixedquit - A fixed quit message to display for all client # +# QUITS. If specified, overrides both prefixquit # +# and suffixquit options. # +# # +# loglevel - specifies what detail of messages to log in the # +# log file. You may select from debug, verbose, # +# default, sparse and none. # +# # +# allowhalfop - allows the +h channel mode # +# # +# noservices - If noservices is true, yes, or 1, then the first # +# user into a channel gets founder status. This is # +# only useful on networks running the m_chanprotect # +# module without services. # +# # +# qaprefixes - If qaprefixes is true, yes, or 1, then users # +# with +q or +a will get the ~ or & prefixes # +# used in unreal. This is only useful on networks # +# running the m_chanprotect module # +# # +# deprotectself - If this value is set to yes, true, or 1, then any # +# user with +q or +a may remove the +q or +a from # +# themselves. The default setting is to not enable # +# this feature, which stops even the founder taking # +# away their founder status without using services. # +# # +# deprotectothers-If this value is set to yes, true, or 1, then any # +# user with +q or +a may remove the +q or +a from # +# other users. The default setting is to not enable # +# this feature, so that only +q may remove +a, and # +# nothing but services may remove +q. # +# # +# cyclehosts - If this is set to true, yes or 1, then when a # +# user's hostname changes, they will appear to quit # +# and then rejoin with their new host. This prevents # +# clients from being confused by host changes, # +# especially in the case of bots, and it is # +# recommended that this option is enabled. # +# # +# netbuffersize - size of the buffer used to receive data from # +# clients. The ircd may only read() this amount # +# of text in one go at any time. (OPTIONAL) # +# # +# maxwho - The maximum number of results returned by a /WHO # +# query. This is to prevent /WHO being used as a # +# spam vector or means of flooding an ircd. The # +# default is 128, it is not recommended to raise it # +# above 1024. Values up to 65535 are permitted. If # +# this value is omitted, any size WHO is allowed by # +# anyone. # +# # +# somaxconn - The maximum number of sockets that may be waiting # +# in the accept queue. This usually allows the ircd # +# to soak up more connections in a shorter space of # +# time when increased but please be aware there is a # +# system defined maximum value to this, the same way # +# there is a system defined maximum number of file # +# descriptors. Some systems may only allow this to # +# be up to 5 (ugh) while others such as FreeBSD will # +# default to a much nicer 128. # +# # +# moduledir - This optional value indicates a runtime change of # +# the location where modules are to be found. This # +# does not add a supplementary directory. There can # +# only be one module path. # +# # +# softlimit - This optional feature allows a defined softlimit. # +# if defined sets a soft maxconnections value, has # +# to be less than the ./configure maxclients # +# # +# userstats - The userstats field is optional and specifies # +# which stats characters in /STATS may be requested # +# by non-operators. Stats characters in this field # +# are case sensitive and are allowed to users # +# independent of if they are in a module or the core # +# # +# operspywhois - If this is set then when an IRC operator uses # +# /WHOIS on a user they will see all channels, even # +# ones if channels are secret (+s), private (+p) or # +# if the target user is invisible +i. # +# # +# customversion - If you specify this configuration item, and it is # +# not set to an empty value, then when a user does # +# a /VERSION command on the ircd, this string will # +# be displayed as the second portion of the output, # +# replacing the system 'uname', compile flags and # +# socket engine/dns engine names. You may use this # +# to enhance security, or simply for vanity. # +# # +# maxtargets - The maxtargets field is optional, and if not # +# defined, defaults to 20. It indicates the maximum # +# number of targets which may be given to commands # +# such as PRIVMSG, KICK etc. # +# # +# hidesplits - When set to 'yes', will hide split server names # +# from non-opers. Non-opers will see '*.net *.split' # +# instead of the server names in the quit message, # +# identical to the way IRCu displays them. # +# # +# hidebans - When set to 'yes', will hide gline, kline, zline # +# and qline quit messages from non-opers. For # +# example, user A who is not an oper will just see # +# (G-Lined) while user B who is an oper will see the # +# text (G-Lined: Reason here) instead. # +# # +# hidewhois - When defined with a non-empty value, the given # +# text will be used in place of the user's server # +# in WHOIS, when a user is WHOISed by a non-oper. # +# For example, most nets will want to set this to # +# something like '*.netname.net' to conceal the # +# actual server the user is on. # +# # +# flatlinks - When you are using m_spanningtree.so, and this # +# value is set to true, yes or 1, /MAP and /LINKS # +# will be flattened when shown to a non-oper. # +# # +# hideulines - When you are using m_spanningtree.so, and this # +# value is set to true, yes or 1, then U-lined # +# servers will be hidden in /LINKS and /MAP. For non # +# opers. Please be aware that this will also hide # +# any leaf servers of a U-lined server, e.g. jupes. # +# # +# nouserdns - If set to 'yes', 'true' or '1', no user dns # +# lookups will be performed for connecting users. # +# this can save a lot of resources on very busy irc # +# servers. # +# # +# syntaxhints - If set to 'yes', 'true' or '1', when a user does # +# not give enough parameters for a command, a syntax # +# hint will be given (using the RPL_TEXT numeric) # +# as well as the standard ERR_NEEDMOREPARAMS. # +# # +# announcets - If this value is defined to 'yes', 'true' or '1', # +# then if a channel's timestamp is updated the users # +# on the channel will be informed of the change via # +# a server notice to the channel with the old and # +# new TS values in the timestamp. If you think this # +# is just pointless noise, define the value to 0. # +# # +# ircumsgprefix - Use undernet style message prefix for channel # +# NOTICE and PRIVMSG adding the prefix to the line # +# of text sent out. Eg. NOTICE @#test :@ testing # +# vs. the off setting: NOTICE @#test :testing # +# # +# hostintopic - If this is set to yes (the default) then the full # +# nick!user@host is shown for who set a TOPIC last. # +# if set to no, then only the nickname is shown. # +# # +# announceinvites # +# - If this option is set to yes (the default), then # +# invites are announced to the channel when a user # +# invites annother user. If you consider this to be # +# unnecessary noise, explicitly set this to no. # +# # +# disablehmac - If you are linking your InspIRCd to older versions # +# then you can specify this option and set it to # +# yes. 1.1.6 and above support HMAC and challenge- # +# response for password authentication. These can # +# greatly enhance security of your server to server # +# connections when you are not using SSL (as is the # +# case with a lot of larger networks). Linking to # +# older versions of InspIRCd should not *usually* be # +# a problem, but if you have problems with HMAC # +# authentication, this option can be used to turn it # +# off. # +# # +# hidemodes - If this option is enabled, then the listmodes # +# given (e.g. +eI), will be hidden from users below # +# halfop. This is not recommended to be set on mode # +# +b, as it may break some features in popular # +# clients such as mIRC. # +# # +# quietbursts - When synching or splitting from the network, a # +# server can generate a lot of connect and quit # +# snotices to the +C and +Q snomasks. Setting this # +# value to yes squelches those messages, which can # +# make them more useful for opers, however it will # +# degrade their use by certain third party programs # +# such as BOPM which rely on them to scan users when # +# a split heals in certain configurations. # +# # +# pingwarning - This should be set to a number between 1 and 59 if # +# defined, and if it is defined will cause the server# +# to send out a warning via snomask +l if a server # +# does not answer to PING after this many seconds. # +# This can be useful for finding servers which are # +# at risk of pinging out due to network issues. # +# # +# exemptchanops - This option allows channel operators to be exempted# +# from certain channel modes. # +# Supported modes are +SfgNc. Defaults to off. # +# # +# defaultmodes - The default modes to be given to each channel on # +# creation. Defaults to 'nt'. There should be no + # +# or - symbols in this sequence, if you add them # +# they will be ignored. You may add parameters for # +# parameterised modes. # +# # +# moronbanner - The NOTICE to show to users who are glined, zlined # +# klined or qlined when they are disconnected. This # +# is totally freeform, you may place any text here # +# you wish. # +# # + + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-# +# Time sychronization options for m_spanningtree linking. # +# # +# Because IRC is very time and clock dependent, InspIRCd provides its # +# own methods for syncronization of time between servers as shown # +# in the example below, for servers that don't have ntpd running. # +# # +# enable - If this value is 'yes', 'true', or '1', time # +# synchronization is enabled on this server. This # +# means any servers you are linked to will # +# automatically synchronize time, however you should # +# use ntpd instead where possible, NOT this option. # +# # +# master - If this value is set to yes, then this server will # +# act as the authoritative time source for the whole # +# network. All other servers will respect its time # +# without question, and match their times to it. # +# only one server should have the master value set # +# to 'yes'. # +# # + + +#-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# This tag lets you define the behaviour of the /whowas command of # +# your server. # +# # +# groupsize - Controls the maximum entries per nick shown when # +# performing a /whowas nick. Setting this to 0 dis- # +# ables whowas completely. # +# # +# maxgroups - The maximum number of nickgroups that can be added # +# to the list. If max is reached, oldest group will # +# be deleted first like a FIFO. A groupsize of 3 and # +# a maxgroups of 5000 will allow for 5000 nicks to # +# be stored with a history of 3, thus giving a total # +# of 3 * 5000 = 15000 entries. A setting of 0 dis- # +# ables whowas completely. # +# # +# maxkeep - The maximum time a nick is kept in the whowas list # +# before being pruned. Time may be specified in # +# seconds, or in the following format: 1y2w3d4h5m6s # +# meaning one year, two weeks, three days, 4 hours, # +# 5 minutes and 6 seconds. All fields in this format # +# are optional. Minimum is 1 hour, if less InspIRCd # +# will default back to 1 hour. # +# # +# # + + +#-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# These tags define which modules will be loaded on startup by your # +# server. Add modules without any paths. When you make your ircd # +# using the 'make' command, all compiled modules will be moved into # +# the folder you specified when you ran ./configure. The module tag # +# automatically looks for modules in this location. # +# If you attempt to load a module outside of this location, either # +# in the config, or via /LOADMODULE, you will receive an error. # +# # +# By default, ALL modules are commented out. You must uncomment them # +# or add lines to your config to load modules. Please refer to # +# http://www.inspircd.org/wiki/Modules_List for a list of modules and# +# each modules link for any additional conf tags they require. # +# # +# You may use wildcards in a tag to load all modules which # +# match a glob pattern (e.g. m_sa????.so would load m_sajoin, # +# m_sapart, m_saquit and m_sanick) # +# # +# ____ _ _____ _ _ ____ _ _ _ # +# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # +# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # +# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # +# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # +# # +# To link servers to InspIRCd, you MUST load the m_spanningtree # +# module, as shown below. If you DO NOT do this, server links will # +# NOT work at all. ie. The ports will NOT bind, and /connect will not # +# work properly. This is by design, to allow for the implementation # +# of other linking protocols in modules in the future. # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Spanning Tree module - allows linking of servers using the spanning +# tree protocol (see the READ THIS BIT section above). +# +# + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# MD5 Module - Allows other modules to generate MD5 hashes, usually for +# cryptographic uses and security. +# +# IMPORTANT: +# Other modules such as m_cloaking.so and m_opermd5.so may rely on +# this module being loaded to function. +# +# +# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SHA256 Module - Allows other modules to generate SHA256 hashes, +# usually for cryptographic uses and security. +# +# IMPORTANT: +# Other modules such as m_opermd5.so may rely on this module being +# loaded to function. +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Alias module: Allows you to define server-side command aliases +# +# +#-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the m_alias.so module loaded, you may also define # +# aliases as shown below. They are commonly used to provide shortcut # +# commands to services, however they are not limited to just this use.# +# An alias tag requires the following values to be defined in it: # +# # +# text - The text to detect as the actual command line, # +# Cant contain spaces, but case insensitive. # +# You may have multiple aliases with the same # +# command name (text="" value), however the first # +# found will be executed if its format value is # +# matched, or it has no format value. Aliases are # +# read from the top of the file to the bottom. # +# # +# format - If this is defined, the parameters of the alias # +# must match this glob pattern. For example if you # +# want the first parameter to start with a # for # +# the alias to be executed, set format="#*" in the # +# alias definition. Note that the :'s which are # +# part of IRC formatted lines will be preserved # +# for matching of this text. This value is # +# optional. # +# # +# replace - The text to replace 'text' with. Usually this # +# will be "PRIVMSG ServiceName :$2-" or similar. # +# You may use the variables $1 through $9 in the # +# replace string, which refer to the first through # +# ninth word in the original string typed by the # +# user. You may also use $1- through $9- which # +# refer to the first word onwards, through to the # +# ninth word onwards, e.g. if the user types the # +# command "foo bar baz qux quz" then $3- will hold # +# "baz qux quz" and $2 will contain "bar". You may # +# also use the special variables: $nick, $ident, # +# $host and $vhost, and you may seperate multiple # +# commands with \n. If you wish to use the ACTUAL # +# characters \ and n together in a line, you must # +# use the sequence "\\n". # +# # +# requires - If you provide a value for 'requires' this means # +# the given nickname MUST be online for the alias # +# to successfully trigger. If they are not, then # +# the user receives a 'no such nick' 401 numeric. # +# # +# uline - Defining this value with 'yes', 'true' or '1' # +# will ensure that the user given in 'requires' # +# must also be on a u-lined server, as well as # +# actually being on the network. If the user is # +# online, but not on a u-lined server, then an # +# oper-alert is sent out as this is possibly signs # +# of a user trying to impersonate a service. # +# # +# operonly - Defining this value, with a value of 'yes', '1' # +# or true will make the alias oper only. If a non- # +# oper attempts to use the alias, it will appear # +# to not exist. # +# # +# +# +# +# +# +# +# +# An example of using the format value to create an alias with two +# different behaviours depending on the format of the parameters. +# +# +# +# +# +# This alias fixes a glitch in xchat 2.6.x and above and the way it +# assumes IDENTIFY must be prefixed by a colon (:) character. It should +# be placed ABOVE the default NICKSERV alias (the first example) listed +# above. +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Alltime module: Shows time on all connected servers at once +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Antibear security module: Prevents 'bear.txt' based trojans from +# connecting to your network by sending them a numeric they can't handle. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Antibottler module: Labels bottler leech bots +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Auditorium module: Adds channel mode +u which makes everyone else +# except you in the channel invisible, used for large meetings etc. +# +# +# Auditorium settings: +# +# +# +# Setting this value to yes makes m_auditorium behave like unrealircd +# +u channel mode, e.g. ops see users joining, parting, etc, and users +# joining the channel see the ops. Without this flag, the mode acts +# like ircnet's +a (anonymous channels), showing only the user in the +# names list, and not even showing the ops in the list, or showing the +# ops that the user has joined. + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Ban except module: Adds support for channel ban exceptions (+e) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Ban redirection module: Allows bans which redirect to a specified +# channel. e.g. +b nick!ident@host#channelbanneduserissentto +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Block amsg module: Attempt to block all usage of /amsg and /ame +# +# +#-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the m_blockamsg.so module loaded, you can configure it # +# with the tag: # +# # +# delay - How many seconds between two messages to force # +# them to be recognised as unrelated. # +# action - Any of 'notice', 'noticeopers', 'silent', 'kill' # +# or 'killopers'. Define how to take action when # +# a user uses /amsg or /ame. # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Block CAPS module: Blocking all-CAPS messages with cmode +P +# +# # +#-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# percent - How many percent of text must be caps before text # +# will be blocked. # +# # +# minlen - The minimum length a line must be for the block # +# percent to have any effect. # +# # +# capsmap - A list of chars to be considered CAPS, this was # +# you can add CAPS for your language. Also you can # +# add things like ! and space to further lock down # +# on caps usage. # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Block colour module: Blocking colour-coded messages with cmode +c +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Botmode module: Adds the user mode +B +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CBAN module: Lets you disallow channels from being used at runtime. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Censor module: Adds the channel mode +G +# +# +#-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify to use the m_censor module, then you must # +# specify some censor tags. See also: # +# http://www.inspircd.org/wiki/Censor_Module # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CGI:IRC module: Adds support for automatic host changing in CGI:IRC +# (http://cgiirc.sourceforge.net). +# +# +#-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# +# +# Optional - If you specify to use m_cgiirc, then you must specify one +# or more cgihost tags which indicate authorized CGI:IRC servers which +# will be connecting to your network, and an optional cgiirc tag. +# For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module +# +# Set to yes if you want to notice opers when CGI clients connect +# +# +# The type field indicates where the module should get the real +# client's IP address from, for further information, please see the +# CGI:IRC documentation. +# +# # Get IP from PASS +# # Get IP from WEBIRC +# # Get IP from ident +# # See the docs +# +# IMPORTANT NOTE: +# --------------- +# +# When you connect CGI:IRC clients, there are two connect classes which +# apply to these clients. When the client initially connects, the connect +# class which matches the cgi:irc site's host is checked. Therefore you +# must raise the maximum local/global clients for this ip as high as you +# want to allow cgi clients. After the client has connected and is +# determined to be a cgi:irc client, the class which matches the client's +# real IP is then checked. You may set this class to a lower value, so that +# the real IP of the client can still be restricted to, for example, 3 +# sessions maximum. +# + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel create module: Adds snomask +j, which will notify opers of +# any new channels that are created +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel filter module: Allows channel-op defined message +# filtering using simple string matches (channel mode +g) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Chanprotect module: gives +q and +a channel modes +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Check module: gives /check +# Check is useful for looking up information on channels, +# users, IP addresses and hosts. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CHGHOST module: Adds the /CHGHOST command +# +# +#-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-# +# Optional - If you want to use special chars for hostnames you can # +# specify your own custom list of chars with the tag: # +# # +# charmap - A list of chars accepted as valid by the /CHGHOST # +# and /SETHOST commands. Also note that the list is # +# case-sensitive. # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CHGIDENT module: Adds the /CHGIDENT command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CHGNAME module: Adds the /CHGNAME command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Cloaking module: Adds usermode +x and cloaking support. +# Relies on the module m_md5.so being loaded before m_cloaking.so in +# the configuration file. +# +# +#-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify the m_cloaking.so module as above, you # +# must define cloak keys, and optionally a cloak prefix as shown # +# below. When using cloaking, the cloak keys are MANDITORY and must # +# be included. However, if prefix is not included, it will default # +# to your networks name from the tag. # +# # +# # +# # +# Please note that the key values will accept any number, and should # +# be large numbers. Using small numbers such as "7" or "1924" will # +# seriously weaken the security of your cloak. It is recommended you # +# use hexdecimal numbers prefixed by "0x", as shown in this example, # +# with each key eight hex digits long. # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Clones module: Adds an oper command /CLONES for detecting cloned +# users. Warning: This module may be resource intensive when its +# command is issued, use with care. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Conn-Join: Allows you to force users to join one or more channels +# automatically upon connecting to the server. +# +# +#-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# +# If you have m_conn_join.so loaded, you can configure it using the +# follow values: +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Conn-Usermodes: Set modes on users when they connect +# When this module is loaded tags may have an optional +# modes="" value, which contains modes to add or remove from users +# when they connect to the server. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Conn-Wait-for-Pong: Don't let a user connect until they PONG +# +# +#-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the m_conn_waitpong.so module loaded, configure it with # +# the tag: # +# # +# sendsnotice - Whether to send a snotice on connect, like other # +# older ircds # +# # +# killonbadreply - Whether to kill the user if they send the wrong # +# PONG reply. # +# # +# + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Channel cycle module. Server side /hop, with +ilk etc bypass. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Connection throttle module. Configuration: +# +# +#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# seconds, maxconns - Amount of connections per . +# +# timeout - Time to wait after the throttle was activated +# before deactivating it. Be aware that the time +# is seconds + timeout. +# +# quitmsg - The message that users get if they attempt to +# connect while the throttle is active. +# +# bootwait - Amount of time to wait before enforcing the +# throttling when the server just booted. +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# DCCALLOW module: Adds the /DCCALLOW command +# +# +#-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# blockchat - Whether to block DCC CHAT as well as DCC SEND +# length - Default duration of entries in DCCALLOW list +# action - Default action to take if no action is specified +# can be 'block' or 'allow' +# +# File configuration: +# pattern - The glob pattern to match against +# action - Action to take if a user attempts to send a file +# that matches this pattern, can be 'block' or 'allow' +# +# +# +# +# +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Deaf module: adds support for ircu style usermode +d - deaf to +# channel messages and channel notices. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Deny Channels: Deny Channels from being used by users +# +# +#-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-# +# # +# If you have the m_denychans.so module loaded, you need to specify # +# the channels to deny: # +# # +# name - The channel name to deny. # +# # +# allowopers - If operators are allowed to override the deny. # +# # +# reason - Reason given for the deny. # +# # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Devoice Module: Let users devoice themselves. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# DNS Blacklist Module: Provides support for looking up IPs on one or # +# more blacklists. # +# # +# # +# For configuration options please see the wiki page for m_dnsbl at # +# http://inspircd.org/wiki/DNS_Blacklist_Module # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Filter module: Provides glob-based message filtering +# +# OR +# PCRE filter module: Filters messages using regular expressions +# +# +# You may only use one or the other with these modules, network-wide. +# +#-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify to use the m_filter or m_filter_pcre # +# modules, then specfiy below the path to the filter.conf file, # +# or define some tags. # +# # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Foobar module: does nothing - historical relic +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Globops module: gives /GLOBOPS and usermode +g +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Global load module: Allows loading and unloading of modules network- +# wide (USE WITH EXTREME CAUTION!) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# HELPOP module: Provides the /HELPOP command +# +# +#-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify to use the m_helpop.so module, then # +# specify below the path to the helpop.conf file, or if you like to # +# make a mess, define your helpop tags in this conf. # +# # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# HIDECHANS module: Allows opers to hide their channels list from non- +# opers by setting user mode +I on themselves. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# HIDEOPER module: Allows opers to hide their oper status from non- +# opers by setting user mode +H on themselves. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Hostchange module: Allows a different style of cloaking +# +# +#-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you choose to use the m_hostchange.so module. # +# Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module # +# # +# +# +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# httpd module: Provides http server support for InspIRCd +# +# +#-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# +# Optional - If you choose to use the m_httpd.so module, then you must +# specify the port number and other details of your http server: +# +# +# +# You may have as many of these tags as you wish, each with a different +# IP, port, host or index file. Each one will act as an independent +# HTTP server. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# http stats module: Provides basic stats pages over HTTP +# Requires m_httpd.so to be loaded for it to function. +# +# +#-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Ident: Provides RFC 1413 ident lookup support +# +# +#-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you are using the m_ident.so module, then you can # +# specify the timeout for ident lookups here. If not defined, it will # +# default to one second. This is a non-blocking timeout which holds # +# the user in a 'connecting' state until the lookup is complete. # +# The bind value indicates which IP to bind outbound requests to. # +# # +# # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Invite except module: Adds support for channel invite exceptions (+I) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Invisible module - Adds support for usermode +Q (quiet) which lets an +# oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that +# opers are still able to see invisible users, and if an oper with +Q +# deopers, they will become visible. +# +# IMPORTANT NOTE: To allow this mode to be used by a type of oper, you +# must first add the value canquiet="yes" to that oper's type tag. +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Join flood module: Adds support for join flood protection (+j) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Jump Server module: Adds support for the RPL_REDIR numeric +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Knock module: adds the /KNOCK command and +K channel mode +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is # +# used to temporarily close/open for new connections to the server. # +# These commands require OPER status and that the LOCKSERV UNLOCKSERV # +# are specified in a tag that the oper is part of. This is so # +# you can control who has access to this possible dangerous command. # +# If your server is locked and you got disconnected, do a REHASH from # +# shell to open up again. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Msg flood module: Adds message/notice flood protection (+f) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# MySQL module: Allows other SQL modules to access MySQL databases +# through a unified API. You must copy the source for this module +# from the directory src/modules/extra, plus the file m_sqlv2.h +# +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_mysql.so is more complex than described here, see the wiki for # +# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# NAMESX module: Provides support for the NAMESX extension which allows +# clients to see all the prefixes set on a user without getting confused. +# This is supported by mIRC, x-chat, klient, and maybe more. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Nicklock module: Let opers change a user's nick and then stop that +# user from changing their nick again. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No ctcp module: Adds the channel mode +C to block CTCPs +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Noinvite module: Gives channel mode +V +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No kicks module: Adds the +Q channel mode +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No nicks module: Adds the +N channel mode +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# No Notice module: adds the channel mode +T +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper channels mode: Adds the +O channel mode +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper hash module: Allows hashed oper passwords +# Relies on the module m_md5.so and/or m_sha256.so being loaded before +# m_oper_hash.so in the configuration file. +# +# +#-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-# +# +# To use this module, you must define a hash type for each oper's +# password you want to hash. For example: +# +# +# +# The types of hashing available vary depending on which hashing modules +# you load, but usually if you load m_sha256.so and m_md5.so, both md5 +# and sha256 type hashing will be available (the most secure of which +# is SHA256). + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper Join module: Forces opers to join a channel on oper-up +# +# +#-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you are using the m_operjoin.so module, specify the channel here # +# # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper MOTD module: Provides support for seperate message of the day +# on oper-up +# +# +#-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# If you are using the m_opermotd.so module, specify the motd here # +# # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Override module: Adds support for oper override +# +# +#-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# m_override.so is too complex it describe here, see the wiki: # +# http://www.inspircd.org/wiki/Oper_Override_Module # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper levels module: Gives each oper a level and prevents +# actions being taken against higher level opers +# Specify the level as the 'level' parameter of the tag +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Oper modes module: Allows you to specify modes to add/remove on oper +# Specify the modes as the 'modes' parameter of the tag +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# PostgreSQL module: Allows other SQL modules to access PgSQL databases +# through a unified API. You must copy the source for this module +# from the directory src/modules/extra, plus the file m_sqlv2.h +# +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_pgsql.so is more complex than described here, see the wiki for # +# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Random Quote module: provides a random quote on connect. +# NOTE: Some of these may mimic fatal errors and confuse users and +# opers alike! - BEWARE! +# +# +#-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# Optional - If you specify to use the m_randquote.so module, then # +# specify below the path to the randquotes.conf file. # +# # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Redirect module: Adds channel redirection (mode +L) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Registered users only channel creation +# Allows only registered users and opers to create new channels. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Remove module: Adds the /REMOVE command which is a peaceful +# alternative to /KICK +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Restrict banned users module: +# Disallows banned users on a channel from messaging the channel, +# changing nick, or changing the topic, if loaded. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Restricted channels module: Allows only opers to create channels +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Restrict message module: Allows users to only message opers +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Provide /LIST throttling (to prevent flooding) and /LIST safety to +# prevent excess flood when the list is large. +# +# +#-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# +# When using Safelist, you may set the following values; +# +# The first value, 'throttle', sets the amount of time in seconds a user +# must wait between LIST commands. For example, if this is set to 60 +# (the default) then the user may not /LIST more than once a minute. +# If not defined, the default value is 60 seconds. +# +# The second value, 'maxlisters', indicates the maximum number of users +# which may be retrieving a LIST at once. It is not recommended you raise +# this value, as increasing it too high can make your network vulnerable +# to floodbots which waste your bandwidth and CPU time with LIST requests. +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAJOIN module: Adds the /SAJOIN command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAMODE module: Adds the oper /SAMODE command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SANICK module: Allows opers to change user's nicks +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAPART module: Adds the oper /SAPART command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SAQUIT module: Adds the oper /SAQUIT command (abusable!!!) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Secure list module: Prevent /LIST in the first minute of connection, +# crippling most spambots and trojan spreader bots. +# +# +#-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# Securelist can be harmful to some irc search engines such as # +# netsplit.de and searchirc.com. To prevent securelist blocking these # +# sites from listing, define exception tags as shown below: # + + + +# # +# Define the following variable to change how long a user must wait # +# before issuing a LIST. If not defined, defaults to 60 seconds. # +# # +# # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# See nicks module: Allow for SNOMASK +N which shows nick changes. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Set Idle module: Adds a command for opers to change their +# idle time (mainly a toy) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Services support module: Adds several usermodes such as +R and +M +# this module implements the 'identified' state via user mode +r, which +# is similar to the DALnet and dreamforge systems. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Services support module: Adds several usermodes such as +R and +M +# this module implements the 'identified' state via account names (AC) +# and is similar in operation to the way asuka and ircu handle services. +# it cannot be used at the same time as m_services, above. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Sethost module: Adds the /SETHOST command +# See m_chghost for how to customise valid chars for hostnames +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Setident module: Adds the /SETIDENT command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SETNAME module: Adds the /SETNAME command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Show Whois module: Adds the +W usermode which allows opers +# to see when they are whois'ed (can be annoying). +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Spy module: Adds the commands SPYLIST and SPYNAMES that let opers +# see who is in a +s channel, and list +s channels, show keys of keyed +# channels the oper is not a member of etc. (standard 'abusive' features +# of many other ircds, modulized here in InspIRCd). +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SSL channel mode module: Adds support for SSL-only channels (+z). +# does not do anything useful without a working SSL module (see below) +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Dummy ssl module: If you have other servers on your network which +# have SSL, but your server does not have ssl enabled, you should load +# this module, which will handle SSL metadata (e.g. the "Is using ssl" +# field in the WHOIS information). +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# GnuTLS ssl module: Adds support for client-server SSL using GnuTLS, +# if enabled. You must copy the source for this module from the directory +# src/modules/extra, or answer 'yes' in ./configure when asked if you +# want to enable this, or it will not load. +# +# +#-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_ssl_gnutls.so is too complex it describe here, see the wiki: # +# http://www.inspircd.org/wiki/GnuTLS_SSL_Module # +# # +# NOTE: If you want to use this module to encrypt and sign your # +# server to server traffic, you MUST load it before m_spanningtree in # +# your configuration file! # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SSL Info module: Allows users to retrieve information about other +# user's peer SSL certificates and keys. This can be used by client +# scripts to validate users. For this to work, one of m_ssl_gnutls.so +# or m_ssl_openssl.so must be loaded. You must symlink the source for +# this module from the directory src/modules/extra. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# OpenSSL ssl module: Adds support for client-server SSL using OpenSSL, +# if enabled. You must copy the source for this module from the directory +# src/modules/extra, or answer 'yes' in ./configure when asked if you +# want to enable this, or it will not load. +# +# +#-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_ssl_openssl.so is too complex it describe here, see the wiki: # +# http://www.inspircd.org/wiki/OpenSSL_SSL_Module # +# # +# NOTE: If you want to use this module to encrypt and sign your # +# server to server traffic, you MUST load it before m_spanningtree in # +# your configuration file! # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SSL Cert Oper module: Allows opers to oper up using the key fingerprint +# stored within their SSL certificate and key pair. +# When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must +# be loaded. An extra value should be added to enabled opers, which +# is in the following format: fingerprint="". For more information, +# see the example in the oper blocks. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Strip colour module: Adds the channel mode +S +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SILENCE module: Adds support for /SILENCE +# +# +# Configuration tags: +# +# +# +# Sets the maximum number of entries on a users silence list. + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Extended SILENCE module: Adds support for /SILENCE with additional +# features to silence based on invites, channel messages, etc. +# +# +# The configuration tags for this module are identical to those of +# m_silence, shown above. + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQLite3 module: Allows other SQL modules to access SQLite3 # +# databases through a unified API. You must link the source for this # +# module from the directory src/modules/extra to src/modules, plus # +# the file m_sqlv2.h # +# +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_sqlite.so is more complex than described here, see the wiki for # +# more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQLutils module: Provides some utilities to SQL client modules, such +# as mapping queries to users and channels. You must copy the source +# for this module from the directory src/modules/extra/m_sqlutils.cpp +# and src/modules/extra/m_sqlutils.h into /src/modules +# Needed for, and loaded before: SQLauth and SQLoper +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQL authentication module: Allows IRCd connections to be tied into +# a database table (for example a forum). You must copy the source for +# this module from the directory src/modules/extra +# Depends on the SQLutils module being loaded first. +# +# +#-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_sqlauth.so is too complex it describe here, see the wiki: # +# http://www.inspircd.org/wiki/SQL_Authentication_Module # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQL logging module: Allows you to log network-wide data for your +# network in a fully normalized set of SQL tables. You must copy the +# source for this module from the directory src/modules/extra +# +# +#-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# dbid - Database ID to use (see m_sql) # +# # +# See also: http://www.inspircd.org/wiki/SQL_Logging_Module # +# # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQL oper module: Allows you to store oper credentials in an SQL table +# You must copy the source for this module from the directory src/modules/extra +# Depends on the SQLutils module being loaded first. +# +# +#-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# +# # +# dbid - Database ID to use (see m_sql) # +# # +# See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module # +# # +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be # +# added/removed by Services. # +# + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SWHOIS module: Allows you to add arbitary lines to user WHOIS. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Test command module: Does nothing significant. Read: pointless. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Timed bans module: Adds timed bans and the /TBAN command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Test line module: Adds the /TLINE command, used to test how many +# users a /GLINE or /ZLINE etc would match. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# UHNAMES support module: Adds support for the IRCX style UHNAMES +# extension, which displays ident and hostname in the names list for +# each user, saving clients from doing a WHO on the channel. Note that +# this module is not widely supported yet. If a client does not support +# UHNAMES it will not enable it, this will not break incompatible +# clients. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Uninvite module: Adds the /UNINVITE command which lets users remove +# pending invites from channels without waiting for the user to join. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Userip module: Adds the /USERIP command +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Vhost module: Adds the VHOST command which allows for adding virtual +# hosts which are accessible using a username and password in the config. +# +# +#-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# user - Username for the vhost. # +# # +# pass - Password for the vhost. # +# # +# host - Vhost to set. # +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Watch module: Adds the WATCH command, which is used by clients to +# maintain notify lists. +# +# +# Configuration tags: +# +# +# +# Sets the maximum number of entries on a user's watch list. + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# XMLSocket module: Adds support for connections using the shockwave +# flash XMLSocket. Note that this does not work if the client you are +# using has retarded ideas of the IRC protocol. Your client must still +# send RFC-correct lines to the server, this module only changes the +# line ending from newlines to null terminators. +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# ZipLinks module: Adds support for zlib deflate on server to server +# connections. Both ends of the connection must load this module. +# +# +# +# To use this module, you must enable it as a transport type in your +# tags or tags using the transport name 'zip'. +# See the documentation of and , respectively. +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# The ban tags define nick masks, host masks and ip ranges which are # +# banned from your server. All details in these tags are local to # +# Your server. # +# # +# # +# badip lines ban an ip range (same as a zline) # +# # +# ipmask - The ip range to ban (wildcards possible) # +# CIDR is supported in the IP mask. # +# reason - Reason to display when disconnected # +# # +# badnick lines ban a nick mask (same as a qline) # +# # +# nick - Nick mask to ban (wildcards possible) # +# reason - Reason to display on /NICK # +# # +# badhost lines ban a user@host mask (same as a kline) # +# # +# host - ident@hostname (wildcards possible) # +# If you specify an IP, CIDR is supported. # +# reason - Reason to display on disconnection # +# # +# exception lines define a hostmask that is excempt from [kzg]lines # +# # +# host - ident@hostname (wildcards possible) # +# If you specify an IP, CIDR is supported. # +# reason - Reason, shown only in /stats e # +# # + + + + + + + + + + + + + + +#-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# This optional tag allows you to specify how wide a gline, eline, # +# kline, zline or qline can be before it is forbidden from being # +# set. By setting hostmasks="yes", you can allow all G, K, E lines, # +# no matter how many users the ban would cover. This is not # +# recommended! By setting ipmasks="yes", you can allow all Z lines, # +# no matter how many users these cover too. Needless to say we # +# don't recommend you do this, or, set nickmasks="yes", which will # +# allow any qline. # +# # +# The trigger value indicates how wide any mask will be before it is # +# prevented from being set. The default value is 95.5% if this tag is # +# not defined in your configuration file, meaning that if your # +# network has 1000 users, a gline matching over 955 of them will be # +# prevented from being added. # +# # +# Please note that remote servers (and services) are exempt from # +# these restrictions and expected to enforce their own policies # +# locally! # +# # + + + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# You should already know what to do here :) # + + + + +######################################################################### +# # +# - InspIRCd Development Team - # +# http://www.inspircd.org # +# # +######################################################################### diff --git a/docs/rfc/rfc1035.txt b/docs/rfc/rfc1035.txt index 007e3c028..b1a9bf5a9 100644 --- a/docs/rfc/rfc1035.txt +++ b/docs/rfc/rfc1035.txt @@ -1 +1,3077 @@ -Network Working Group P. Mockapetris Request for Comments: 1035 ISI November 1987 Obsoletes: RFCs 882, 883, 973 DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION 1. STATUS OF THIS MEMO This RFC describes the details of the domain system and protocol, and assumes that the reader is familiar with the concepts discussed in a companion RFC, "Domain Names - Concepts and Facilities" [RFC-1034]. The domain system is a mixture of functions and data types which are an official protocol and functions and data types which are still experimental. Since the domain system is intentionally extensible, new data types and experimental behavior should always be expected in parts of the system beyond the official protocol. The official protocol parts include standard queries, responses and the Internet class RR data formats (e.g., host addresses). Since the previous RFC set, several definitions have changed, so some previous definitions are obsolete. Experimental or obsolete features are clearly marked in these RFCs, and such information should be used with caution. The reader is especially cautioned not to depend on the values which appear in examples to be current or complete, since their purpose is primarily pedagogical. Distribution of this memo is unlimited. Table of Contents 1. STATUS OF THIS MEMO 1 2. INTRODUCTION 3 2.1. Overview 3 2.2. Common configurations 4 2.3. Conventions 7 2.3.1. Preferred name syntax 7 2.3.2. Data Transmission Order 8 2.3.3. Character Case 9 2.3.4. Size limits 10 3. DOMAIN NAME SPACE AND RR DEFINITIONS 10 3.1. Name space definitions 10 3.2. RR definitions 11 3.2.1. Format 11 3.2.2. TYPE values 12 3.2.3. QTYPE values 12 3.2.4. CLASS values 13 Mockapetris [Page 1] RFC 1035 Domain Implementation and Specification November 1987 3.2.5. QCLASS values 13 3.3. Standard RRs 13 3.3.1. CNAME RDATA format 14 3.3.2. HINFO RDATA format 14 3.3.3. MB RDATA format (EXPERIMENTAL) 14 3.3.4. MD RDATA format (Obsolete) 15 3.3.5. MF RDATA format (Obsolete) 15 3.3.6. MG RDATA format (EXPERIMENTAL) 16 3.3.7. MINFO RDATA format (EXPERIMENTAL) 16 3.3.8. MR RDATA format (EXPERIMENTAL) 17 3.3.9. MX RDATA format 17 3.3.10. NULL RDATA format (EXPERIMENTAL) 17 3.3.11. NS RDATA format 18 3.3.12. PTR RDATA format 18 3.3.13. SOA RDATA format 19 3.3.14. TXT RDATA format 20 3.4. ARPA Internet specific RRs 20 3.4.1. A RDATA format 20 3.4.2. WKS RDATA format 21 3.5. IN-ADDR.ARPA domain 22 3.6. Defining new types, classes, and special namespaces 24 4. MESSAGES 25 4.1. Format 25 4.1.1. Header section format 26 4.1.2. Question section format 28 4.1.3. Resource record format 29 4.1.4. Message compression 30 4.2. Transport 32 4.2.1. UDP usage 32 4.2.2. TCP usage 32 5. MASTER FILES 33 5.1. Format 33 5.2. Use of master files to define zones 35 5.3. Master file example 36 6. NAME SERVER IMPLEMENTATION 37 6.1. Architecture 37 6.1.1. Control 37 6.1.2. Database 37 6.1.3. Time 39 6.2. Standard query processing 39 6.3. Zone refresh and reload processing 39 6.4. Inverse queries (Optional) 40 6.4.1. The contents of inverse queries and responses 40 6.4.2. Inverse query and response example 41 6.4.3. Inverse query processing 42 Mockapetris [Page 2] RFC 1035 Domain Implementation and Specification November 1987 6.5. Completion queries and responses 42 7. RESOLVER IMPLEMENTATION 43 7.1. Transforming a user request into a query 43 7.2. Sending the queries 44 7.3. Processing responses 46 7.4. Using the cache 47 8. MAIL SUPPORT 47 8.1. Mail exchange binding 48 8.2. Mailbox binding (Experimental) 48 9. REFERENCES and BIBLIOGRAPHY 50 Index 54 2. INTRODUCTION 2.1. Overview The goal of domain names is to provide a mechanism for naming resources in such a way that the names are usable in different hosts, networks, protocol families, internets, and administrative organizations. From the user's point of view, domain names are useful as arguments to a local agent, called a resolver, which retrieves information associated with the domain name. Thus a user might ask for the host address or mail information associated with a particular domain name. To enable the user to request a particular type of information, an appropriate query type is passed to the resolver with the domain name. To the user, the domain tree is a single information space; the resolver is responsible for hiding the distribution of data among name servers from the user. From the resolver's point of view, the database that makes up the domain space is distributed among various name servers. Different parts of the domain space are stored in different name servers, although a particular data item will be stored redundantly in two or more name servers. The resolver starts with knowledge of at least one name server. When the resolver processes a user query it asks a known name server for the information; in return, the resolver either receives the desired information or a referral to another name server. Using these referrals, resolvers learn the identities and contents of other name servers. Resolvers are responsible for dealing with the distribution of the domain space and dealing with the effects of name server failure by consulting redundant databases in other servers. Name servers manage two kinds of data. The first kind of data held in sets called zones; each zone is the complete database for a particular "pruned" subtree of the domain space. This data is called authoritative. A name server periodically checks to make sure that its zones are up to date, and if not, obtains a new copy of updated zones Mockapetris [Page 3] RFC 1035 Domain Implementation and Specification November 1987 from master files stored locally or in another name server. The second kind of data is cached data which was acquired by a local resolver. This data may be incomplete, but improves the performance of the retrieval process when non-local data is repeatedly accessed. Cached data is eventually discarded by a timeout mechanism. This functional structure isolates the problems of user interface, failure recovery, and distribution in the resolvers and isolates the database update and refresh problems in the name servers. 2.2. Common configurations A host can participate in the domain name system in a number of ways, depending on whether the host runs programs that retrieve information from the domain system, name servers that answer queries from other hosts, or various combinations of both functions. The simplest, and perhaps most typical, configuration is shown below: Local Host | Foreign | +---------+ +----------+ | +--------+ | | user queries | |queries | | | | User |-------------->| |---------|->|Foreign | | Program | | Resolver | | | Name | | |<--------------| |<--------|--| Server | | | user responses| |responses| | | +---------+ +----------+ | +--------+ | A | cache additions | | references | V | | +----------+ | | cache | | +----------+ | User programs interact with the domain name space through resolvers; the format of user queries and user responses is specific to the host and its operating system. User queries will typically be operating system calls, and the resolver and its cache will be part of the host operating system. Less capable hosts may choose to implement the resolver as a subroutine to be linked in with every program that needs its services. Resolvers answer user queries with information they acquire via queries to foreign name servers and the local cache. Note that the resolver may have to make several queries to several different foreign name servers to answer a particular user query, and hence the resolution of a user query may involve several network accesses and an arbitrary amount of time. The queries to foreign name servers and the corresponding responses have a standard format described Mockapetris [Page 4] RFC 1035 Domain Implementation and Specification November 1987 in this memo, and may be datagrams. Depending on its capabilities, a name server could be a stand alone program on a dedicated machine or a process or processes on a large timeshared host. A simple configuration might be: Local Host | Foreign | +---------+ | / /| | +---------+ | +----------+ | +--------+ | | | | |responses| | | | | | | Name |---------|->|Foreign | | Master |-------------->| Server | | |Resolver| | files | | | |<--------|--| | | |/ | | queries | +--------+ +---------+ +----------+ | Here a primary name server acquires information about one or more zones by reading master files from its local file system, and answers queries about those zones that arrive from foreign resolvers. The DNS requires that all zones be redundantly supported by more than one name server. Designated secondary servers can acquire zones and check for updates from the primary server using the zone transfer protocol of the DNS. This configuration is shown below: Local Host | Foreign | +---------+ | / /| | +---------+ | +----------+ | +--------+ | | | | |responses| | | | | | | Name |---------|->|Foreign | | Master |-------------->| Server | | |Resolver| | files | | | |<--------|--| | | |/ | | queries | +--------+ +---------+ +----------+ | A |maintenance | +--------+ | +------------|->| | | queries | |Foreign | | | | Name | +------------------|--| Server | maintenance responses | +--------+ In this configuration, the name server periodically establishes a virtual circuit to a foreign name server to acquire a copy of a zone or to check that an existing copy has not changed. The messages sent for Mockapetris [Page 5] RFC 1035 Domain Implementation and Specification November 1987 these maintenance activities follow the same form as queries and responses, but the message sequences are somewhat different. The information flow in a host that supports all aspects of the domain name system is shown below: Local Host | Foreign | +---------+ +----------+ | +--------+ | | user queries | |queries | | | | User |-------------->| |---------|->|Foreign | | Program | | Resolver | | | Name | | |<--------------| |<--------|--| Server | | | user responses| |responses| | | +---------+ +----------+ | +--------+ | A | cache additions | | references | V | | +----------+ | | Shared | | | database | | +----------+ | A | | +---------+ refreshes | | references | / /| | V | +---------+ | +----------+ | +--------+ | | | | |responses| | | | | | | Name |---------|->|Foreign | | Master |-------------->| Server | | |Resolver| | files | | | |<--------|--| | | |/ | | queries | +--------+ +---------+ +----------+ | A |maintenance | +--------+ | +------------|->| | | queries | |Foreign | | | | Name | +------------------|--| Server | maintenance responses | +--------+ The shared database holds domain space data for the local name server and resolver. The contents of the shared database will typically be a mixture of authoritative data maintained by the periodic refresh operations of the name server and cached data from previous resolver requests. The structure of the domain data and the necessity for synchronization between name servers and resolvers imply the general characteristics of this database, but the actual format is up to the local implementor. Mockapetris [Page 6] RFC 1035 Domain Implementation and Specification November 1987 Information flow can also be tailored so that a group of hosts act together to optimize activities. Sometimes this is done to offload less capable hosts so that they do not have to implement a full resolver. This can be appropriate for PCs or hosts which want to minimize the amount of new network code which is required. This scheme can also allow a group of hosts can share a small number of caches rather than maintaining a large number of separate caches, on the premise that the centralized caches will have a higher hit ratio. In either case, resolvers are replaced with stub resolvers which act as front ends to resolvers located in a recursive server in one or more name servers known to perform that service: Local Hosts | Foreign | +---------+ | | | responses | | Stub |<--------------------+ | | Resolver| | | | |----------------+ | | +---------+ recursive | | | queries | | | V | | +---------+ recursive +----------+ | +--------+ | | queries | |queries | | | | Stub |-------------->| Recursive|---------|->|Foreign | | Resolver| | Server | | | Name | | |<--------------| |<--------|--| Server | +---------+ responses | |responses| | | +----------+ | +--------+ | Central | | | cache | | +----------+ | In any case, note that domain components are always replicated for reliability whenever possible. 2.3. Conventions The domain system has several conventions dealing with low-level, but fundamental, issues. While the implementor is free to violate these conventions WITHIN HIS OWN SYSTEM, he must observe these conventions in ALL behavior observed from other hosts. 2.3.1. Preferred name syntax The DNS specifications attempt to be as general as possible in the rules for constructing domain names. The idea is that the name of any existing object can be expressed as a domain name with minimal changes. Mockapetris [Page 7] RFC 1035 Domain Implementation and Specification November 1987 However, when assigning a domain name for an object, the prudent user will select a name which satisfies both the rules of the domain system and any existing rules for the object, whether these rules are published or implied by existing programs. For example, when naming a mail domain, the user should satisfy both the rules of this memo and those in RFC-822. When creating a new host name, the old rules for HOSTS.TXT should be followed. This avoids problems when old software is converted to use domain names. The following syntax will result in fewer problems with many applications that use domain names (e.g., mail, TELNET). ::= | " " ::=