/usr/share/doc/dancer-ircd/dancer-oper-guide.html/configlines.htm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Specific lines</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Operators guide for the dancer IRC server"
HREF="index.htm"><LINK
REL="UP"
TITLE="Server config file format"
HREF="config.htm"><LINK
REL="PREVIOUS"
TITLE="Server config file format"
HREF="config.htm"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Operators guide for the dancer IRC server</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="config.htm"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 5. Server config file format</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
>&nbsp;</TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="CONFIGLINES"
>5.2. Specific lines</A
></H1
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN867"
>5.2.1. M:line</A
></H2
><PRE
CLASS="SYNOPSIS"
>M:<TT
CLASS="REPLACEABLE"
><I
>server name</I
></TT
>:[<SPAN
CLASS="OPTIONAL"
><TT
CLASS="REPLACEABLE"
><I
>bind address</I
></TT
></SPAN
>]:<TT
CLASS="REPLACEABLE"
><I
>description</I
></TT
></PRE
><P
>	  the name the server will claim to be to clients and to other servers, and usually is chosen to
	  be something that resolves to the server's IP address. The text description is sent out in
	  LINKS and when clients connect.
	</P
><P
>	  The optional bind address is which interface to bind to/send from when making outgoing connections.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN876"
>5.2.2. A:line</A
></H2
><PRE
CLASS="SYNOPSIS"
>A:<TT
CLASS="REPLACEABLE"
><I
>text</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>text</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>text</I
></TT
></PRE
><P
>	  This line should contain exactly three text fields, which can contain any arbitrary text. It is
	  returned by the ADMIN command. It is suggested that it contains the name of the organisation
	  running the IRC <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>network</I
></SPAN
>, and a means to contact the network/server administrator
	  (probably email).
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN884"
>5.2.3. Y:line</A
></H2
><PRE
CLASS="SYNOPSIS"
>Y:<TT
CLASS="REPLACEABLE"
><I
>class</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>ping frequency</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>connect frequency</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>maximum links</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>sendq size</I
></TT
></PRE
><P
>	  Y:lines define classes of connections for later use. The class number is used to connect them to
	  other lines in the config file.
	</P
><P
>	  All fields are integers. The <TT
CLASS="REPLACEABLE"
><I
>class</I
></TT
> field must be a value greater than
	  zero, and must uniquely identify the connection class within the config. The rate at which things
	  in this connection are pinged to see if their connection is still alive is controlled by the
	  second field.
	</P
><P
>	  <TT
CLASS="REPLACEABLE"
><I
>connect frequency</I
></TT
> for a server connection is the time in seconds this server will
	  wait before attempting to make a connection (if autoconnect is allowed). If the connect frequency is 0 then
	  only one connection will be attempted, at server startup. For a client class, this is the number of 
	  connections which will be allowed from the same originating IP address, or 0 for no limit.
	</P
><P
>	  sendq is the size in bytes of the queue which holds messages awaiting delivery to the target. For
	  clients a few hundred thousand bytes is adequete; for servers at least 4Mb is recommended.
	</P
><P
>	  When picking a server to connect to, the ircd will try higher connection classes first, unless
	  they are waiting for the "connect frequency" time to elapse before trying again.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN899"
>5.2.4. I:line</A
></H2
><PRE
CLASS="SYNOPSIS"
>I:[<SPAN
CLASS="OPTIONAL"
><TT
CLASS="REPLACEABLE"
><I
>spoof host</I
></TT
></SPAN
>]:[<SPAN
CLASS="OPTIONAL"
><TT
CLASS="REPLACEABLE"
><I
>password</I
></TT
></SPAN
>]:<TT
CLASS="REPLACEABLE"
><I
>domain mask</I
></TT
>::<TT
CLASS="REPLACEABLE"
><I
>connection class</I
></TT
></PRE
><P
>	  I:lines allow client connections to the server, and control/set various flags about those connections.
	</P
><P
>          The spoof host is used if the = flag is specified.
	</P
><P
>	  If a password is given, then it must be used at connection time or the connection will be
	  dropped, without checking any other I:lines.
	</P
><P
>	  The domain mask matches may (and usually does) contain wildcards. The domain mask may have
	  several prefixes which affect the client connection. They are:
	  <P
></P
><UL
><LI
><P
>		-  Don't prefix a ~ to the username if the ident check fails.
	      </P
></LI
><LI
><P
>		+  Require ident check to succeed to connect.
	      </P
></LI
><LI
><P
>		!  Only allow n connections (as defined in the Y:line) per IP address, not per hostmask.
	      </P
></LI
><LI
><P
>		^  Exempt from K/G lines. Partially exempt from D lines.
	      </P
></LI
><LI
><P
>		&#38;  Will not be killed by the bot check.
	      </P
></LI
><LI
><P
>		&#62;  Exempt from connection limits.
	      </P
></LI
><LI
><P
>		=  The IP mask field contains the hostname to spoof to.
	      </P
></LI
><LI
><P
>		/  Spoof the hostname automatically on connect.
	      </P
></LI
></UL
>
	</P
><P
>	  If no = flag is given, then SPOOF_LIMIT_HOST in config.h will be used as the hostname to spoof
	  to, if any.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN930"
>5.2.5. O:line</A
></H2
><PRE
CLASS="SYNOPSIS"
>O:<TT
CLASS="REPLACEABLE"
><I
>hostname</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>password</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>nick</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>allowed umodes</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>connection class</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>default umodes</I
></TT
></PRE
><P
>	  O:lines define who may use the OPER command to gain extended privileges.
	</P
><P
>	  The hostname may be a mask, and must match for an OPER command to work.
	  The password may be encrypted as an MD5 hash, depending on compile-time configuration.
	</P
><P
>	  Dancer uses a very different system than most ircds. Rather than a capabilities field, it has
	  a field which contains the list of umodes an oper may have. This allows for very fine control
	  of what a person can and can't do.
	</P
><P
>	  When an OPER command succeeds, the user will be moved into the connection class specified
	  in the O:line, and they will have all the umodes in the "default umodes" field set.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN943"
>5.2.6. C/N:lines</A
></H2
><PRE
CLASS="SYNOPSIS"
>C:<TT
CLASS="REPLACEABLE"
><I
>hostname</I
></TT
>:[<SPAN
CLASS="OPTIONAL"
><TT
CLASS="REPLACEABLE"
><I
>password</I
></TT
></SPAN
>]:<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>:[<SPAN
CLASS="OPTIONAL"
><TT
CLASS="REPLACEABLE"
><I
>port</I
></TT
></SPAN
>]:<TT
CLASS="REPLACEABLE"
><I
>connection class</I
></TT
></PRE
><PRE
CLASS="SYNOPSIS"
>N:<TT
CLASS="REPLACEABLE"
><I
>hostname</I
></TT
>:[<SPAN
CLASS="OPTIONAL"
><TT
CLASS="REPLACEABLE"
><I
>password</I
></TT
></SPAN
>]:<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>::<TT
CLASS="REPLACEABLE"
><I
>connection class</I
></TT
>[<SPAN
CLASS="OPTIONAL"
>:</SPAN
>]</PRE
><P
>	  These always appear in matched pairs, and define what servers may connect or be connected to.
	</P
><P
>	  The hostname must match that of the remote server. The cleartext password in the C:line on one
	  side of a link must match the (possibly hashed) password in the N:line on the other side. The
	  name must match that given in the first field of the M:line on the remote server.
	</P
><P
>	  If a port is given in the C:line, a connection will be automatically attempted according to the
	  connection class, on startup, and at regular intervals when a server is not connected.
	</P
><P
>	  In order for a server to be listed in the LINKS response, it must have an N:line (it need not
	  have a C:line, nor need there be a valid password in the N:line).  <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>If the last (6th
	  field) is present (ie: trailing colon after connection class), then the server will not be
	  listed in LINKS.</I
></SPAN
> This allows you to have locally connected servers which are not
	  listed, and listed servers which are not locally connected.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN965"
>5.2.7. K:line</A
></H2
><PRE
CLASS="SYNOPSIS"
>K:<TT
CLASS="REPLACEABLE"
><I
>hostname</I
></TT
>:[<SPAN
CLASS="OPTIONAL"
><TT
CLASS="REPLACEABLE"
><I
>time ranges</I
></TT
></SPAN
>]:<TT
CLASS="REPLACEABLE"
><I
>username</I
></TT
></PRE
><P
>	  A K:line bans all users matching a given user and host from connecting to the server. Both the
	  hostname and the username may contain wildcards.
	</P
><P
>	  The time ranges field is deprecated. It allows a range of times in which the K:line is in effect.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN974"
>5.2.8. D:line</A
></H2
><PRE
CLASS="SYNOPSIS"
>D:<TT
CLASS="REPLACEABLE"
><I
>IP address</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>comment</I
></TT
></PRE
><P
>	  D:lines (dumps) drop all connections from the given address or CIDR mask. This is notably less expensive
	  on the server than a K:line, so should be used by preference to deal with persistant attackers. Note
	  that D:lines must be individually placed on each server, and should not be used lightly.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN980"
>5.2.9. Q:lines</A
></H2
><PRE
CLASS="SYNOPSIS"
>Q:<TT
CLASS="REPLACEABLE"
><I
>nick mask</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>reason</I
></TT
>[<SPAN
CLASS="OPTIONAL"
>:<TT
CLASS="REPLACEABLE"
><I
>user</I
></TT
>@<TT
CLASS="REPLACEABLE"
><I
>host</I
></TT
></SPAN
>]</PRE
><P
>	  Q:lines (quarantines) prevent the given nick or anything matching the given mask from being used, unless
	  the user is connected matching the given user@host mask.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN989"
>5.2.10. X:lines</A
></H2
><PRE
CLASS="SYNOPSIS"
>X:<TT
CLASS="REPLACEABLE"
><I
>mask</I
></TT
>:<TT
CLASS="REPLACEABLE"
><I
>reason</I
></TT
>::<TT
CLASS="REPLACEABLE"
><I
>kill</I
></TT
></PRE
><P
>	  X:lines match the mask against the realname field for the a client attempting to connect. If <TT
CLASS="REPLACEABLE"
><I
>kill</I
></TT
>
	  is non-zero (true) then the client will be dropped as if they were K:lined, instead of being allowed to connect, otherwise
	  a warning notice will be broadcast to the opers with +r set.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN997"
>5.2.11. H:line</A
></H2
><PRE
CLASS="SYNOPSIS"
>H:<TT
CLASS="REPLACEABLE"
><I
>domain mask</I
></TT
>::<TT
CLASS="REPLACEABLE"
><I
>server name</I
></TT
></PRE
><P
>	  An H:line allows a remote server matching the given masks to introduce other servers.
	</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN1003"
>5.2.12. P:line</A
></H2
><PRE
CLASS="SYNOPSIS"
>P::[<SPAN
CLASS="OPTIONAL"
><TT
CLASS="REPLACEABLE"
><I
>bind address</I
></TT
></SPAN
>]::<TT
CLASS="REPLACEABLE"
><I
>port number</I
></TT
></PRE
><P
>	  A P:line specifies what ports a server should listen on.
	</P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="config.htm"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.htm"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>&nbsp;</TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Server config file format</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="config.htm"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>&nbsp;</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
dancer-ircd-doc 1.0.36-8ubuntu1 / usr / share / doc / dancer-ircd / dancer-oper-guide.html / configlines.htm
