[X2serv-cvs] CVS: x2/doc accounting.txt,NONE,1.1 config.txt,NONE,1.1 motd.txt,NONE,1.1 newsfile.txt,NONE,1.1

[Alex S. <ru...@us...>]

Update of /cvsroot/x2serv/x2/doc
In directory usw-pr-cvs1:/tmp/cvs-serv32624

Added Files:
	accounting.txt config.txt motd.txt newsfile.txt 
Log Message:
Documented several of the administration files associated with running X2.


--- NEW FILE ---
The accounting system is a log of all activity done though X2 commands.

It is used both by the X2 administrator to detect abuse and answer questions,
and by the LAST command, which parses the file backwards to find
recent commadns done in a channel.

Commands that contain passwords are masked with ****.

Parsing it with unix tools is very good to learn how to do. For example
with the grep command you can find all IRCOP channel override commands done:

grep "+h" accounting.log|less

or find all DELUSER commands done in #foo:
grep -i "#foo" accounting.log|grep DELUSER|less

posibilities are endless.

The admin should arange for the accounting.log file to be rotated occationally
and archived. it compresses very well.


--- NEW FILE ---
This is supplimental documentation for the x2.conf file.

Each line starts with a KEY, and is followed by a string. lines with #
as the first charactor are ignored.

SERVER - This tells X2 to add a server to its list of servers which it
         can try to connect to.  if more then one server is listed,
         x2 will try them all, and, failing that, listen for a connection.
         Any number of SERVER lines are O.K. (well, 1 or more)

PORT   - This is nolonger used, and can be ignored (will be removed soon)

SERVICE - This is the name of the server X2 will connect as.  This would
          be equivelent to the name in the M: line of the ircd.conf if
          x2 were a normal ircd.

NUMERIC - X2 is P10, and this is the server numeric the service x2 connects
          as should use.  This would be the same as the number at the end
          of the M: line in an ircd.conf.   Every server on the network
          must have a different numeric (1-63).

IRCNICK - This is the nickname of the user that is created to interface
          with your users.

LISTEN - If x2 fails to connect to any servers listed above, it will stop
         and listen for a connection on this port.

CMDCHAR - This is a one charactor prefix to any public commands you want
          x2 to respond to.  It does not support multiple charactors.

HOME   - This is the path to the base x2 installation directory. Here
         should be this file, and chan.dat and the CHANS/ subdir etc.

AUTOROUTING - This is a toggle, 0 for off, 1 for on. Auto-routing is
              if x2 automatically routes the network according to 
              the routing.dat file. Currently this setting is ignored
              and may be removed in the future (routing.dat is followed
              if it contains usefull information)

PINGOUTCONNECT - This is a toggle, 0 for off, 1 for on.  If enabled,
                 x2 will try to re-connect any server which squits 
                 for the reason "ping timeout" back onto the server
                 from which it squit.  It only has effect if
                 the routing.dat file has no information for the
                 server in question.

AUTOCONNECT - This is a toggle, 0 for off, 1 for on.  If enabled, X2 will
              try to connect to a server when you first start it. If off,
              x2 will go right to lisening on the port spesified above
              for an incomming ircd.

MAXCLONES - This is the max number of cloned users from the same hostname
            your willing to tolerate.  Note that 2 users is considered 1
            clone.  3 users is 2 clones, etc.

GATECHECK - This option has 3 settings: 0, 1, and 2.  
            0 - Off, disabled. No gate checking is performed
            1 - Warn, x2 wallops about detected insecure wingates 
            2 - Gline, x2 glines detected insecure wingates.
            The gatecheck system works by opening a connection to port
            1080 on every connecting users IP, and attempting to
            make a connection to a 3rd party, via SOCKS 4 protocol.
            If its successfull, an insecure wingate is detected.
            X2 does this non-blockingly, checking up to 20 connections
            at once, and queuing the rest in a buffer.  Detected
            wingates are logged to a file for later validation and/or
            reporting. 

CLONERES - This is an option with 4 possible settings:
           0 - Off
           1 - Warn, ircops are warned by a wallop about clones
           2 - kill, extra connections are killed by x2 (any above
               the limit)
           3 - Gline, the IP of the cloner is glined for 1 hour.

--- NEW FILE ---
If there exists a file called x2.motd in the main x2 directory,
its contents will be sent as NOTICE to all connecting clients.

The idea is that most people ignore the irc servers motd but
might not ignore one from the service bot. (yet)

The use of this file is discuraged since its annoying as all hell..
but i know some of you will insisnt on having this so here it is.


--- NEW FILE ---
If there exists a file in the X2 home directory called x2.news, 
it will be used as follows. If its missing then the feature is 
disabled.

x2.news:

When x2 starts (or during .rehash) the news file timestamp is retreved.
Then, when an owner or coowner joins a channel, there "last seen" time
is checked. If its before the timestamp on the file, they are shown
the contents of the file.

This is very handy when making changes to x2 that owners should be
aware of (such as upgrading)


BUGS: 
  X2 does NOT show this to people who are already in the channel when
x2 comes on. a .global should be used to fill that gap if necessary.