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.
39 #hostname=your.hostname.here
40 #realname=newserv Control Service
46 Provides commonly-used oper commands.
51 Provides user management commands.
56 Supports sending AC tokens. You should only use this module if you don't have
57 some other form of authentication service on your network (such as Q). This
58 module lets opers use arbitrary account names and IDs.
63 Keeps track of channel ops and can be used to re-op opless channels.
68 This is QuakeNet's channel service (Q). In order to load this module you will
69 need also need to load the pqsql module.
74 Provides support for PostgreSQL database queries.
87 Implements database functionality used by some other modules. In addition to
88 loading the dbapi2 module you will also need to load one of the database
89 provider modules: sqlite-dbapi2 or pqsql-dbapi2
94 Provides a way to spawn fake users.
99 Implements gline commands and general gline functionality that is used by other
105 Provides geo-location services for other modules.
115 This is QuakeNet's G service. It is primarily used on official support channels.
120 This module automatically removes invalid IPv6 bans as these can desync channel
121 modes on snircd 1.3.4a.
126 Provides commands to set, list and remove jupes.
131 Provides support for Lua scripts. For an example of a fairly complex script
132 have a look at the labspace repository at http://hg.quakenet.org/lua-labspace/
137 scriptdir=./luascripts
140 Note: You will need to create the script directory in your newserv
141 installation directory (e.g. "luascripts" in this example) and symlink the
142 lua/lib directory into it.
147 Provides functionality to search for nicks and channels based on certain
153 Implements event-based nicksearch queries.
158 Implements rping and various other status query commands.
163 #admin1=Located at the Union Aerospace Corp. facility, Stroggos
164 #admin2=Network IRC Service
165 #admin3=No administrative info available
170 Implements functionality to spawn trojanscan swarm clones.
177 patricia, patricianick, patriciasearch
178 --------------------------------------
180 Implements finding nicks based on CIDR prefixes.
185 Does on-connect proxy scans and glines open proxies.
190 This is QuakeNet's channel service request bot (R).
197 #host=request.quakenet.org
198 #real=Service Request v0.23
200 #sserver=spamscan.quakenet.org
202 #qserver=cserve.quakenet.org
207 Implements the serverlist command which shows various information about
208 connected servers (including their network latency).
213 Provides commands to set the network time.
218 Keeps track of servers that were lost during a netsplit. This module is used
219 by chanfix to determine when it shouldn't re-op users.
224 Used to find and gline drones on the network.
229 Implements connection limits. Supports the TRUST protocol which is used
230 by quakenet-iauthd to determine whether to allow users to connect to the
233 You will need to load the trusts_master module on exactly one of your newserv
234 instances. All other instances should load the trusts_slave module in order
235 to receive replication updates from the trusts master:
239 #masterserver=trusts.services.netsplit.net # Only used if master=0
241 In most cases you will also want to load the trusts_management module on
242 your trusts master. This module provides commands to add, modify and delete
245 If you want to enforce connection limits on your network you can use the
246 trusts_policy module:
252 server=gnb.netsplit.net,changeme
253 server=test.gnb.netsplit.net,changeme
255 You can use the QuakeNet IAuth daemon available at
256 http://hg.quakenet.org/iauthd/ to enforce connection limits using IAuth rather
259 whowas, whowas_channels
260 -----------------------
262 Keeps track of historical user records. Used by the glines module to chase
263 nicks and by newsearch.
265 The whowas_channels module optionally keeps track of which channels users
271 Provides newserv<->newserv communication capabilities. Used by the trusts
272 modules to sync trusts between newserv instances.
277 servicemask=*.services.netsplit.net