]> git.netwichtig.de Git - user/henk/code/inspircd.git/commitdiff
Update a number of docs issues
authorDaniel De Graaf <danieldg@inspircd.org>
Wed, 4 Aug 2010 01:37:48 +0000 (21:37 -0400)
committerDaniel De Graaf <danieldg@inspircd.org>
Wed, 4 Aug 2010 01:37:48 +0000 (21:37 -0400)
docs/modules.conf.example
extras/m_sqllog.mssql.sql [deleted file]
extras/m_sqllog.mysql.sql [deleted file]
extras/m_sqllog.postgresql.sql [deleted file]
extras/m_sqllog.sqlite3.sql [deleted file]

index 7975283ee6454429efc38b9686a8e60ad818c92d..eaed5775bca96c28d1bd4ef5f1a928b47da24a6f 100644 (file)
 #  http://wiki.inspircd.org/Modules for a list of modules and         #
 #  each modules link for any additional conf tags they require.       #
 #                                                                     #
-#  You may use wildcards in a <module> 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. Since several features (like SSL server links) rely on      #
-# other modules being loaded before m_spanningtree, the module itself #
-# is at the bottom of this file. DO NOT forget to load it. 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.                                              #
+# module. If you don't do this, server links will NOT work at all.    #
+# This is by design, to allow for the implementation of other linking #
+# protocols in modules in the future.                                 #
 #                                                                     #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # To use, ALLTIME must be in one of your oper class blocks.
 #<module name="m_alltime.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Antibear security module: Prevents 'bear.txt' based trojans from
-# connecting to your network by sending them a numeric they can't handle.
-#<module name="m_antibear.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Antibottler module: Labels bottler leech bots
-#<module name="m_antibottler.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Auditorium module: Adds channel mode +u which makes everyone else
 # except you in the channel invisible, used for large meetings etc.
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Custom prefixes : allows for channel prefixes to be added. 
-# This can replace m_chanprotect and m_halfop, except for interation with services
+# This can replace m_chanprotect and m_halfop, except for services that
+# recognise those modules by name
 #<module name="m_customprefix.so">
 #
 # name       The name of the mode, must be unique from other modes
                cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper password hash module: Allows hashed oper passwords
-# Relies on the module m_md5.so and/or m_sha256.so being loaded before
-# m_password_hash.so in the configuration file.
-# This module is oper-only.
+# Password hash module: Allows hashed passwords to be used.
+# To be useful, a hashing module like m_sha256.so also needs to be loaded.
+# 
 #<module name="m_password_hash.so">
 #
-#-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
+#-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
 #
 # To use this module, you must define a hash type for each oper's
 # password you want to hash. For example:
 #     <oper name="Brain"
 #           host="ident@dialup15.isp.com"
 #           hash="sha256"
-#           password="a41d730937a53b79f788c0ab13e9e1d5"
+#           password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
 #           type="NetAdmin">
 # 
-# 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).
+# Starting from 2.0, you can use a more secure salted hash that prevents simply
+# looking up the hash's value in a rainbow table built for the hash.
+#    hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
+#
+# Generate hashes using the /MKPASSWD command on the server. Don't run it on a
+# server you don't trust with your password.
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Permanent Channels module: Channels with the permanent channels mode
 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
 # If you want to do this, set the filename below, and uncomment the include.
 #
-#<permchanneldb filename="conf/permchannels.conf">
-#<include file="permchannels.conf">
+#<permchanneldb filename="data/permchannels.conf">
+#<include file="data/permchannels.conf">
 #
 # You may also create channels on startup by using the <permchannels> block.
-#<permchannels channel="#opers" modes="is" topic="Opers only.">
+# Don't forget to set them +P in the modes, or they won't stay permanent.
+#<permchannels channel="#opers" modes="isP" topic="Opers only.">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
 #
 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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
-# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
-# and run make install, then uncomment this module to enable it.
-#
-#<module name="m_sqlutils.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SQL authentication module: Allows IRCd connections to be tied into
 # a database table (for example a forum). You must copy the source for
 # m_sqlauth.so is too complex it describe here, see the wiki:         #
 # http://wiki.inspircd.org/Modules/sqlauth                            #
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SQL logging module: Allows you to log network-wide data for your
-# network in a fully normalised set of SQL tables. You must copy the
-# source for this module from the directory src/modules/extra
-# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
-# and run make install, then uncomment this module to enable it.
-#
-#<module name="m_sqllog.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# dbid       - Database ID to use (see m_sql)                         #
-#                                                                     #
-# See also: http://wiki.inspircd.org/Modules/sqllog                   #
-#                                                                     #
-#<sqllog dbid="1">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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
 # be a lot less bans to apply - as most of them will already be there.
 #<module name="m_xline_db.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# ZipLinks module: Adds support for zlib deflate on server to server
-# connections. Both ends of the connection must load this module.
-# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
-# and run make install, then uncomment this module to enable it.
-#
-#<module name="m_ziplink.so">
-#
-# To use this module, you must enable it as a ssl type in your
-# <link> tags or <bind> tags using the ssl name 'ziplinks'.
-# See the documentation of <link> and <bind>, respectively.
-#
-
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #    ____                _   _____ _     _       ____  _ _   _        #
 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 #                                                                     #
 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
-# module. Since several features (like SSL server links) rely on      #
-# other modules being loaded before m_spanningtree, the module itself #
-# is at the bottom of this file. DO NOT forget to load it. 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.                                              #
+# module. If you don't do this, server links will NOT work at all.    #
+# This is by design, to allow for the implementation of other linking #
+# protocols in modules in the future.                                 #
 #                                                                     #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
diff --git a/extras/m_sqllog.mssql.sql b/extras/m_sqllog.mssql.sql
deleted file mode 100644 (file)
index 25882dc..0000000
+++ /dev/null
@@ -1,42 +0,0 @@
-CREATE TABLE [dbo].[ircd_log] (\r
-  [id] int IDENTITY(1, 1) NOT NULL,\r
-  [category_id] int DEFAULT 0 NOT NULL,\r
-  [nick] int NULL,\r
-  [host] int NULL,\r
-  [source] int NULL,\r
-  [dtime] int DEFAULT 0 NOT NULL,\r
-  PRIMARY KEY CLUSTERED ([id])\r
-)\r
-\r
-\r
-CREATE TABLE [dbo].[ircd_log_categories] (\r
-  [category_id] int DEFAULT 0 NOT NULL,\r
-  [category] varchar(255) NOT NULL,\r
-  PRIMARY KEY CLUSTERED ([category_id])\r
-)\r
-\r
-\r
-/* Data for the `dbo.ircd_log_categories` table  (Records 1 - 8) */\r
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (1, N'Oper')\r
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (2, N'Kill')\r
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (3, N'Server Link')\r
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (4, N'G/Z/K/E Line')\r
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (5, N'Connect')\r
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (6, N'Disconnect')\r
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (7, N'Flooding')\r
-INSERT INTO [dbo].[ircd_log_categories] ([category_id], [category]) VALUES (8, N'Load Module')\r
-\r
-\r
-CREATE TABLE [dbo].[ircd_log_actors] (\r
-  [id] int IDENTITY(1, 1) NOT NULL,\r
-  [actor] varchar(255) NULL,\r
-  PRIMARY KEY CLUSTERED ([id])\r
-)\r
-\r
-\r
-CREATE TABLE [dbo].[ircd_log_hosts] (\r
-  [id] int IDENTITY(1, 1) NOT NULL,\r
-  [hostname] varchar(255) NULL,\r
-  PRIMARY KEY CLUSTERED ([id])\r
-)\r
-\r
diff --git a/extras/m_sqllog.mysql.sql b/extras/m_sqllog.mysql.sql
deleted file mode 100644 (file)
index 0793b05..0000000
+++ /dev/null
@@ -1,78 +0,0 @@
--- MySQL dump 9.11
---
--- Host: localhost    Database: brain
--- ------------------------------------------------------
--- Server version      4.0.20
-
---
--- Table structure for table `ircd_log`
---
-
-CREATE TABLE ircd_log (
-  id bigint(20) NOT NULL auto_increment,
-  category_id bigint(20) NOT NULL default '0',
-  nick bigint(20) default NULL,
-  host bigint(20) default NULL,
-  source bigint(20) default NULL,
-  dtime bigint(20) NOT NULL default '0',
-  PRIMARY KEY  (id)
-) TYPE=MyISAM;
-
---
--- Dumping data for table `ircd_log`
---
-
-
---
--- Table structure for table `ircd_log_categories`
---
-
-CREATE TABLE ircd_log_categories (
-  category_id bigint(20) NOT NULL default '0',
-  category text NOT NULL,
-  PRIMARY KEY  (category_id)
-) TYPE=MyISAM;
-
---
--- Dumping data for table `ircd_log_categories`
---
-
-INSERT INTO ircd_log_categories VALUES (1,'Oper');
-INSERT INTO ircd_log_categories VALUES (2,'Kill');
-INSERT INTO ircd_log_categories VALUES (3,'Server Link');
-INSERT INTO ircd_log_categories VALUES (4,'G/Z/K/E Line');
-INSERT INTO ircd_log_categories VALUES (5,'Connect');
-INSERT INTO ircd_log_categories VALUES (6,'Disconnect');
-INSERT INTO ircd_log_categories VALUES (7,'Flooding');
-INSERT INTO ircd_log_categories VALUES (8,'Load Module');
-
---
--- Table structure for table `ircd_log_actors`
---
-
-CREATE TABLE ircd_log_actors (
-  id bigint(20) NOT NULL auto_increment,
-  actor text,
-  PRIMARY KEY  (id)
-) TYPE=MyISAM;
-
---
--- Dumping data for table `ircd_log_actors`
---
-
-
---
--- Table structure for table `ircd_log_hosts`
---
-
-CREATE TABLE ircd_log_hosts (
-  id bigint(20) NOT NULL auto_increment,
-  hostname text,
-  PRIMARY KEY  (id)
-) TYPE=MyISAM;
-
---
--- Dumping data for table `ircd_log_hosts`
---
-
-
diff --git a/extras/m_sqllog.postgresql.sql b/extras/m_sqllog.postgresql.sql
deleted file mode 100644 (file)
index 2e40dd9..0000000
+++ /dev/null
@@ -1,51 +0,0 @@
---
--- PostgreSQL database dump
---
-
-CREATE TABLE ircd_log (
-    id serial NOT NULL,
-    category_id bigint,
-    nick bigint,
-    host bigint,
-    source bigint,
-    dtime bigint DEFAULT 0 NOT NULL
-);
-ALTER TABLE ONLY ircd_log
-    ADD CONSTRAINT ircd_log_pkey PRIMARY KEY (id);
-
-
-
-CREATE TABLE ircd_log_actors (
-    id serial NOT NULL,
-    actor text
-);
-ALTER TABLE ONLY ircd_log_actors
-    ADD CONSTRAINT ircd_log_actors_pkey PRIMARY KEY (id);
-
-
-
-CREATE TABLE ircd_log_categories (
-    category_id serial NOT NULL,
-    category text NOT NULL
-);
-
-INSERT INTO ircd_log_categories VALUES (1, 'Oper');
-INSERT INTO ircd_log_categories VALUES (2, 'Kill');
-INSERT INTO ircd_log_categories VALUES (3, 'Server Link');
-INSERT INTO ircd_log_categories VALUES (4, 'G/Z/K/E Line');
-INSERT INTO ircd_log_categories VALUES (5, 'Connect');
-INSERT INTO ircd_log_categories VALUES (6, 'Disconnect');
-INSERT INTO ircd_log_categories VALUES (7, 'Flooding');
-INSERT INTO ircd_log_categories VALUES (8, 'Load Module');
-
-ALTER TABLE ONLY ircd_log_categories
-    ADD CONSTRAINT ircd_log_categories_pkey PRIMARY KEY (category_id);
-
-
-
-CREATE TABLE ircd_log_hosts (
-    id serial NOT NULL,
-    hostname text
-);
-ALTER TABLE ONLY ircd_log_hosts
-    ADD CONSTRAINT ircd_log_hosts_pkey PRIMARY KEY (id);
diff --git a/extras/m_sqllog.sqlite3.sql b/extras/m_sqllog.sqlite3.sql
deleted file mode 100644 (file)
index a0772e5..0000000
+++ /dev/null
@@ -1,34 +0,0 @@
-CREATE TABLE ircd_log (
-id integer primary key,
-category_id integer,
-nick integer,
-host integer,
-source integer,
-dtime integer);
-
-
-CREATE TABLE ircd_log_categories (
-  category_id integer primary key,
-  category text NOT NULL
-);
-INSERT INTO "ircd_log_categories" VALUES(1, 'Oper');
-INSERT INTO "ircd_log_categories" VALUES(2, 'Kill');
-INSERT INTO "ircd_log_categories" VALUES(3, 'Server Link');
-INSERT INTO "ircd_log_categories" VALUES(4, 'G/Z/K/E Line');
-INSERT INTO "ircd_log_categories" VALUES(5, 'Connect');
-INSERT INTO "ircd_log_categories" VALUES(6, 'Disconnect');
-INSERT INTO "ircd_log_categories" VALUES(7, 'Flooding');
-INSERT INTO "ircd_log_categories" VALUES(8, 'Load Module');
-
-
-CREATE TABLE ircd_log_actors (
-  id integer primary key,
-  actor text
-);
-
-
-CREATE TABLE ircd_log_hosts (
-  id integer primary key,
-  hostname text
-);
-