Browse Source

Update a number of docs issues

Daniel De Graaf 8 years ago
parent
commit
6b8f8eb33e

+ 23
- 83
docs/modules.conf.example View File

@@ -13,10 +13,6 @@
13 13
 #  http://wiki.inspircd.org/Modules for a list of modules and         #
14 14
 #  each modules link for any additional conf tags they require.       #
15 15
 #                                                                     #
16
-#  You may use wildcards in a <module> tag to load all modules which  #
17
-#  match a glob pattern (e.g. m_sa????.so would load m_sajoin,        #
18
-#  m_sapart, m_saquit and m_sanick)                                   #
19
-#                                                                     #
20 16
 #    ____                _   _____ _     _       ____  _ _   _        #
21 17
 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
22 18
 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
@@ -24,13 +20,9 @@
24 20
 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
25 21
 #                                                                     #
26 22
 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
27
-# module. Since several features (like SSL server links) rely on      #
28
-# other modules being loaded before m_spanningtree, the module itself #
29
-# is at the bottom of this file. DO NOT forget to load it. If you DO  #
30
-# NOT do this, server links will NOT work at all. ie. The ports will  #
31
-# NOT bind, and /connect will not work properly. This is by design,   #
32
-# to allow for the implementation of other linking protocols in       #
33
-# modules in the future.                                              #
23
+# module. If you don't do this, server links will NOT work at all.    #
24
+# This is by design, to allow for the implementation of other linking #
25
+# protocols in modules in the future.                                 #
34 26
 #                                                                     #
35 27
 
36 28
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -202,15 +194,6 @@
202 194
 #<module name="m_alltime.so">
203 195
 
204 196
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
205
-# Antibear security module: Prevents 'bear.txt' based trojans from
206
-# connecting to your network by sending them a numeric they can't handle.
207
-#<module name="m_antibear.so">
208
-
209
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
210
-# Antibottler module: Labels bottler leech bots
211
-#<module name="m_antibottler.so">
212
-
213
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
214 197
 # Auditorium module: Adds channel mode +u which makes everyone else
215 198
 # except you in the channel invisible, used for large meetings etc.
216 199
 #<module name="m_auditorium.so">
@@ -632,7 +615,8 @@
632 615
 
633 616
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
634 617
 # Custom prefixes : allows for channel prefixes to be added. 
635
-# This can replace m_chanprotect and m_halfop, except for interation with services
618
+# This can replace m_chanprotect and m_halfop, except for services that
619
+# recognise those modules by name
636 620
 #<module name="m_customprefix.so">
637 621
 #
638 622
 # name       The name of the mode, must be unique from other modes
@@ -1275,13 +1259,12 @@
1275 1259
 		cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1276 1260
 
1277 1261
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1278
-# Oper password hash module: Allows hashed oper passwords
1279
-# Relies on the module m_md5.so and/or m_sha256.so being loaded before
1280
-# m_password_hash.so in the configuration file.
1281
-# This module is oper-only.
1262
+# Password hash module: Allows hashed passwords to be used.
1263
+# To be useful, a hashing module like m_sha256.so also needs to be loaded.
1264
+# 
1282 1265
 #<module name="m_password_hash.so">
1283 1266
 #
1284
-#-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1267
+#-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1285 1268
 #
1286 1269
 # To use this module, you must define a hash type for each oper's
1287 1270
 # password you want to hash. For example:
@@ -1289,13 +1272,15 @@
1289 1272
 #     <oper name="Brain"
1290 1273
 #           host="ident@dialup15.isp.com"
1291 1274
 #           hash="sha256"
1292
-#           password="a41d730937a53b79f788c0ab13e9e1d5"
1275
+#           password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1293 1276
 #           type="NetAdmin">
1294 1277
 # 
1295
-# The types of hashing available vary depending on which hashing modules
1296
-# you load, but usually if you load m_sha256.so and m_md5.so, both md5
1297
-# and sha256 type hashing will be available (the most secure of which
1298
-# is SHA256).
1278
+# Starting from 2.0, you can use a more secure salted hash that prevents simply
1279
+# looking up the hash's value in a rainbow table built for the hash.
1280
+#    hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1281
+#
1282
+# Generate hashes using the /MKPASSWD command on the server. Don't run it on a
1283
+# server you don't trust with your password.
1299 1284
 
1300 1285
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1301 1286
 # Permanent Channels module: Channels with the permanent channels mode
@@ -1310,11 +1295,12 @@
1310 1295
 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1311 1296
 # If you want to do this, set the filename below, and uncomment the include.
1312 1297
 #
1313
-#<permchanneldb filename="conf/permchannels.conf">
1314
-#<include file="permchannels.conf">
1298
+#<permchanneldb filename="data/permchannels.conf">
1299
+#<include file="data/permchannels.conf">
1315 1300
 #
1316 1301
 # You may also create channels on startup by using the <permchannels> block.
1317
-#<permchannels channel="#opers" modes="is" topic="Opers only.">
1302
+# Don't forget to set them +P in the modes, or they won't stay permanent.
1303
+#<permchannels channel="#opers" modes="isP" topic="Opers only.">
1318 1304
 
1319 1305
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1320 1306
 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
@@ -1679,17 +1665,6 @@
1679 1665
 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1680 1666
 
1681 1667
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1682
-# SQLutils module: Provides some utilities to SQL client modules, such
1683
-# as mapping queries to users and channels. You must copy the source
1684
-# for this module from the directory src/modules/extra/m_sqlutils.cpp
1685
-# and src/modules/extra/m_sqlutils.h into /src/modules
1686
-# Needed for, and loaded before: SQLauth and SQLoper
1687
-# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1688
-# and run make install, then uncomment this module to enable it.
1689
-#
1690
-#<module name="m_sqlutils.so">
1691
-
1692
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1693 1668
 # SQL authentication module: Allows IRCd connections to be tied into
1694 1669
 # a database table (for example a forum). You must copy the source for
1695 1670
 # this module from the directory src/modules/extra
@@ -1705,23 +1680,6 @@
1705 1680
 # http://wiki.inspircd.org/Modules/sqlauth                            #
1706 1681
 
1707 1682
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1708
-# SQL logging module: Allows you to log network-wide data for your
1709
-# network in a fully normalised set of SQL tables. You must copy the
1710
-# source for this module from the directory src/modules/extra
1711
-# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1712
-# and run make install, then uncomment this module to enable it.
1713
-#
1714
-#<module name="m_sqllog.so">
1715
-#
1716
-#-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1717
-#                                                                     #
1718
-# dbid       - Database ID to use (see m_sql)                         #
1719
-#                                                                     #
1720
-# See also: http://wiki.inspircd.org/Modules/sqllog                   #
1721
-#                                                                     #
1722
-#<sqllog dbid="1">
1723
-
1724
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1725 1683
 # SQL oper module: Allows you to store oper credentials in an SQL table
1726 1684
 # You must copy the source for this module from the directory src/modules/extra
1727 1685
 # Depends on the SQLutils module being loaded first.
@@ -1826,20 +1784,6 @@
1826 1784
 #<module name="m_xline_db.so">
1827 1785
 
1828 1786
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1829
-# ZipLinks module: Adds support for zlib deflate on server to server
1830
-# connections. Both ends of the connection must load this module.
1831
-# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1832
-# and run make install, then uncomment this module to enable it.
1833
-#
1834
-#<module name="m_ziplink.so">
1835
-#
1836
-# To use this module, you must enable it as a ssl type in your
1837
-# <link> tags or <bind> tags using the ssl name 'ziplinks'.
1838
-# See the documentation of <link> and <bind>, respectively.
1839
-#
1840
-
1841
-
1842
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1843 1787
 #    ____                _   _____ _     _       ____  _ _   _        #
1844 1788
 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
1845 1789
 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
@@ -1847,13 +1791,9 @@
1847 1791
 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
1848 1792
 #                                                                     #
1849 1793
 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
1850
-# module. Since several features (like SSL server links) rely on      #
1851
-# other modules being loaded before m_spanningtree, the module itself #
1852
-# is at the bottom of this file. DO NOT forget to load it. If you DO  #
1853
-# NOT do this, server links will NOT work at all. ie. The ports will  #
1854
-# NOT bind, and /connect will not work properly. This is by design,   #
1855
-# to allow for the implementation of other linking protocols in       #
1856
-# modules in the future.                                              #
1794
+# module. If you don't do this, server links will NOT work at all.    #
1795
+# This is by design, to allow for the implementation of other linking #
1796
+# protocols in modules in the future.                                 #
1857 1797
 #                                                                     #
1858 1798
 
1859 1799
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#

+ 0
- 42
extras/m_sqllog.mssql.sql View File

@@ -1,42 +0,0 @@
1
-CREATE TABLE [dbo].[ircd_log] (
2
-  [id] int IDENTITY(1, 1) NOT NULL,
3
-  [category_id] int DEFAULT 0 NOT NULL,
4
-  [nick] int NULL,
5
-  [host] int NULL,
6
-  [source] int NULL,
7
-  [dtime] int DEFAULT 0 NOT NULL,
8
-  PRIMARY KEY CLUSTERED ([id])
9
-)
10
-
11
-
12
-CREATE TABLE [dbo].[ircd_log_categories] (
13
-  [category_id] int DEFAULT 0 NOT NULL,
14
-  [category] varchar(255) NOT NULL,
15
-  PRIMARY KEY CLUSTERED ([category_id])
16
-)
17
-
18
-
19
-/* Data for the `dbo.ircd_log_categories` table  (Records 1 - 8) */
20
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (1, N'Oper')
21
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (2, N'Kill')
22
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (3, N'Server Link')
23
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (4, N'G/Z/K/E Line')
24
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (5, N'Connect')
25
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (6, N'Disconnect')
26
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (7, N'Flooding')
27
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (8, N'Load Module')
28
-
29
-
30
-CREATE TABLE [dbo].[ircd_log_actors] (
31
-  [id] int IDENTITY(1, 1) NOT NULL,
32
-  [actor] varchar(255) NULL,
33
-  PRIMARY KEY CLUSTERED ([id])
34
-)
35
-
36
-
37
-CREATE TABLE [dbo].[ircd_log_hosts] (
38
-  [id] int IDENTITY(1, 1) NOT NULL,
39
-  [hostname] varchar(255) NULL,
40
-  PRIMARY KEY CLUSTERED ([id])
41
-)
42
-

+ 0
- 66
extras/m_sqllog.mysql.sql View File

@@ -1,78 +0,0 @@
1
---
2
-
3
---
4
---
5
-
6
-CREATE TABLE ircd_log (
7
-  id bigint(20) NOT NULL auto_increment,
8
-  category_id bigint(20) NOT NULL default '0',
9
-  nick bigint(20) default NULL,
10
-  host bigint(20) default NULL,
11
-  source bigint(20) default NULL,
12
-  dtime bigint(20) NOT NULL default '0',
13
-  PRIMARY KEY  (id)
14
-) TYPE=MyISAM;
15
-
16
---
17
---
18
-
19
-
20
---
21
---
22
-
23
-CREATE TABLE ircd_log_categories (
24
-  category_id bigint(20) NOT NULL default '0',
25
-  category text NOT NULL,
26
-  PRIMARY KEY  (category_id)
27
-) TYPE=MyISAM;
28
-
29
---
30
---
31
-
32
-INSERT INTO ircd_log_categories VALUES (1,'Oper');
33
-INSERT INTO ircd_log_categories VALUES (2,'Kill');
34
-INSERT INTO ircd_log_categories VALUES (3,'Server Link');
35
-INSERT INTO ircd_log_categories VALUES (4,'G/Z/K/E Line');
36
-INSERT INTO ircd_log_categories VALUES (5,'Connect');
37
-INSERT INTO ircd_log_categories VALUES (6,'Disconnect');
38
-INSERT INTO ircd_log_categories VALUES (7,'Flooding');
39
-INSERT INTO ircd_log_categories VALUES (8,'Load Module');
40
-
41
---
42
---
43
-
44
-CREATE TABLE ircd_log_actors (
45
-  id bigint(20) NOT NULL auto_increment,
46
-  actor text,
47
-  PRIMARY KEY  (id)
48
-) TYPE=MyISAM;
49
-
50
---
51
---
52
-
53
-
54
---
55
---
56
-
57
-CREATE TABLE ircd_log_hosts (
58
-  id bigint(20) NOT NULL auto_increment,
59
-  hostname text,
60
-  PRIMARY KEY  (id)
61
-) TYPE=MyISAM;
62
-
63
---
64
---
65
-
66
-

+ 0
- 50
extras/m_sqllog.postgresql.sql View File

@@ -1,51 +0,0 @@
1
---
2
---
3
-
4
-CREATE TABLE ircd_log (
5
-    id serial NOT NULL,
6
-    category_id bigint,
7
-    nick bigint,
8
-    host bigint,
9
-    source bigint,
10
-    dtime bigint DEFAULT 0 NOT NULL
11
-);
12
-ALTER TABLE ONLY ircd_log
13
-    ADD CONSTRAINT ircd_log_pkey PRIMARY KEY (id);
14
-
15
-
16
-
17
-CREATE TABLE ircd_log_actors (
18
-    id serial NOT NULL,
19
-    actor text
20
-);
21
-ALTER TABLE ONLY ircd_log_actors
22
-    ADD CONSTRAINT ircd_log_actors_pkey PRIMARY KEY (id);
23
-
24
-
25
-
26
-CREATE TABLE ircd_log_categories (
27
-    category_id serial NOT NULL,
28
-    category text NOT NULL
29
-);
30
-
31
-INSERT INTO ircd_log_categories VALUES (1, 'Oper');
32
-INSERT INTO ircd_log_categories VALUES (2, 'Kill');
33
-INSERT INTO ircd_log_categories VALUES (3, 'Server Link');
34
-INSERT INTO ircd_log_categories VALUES (4, 'G/Z/K/E Line');
35
-INSERT INTO ircd_log_categories VALUES (5, 'Connect');
36
-INSERT INTO ircd_log_categories VALUES (6, 'Disconnect');
37
-INSERT INTO ircd_log_categories VALUES (7, 'Flooding');
38
-INSERT INTO ircd_log_categories VALUES (8, 'Load Module');
39
-
40
-ALTER TABLE ONLY ircd_log_categories
41
-    ADD CONSTRAINT ircd_log_categories_pkey PRIMARY KEY (category_id);
42
-
43
-
44
-
45
-CREATE TABLE ircd_log_hosts (
46
-    id serial NOT NULL,
47
-    hostname text
48
-);
49
-ALTER TABLE ONLY ircd_log_hosts
50
-    ADD CONSTRAINT ircd_log_hosts_pkey PRIMARY KEY (id);

+ 0
- 34
extras/m_sqllog.sqlite3.sql View File

@@ -1,34 +0,0 @@
1
-CREATE TABLE ircd_log (
2
-id integer primary key,
3
-category_id integer,
4
-nick integer,
5
-host integer,
6
-source integer,
7
-dtime integer);
8
-
9
-
10
-CREATE TABLE ircd_log_categories (
11
-  category_id integer primary key,
12
-  category text NOT NULL
13
-);
14
-INSERT INTO "ircd_log_categories" VALUES(1, 'Oper');
15
-INSERT INTO "ircd_log_categories" VALUES(2, 'Kill');
16
-INSERT INTO "ircd_log_categories" VALUES(3, 'Server Link');
17
-INSERT INTO "ircd_log_categories" VALUES(4, 'G/Z/K/E Line');
18
-INSERT INTO "ircd_log_categories" VALUES(5, 'Connect');
19
-INSERT INTO "ircd_log_categories" VALUES(6, 'Disconnect');
20
-INSERT INTO "ircd_log_categories" VALUES(7, 'Flooding');
21
-INSERT INTO "ircd_log_categories" VALUES(8, 'Load Module');
22
-
23
-
24
-CREATE TABLE ircd_log_actors (
25
-  id integer primary key,
26
-  actor text
27
-);
28
-
29
-
30
-CREATE TABLE ircd_log_hosts (
31
-  id integer primary key,
32
-  hostname text
33
-);
34
-