4 This is a brief overview of the newserv modules.
9 This is not actually a module. Instead, this is the code of the "newserv" binary
10 which provides minimal support for loading modules.
12 authext, bans, chanindex, channel, irc, nick, server
13 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 These modules provide basic support for accounts, channels, nicks and server
16 connections. Virtually all other modules depend on at least some of these
22 Implements functionality for creating local users that are "connected" to the
28 Spawns the control user for your newserv instance. The control user provides
29 an IRC-based interface for newserv commands, e.g. to manage loaded modules
30 and modify user accounts.
32 Other modules can register their own commands.
34 You can create a user on your control instance using /msg N hello (where N is
35 the nick of your control instance). You need to be opered in order to use this
38 Once you have an account you should have a look at /msg N showcommands for a
39 list of available commands.
46 #hostname=your.hostname.here
47 #realname=NewServ Control Service
53 Provides commonly-used oper commands.
58 Provides user management commands.
63 Supports sending AC tokens. You should only use this module if you don't have
64 some other form of authentication service on your network (such as Q). This
65 module lets opers use arbitrary account names and IDs.
70 Keeps track of channel ops and can be used to re-op opless channels.
75 This is QuakeNet's channel service (Q). In order to load this module you will
76 need also need to load the pqsql module.
81 Provides support for PostgreSQL database queries.
94 Implements database functionality used by some other modules. In addition to
95 loading the dbapi2 module you will also need to load one of the database
96 provider modules: sqlite-dbapi2 or pqsql-dbapi2
101 Provides a way to spawn fake users.
106 Implements gline commands and general gline functionality that is used by other
112 Provides geo-location services for other modules.
122 This is QuakeNet's G service. It is primarily used on official support channels.
127 This module automatically removes invalid IPv6 bans as these can desync channel
128 modes on snircd 1.3.4a.
133 Provides commands to set, list and remove jupes.
138 Provides support for Lua scripts. For an example of a fairly complex script
139 have a look at the labspace repository at http://hg.quakenet.org/lua-labspace/
144 scriptdir=./luascripts
147 Note: You will need to create the script directory in your newserv
148 installation directory (e.g. "luascripts" in this example) and symlink the
149 lua/lib directory into it.
154 Provides functionality to search for nicks and channels based on certain
160 Implements event-based nicksearch queries.
165 Implements rping and various other status query commands.
170 #admin1=Located at the Union Aerospace Corp. facility, Stroggos
171 #admin2=Network IRC Service
172 #admin3=No administrative info available
177 Implements functionality to spawn trojanscan swarm clones.
184 patricia, patricianick, patriciasearch
185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187 Implements finding nicks based on CIDR prefixes.
192 Does on-connect proxy scans and glines open proxies.
197 This is QuakeNet's channel service request bot (R).
204 #host=request.quakenet.org
205 #real=Service Request v0.23
207 #sserver=spamscan.quakenet.org
209 #qserver=cserve.quakenet.org
214 Implements the serverlist command which shows various information about
215 connected servers (including their network latency).
220 Provides commands to set the network time.
225 Keeps track of servers that were lost during a netsplit. This module is used
226 by chanfix to determine when it shouldn't re-op users.
231 Used to find and gline drones on the network.
236 Implements connection limits. Supports the TRUST protocol which is used
237 by quakenet-iauthd to determine whether to allow users to connect to the
240 You will need to load the trusts_master module on exactly one of your newserv
241 instances. All other instances should load the trusts_slave module in order
242 to receive replication updates from the trusts master:
246 #masterserver=trusts.services.netsplit.net # Only used if master=0
248 In most cases you will also want to load the trusts_management module on
249 your trusts master. This module provides commands to add, modify and delete
252 If you want to enforce connection limits on your network you can use the
253 trusts_policy module:
259 server=gnb.netsplit.net,changeme
260 server=test.gnb.netsplit.net,changeme
262 You can use the QuakeNet IAuth daemon available at
263 http://hg.quakenet.org/iauthd/ to enforce connection limits using IAuth rather
266 whowas, whowas_channels
267 ~~~~~~~~~~~~~~~~~~~~~~
269 Keeps track of historical user records. Used by the glines module to chase
270 nicks and by newsearch.
272 The whowas_channels module optionally keeps track of which channels users
278 Provides replication capabilities. Used by the trusts modules to sync
279 trusts between newserv instances.
284 servicemask=*.services.netsplit.net