X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=doc%2Fsample-ngircd.conf;h=6bed77b253cb52c689f07fbc3b2ea80897d3ac71;hp=6a97f8e2ca2019eecd80f206fad1d9a79d905709;hb=1b852fce72a87f3cce2049fde59ab66b6bbda6ca;hpb=a8aab6bfdd7d40cb1b0e99fdef46c6f97033f71d diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf index 6a97f8e2..6bed77b2 100644 --- a/doc/sample-ngircd.conf +++ b/doc/sample-ngircd.conf @@ -1,89 +1,192 @@ -# $Id: sample-ngircd.conf,v 1.4 2002/03/10 18:46:31 alex Exp $ +# $Id: sample-ngircd.conf,v 1.39 2006/12/29 14:09:48 fw Exp $ + +# +# This is a sample configuration file for the ngIRCd, which must be adepted +# to the local preferences and needs. +# +# Comments are started with "#" or ";". +# +# Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the +# server interprets the configuration file as expected! +# [Global] + # The [Global] section of this file is used to define the main + # configuration of the server, like the server name and the ports + # on which the server should be listening. - # - # Im [Global]-Abschnitt der Konfigurationsdatei wird der Server - # "an sich" konfiguriert. - # - - # Servername im IRC-Netz + # Server name in the IRC network, must contain at least one dot + # (".") and be unique in the IRC network. Required! Name = irc.the.net - # Info-Text des Servers + # Info text of the server. This will be shown by WHOIS and + # LINKS requests for example. Info = Server Info Text - # Ports, auf denen Verbindungen angenommen werden sollen. Es koennen - # mehrere Ports mit "," getrennt angegeben werden. - Ports = 6667, 6668, 6669 + # Global password for all users needed to connect to the server + ;Password = abc + + # Information about the server and the administrator, used by the + # ADMIN command. Not required by server but by RFC! + ;AdminInfo1 = Description + ;AdminInfo2 = Location + ;AdminEMail = admin@irc.server + + # Ports on which the server should listen. There may be more than + # one port, separated with ",". (Default: 6667) + ;Ports = 6667, 6668, 6669 + + # IP address on which the server should listen. (Default: empty, + # so the server listens on all IP addresses of the system) + ;Listen = 1.2.3.4 + + # Text file with the "message of the day" (MOTD). This message will + # be shown to all users connecting to the server: + ;MotdFile = /usr/local/etc/ngircd.motd + + # A simple Phrase (<256 chars) if you don't want to use a motd file. + # If it is set no MotdFile will be read at all. + ;MotdPhrase = "Hello world!" + + # User ID under which the server should run; you can use the name + # of the user or the numerical ID. ATTENTION: For this to work the + # server must have been started with root privileges! In addition, + # the configuration and MOTD files must be readable by this user, + # otherwise RESTART and REHASH won't work! + ;ServerUID = 65534 + + # Group ID under which the ngircd should run; you can use the name + # of the group or the numerical ID. ATTENTION: For this to work the + # server must have been started with root privileges! + ;ServerGID = 65534 + + # A directory to chroot in when everything is initialized. It + # doesn't need to be populated if ngIRCd is compiled as a static + # binary. By default ngIRCd won't use the chroot() feature. + # ATTENTION: For this to work the server must have been started + # with root privileges! + ;ChrootDir = /var/empty + + # This tells ngircd to write its current process id to a file. + # Note that the pidfile is written AFTER chroot and switching uid, + # i. e. the Directory the pidfile resides in must be writeable by + # the ngircd user and exist in the chroot directory. + ;PidFile = /var/run/ngircd/ngircd.pid + + # After seconds of inactivity the server will send a + # PING to the peer to test whether it is alive or not. + ;PingTimeout = 120 + + # If a client fails to answer a PING with a PONG within + # seconds, it will be disconnected by the server. + ;PongTimeout = 20 + + # The server tries every seconds to establish a link + # to not yet (or no longer) connected servers. + ;ConnectRetry = 60 + + # Should IRC Operators be allowed to use the MODE command even if + # they are not(!) channel-operators? + ;OperCanUseMode = no + + # Mask IRC Operator mode requests as if they were coming from the + # server? (This is a compatibility hack for ircd-irc2 servers) + ;OperServerMode = no + + # Allow Pre-Defined Channels only (see Section [Channels]) + ;PredefChannelsOnly = no + + # Maximum number of simultaneous connection the server is allowed + # to accept (<=0: unlimited): + ;MaxConnections = -1 + + # Maximum number of simultaneous connections from a single IP address + # the server will accept (<=0: unlimited): + ;MaxConnectionsIP = 5 + + # Maximum number of channels a user can be member of (<=0: no limit): + ;MaxJoins = 10 - # Textdatei mit der "Message of the Day" (MOTD) - MotdFile = /usr/local/etc/ngircd.motd - - # Nach Sekunden verschickt der Server bei Inaktivitaet - # von einem Client diesem ein PING. - PingTimeout = 120 +[Operator] + # [Operator] sections are used to define IRC Operators. There may be + # more than one [Operator] block, one for each local operator. - # Antwortet ein Client, der ein PING bekam, nicht innerhalb von - # Sekunden mit einem PONG, so wird er disconnectiert. - PongTimeout = 10 + # ID of the operator (may be different of the nick name) + ;Name = TheOper - # Der Server versucht alle Sekunden, noch nicht bzw. - # nicht mehr connectierte Server-Links aufzubauen. - ConnectRetry = 60 + # Password of the IRC operator + ;Password = ThePwd + # Optional Mask from which /OPER will be accepted + ;Mask = *!ident@somewhere.example.com [Operator] + # More [Operator] sections, if you like ... +[Server] + # Other servers are configured in [Server] sections. If you + # configure a port for the connection, then this ngircd tries to + # connect to to the other server on the given port; if not it waits + # for the other server to connect. + # There may be more than one server block, one for each server. # - # Mit einem [Operator]-Block wird der Name und das Passwort eines - # IRC-Operators konfiguriert. Es darf mehrere [Operator]-Bloecke - # geben (fuer jeden Operator einen). - # + # Server Groups: + # The ngIRCd allows "server groups": You can assign an "ID" to every + # server with which you want this ngIRCd to link. If a server of a + # group won't answer, the ngIRCd tries to connect to the next server + # in the given group. But the ngircd never tries to connect to two + # servers with the same group ID. + + # IRC name of the remote server, must match the "Name" variable in + # the [Global] section of the other server (when using ngIRCd). + ;Name = irc2.the.net + + # Internet host name or IP address of the peer (only required when + # this server should establish the connection). + ;Host = connect-to-host.the.net - # ID des IRC-Operators (muss nicht mit dem Nick identisch sein). - ;Name = TheOper + # Port of the server to which the ngIRCd should connect. If you + # assign no port the ngIRCd waits for incoming connections. + ;Port = 6667 - # Passwort des IRC-Operators - ;Password = ThePwd + # Own password for the connection. This password has to be configured + # as "PeerPassword" on the other server. + ;MyPassword = MySecret + + # Foreign password for this connection. This password has to be + # configured as "MyPassword" on the other server. + ;PeerPassword = PeerSecret + # Group of this server (optional) + ;Group = 123 [Server] + # More [Server] sections, if you like ... - # - # In [Server]-Bloecken werden Server konfiguriert, zu denen dieser - # Server sich verbinden soll bzw. von denen Verbindungen angekommen - # werden duerfen. - # Es koennen mehrere Server konfiguriert werden, d.h. [Server]- - # Bloecke koennen mehrfach vorkommen. - # Ist fuer einen Server ein Port konfiguriert, so versucht dieser - # Server die Gegenseite zu connectieren. Ist kein Port vorgegeben, - # so wartet dieser Server auf eine Verbindung der Gegenseite. - # - # Server-Gruppen: - # Fuer jeden Server kann (optinal!) eine Gruppe konfiguriert werden, - # zu der er gehoert (wird nur beachtet, wenn ein Port konfiguriert - # ist!): eine solche Server-Gruppe wird quasi als ein Server ange- - # sehen, der ngIRCd baut also nur eine Verbindung auf. Schlaegt die - # Verbindung zu einem Server in einer Gruppe fehl, so wird der - # naechste Server in der Gruppe probiert. - # +[Channel] + # Pre-defined channels can be configured in [Channel] sections. + # Such channels are created by the server when starting up and even + # persist when there are no more members left. + # Persistent channels are marked with the mode 'P', which can be set + # and unset by IRC operators like other modes on the fly. + # There may be more than one [Channel] block, one for each channel. - # Hostname des Servers - ;Host = connect-to-host.the.net + # Name of the channel + ;Name = #TheName - # IRC-Name des Servers - ;Name = irc2.the.net + # Topic for this channel + ;Topic = a great topic - # Port, zu dem dieser Server eine Verbindung herstellen soll. Wird - # kein Port angegeben, so wird auf eine Verbindung der Gegenseite - # gewartet. - ;Port = 6666 + # Initial channel modes + ;Modes = tnk - # Passwort fuer diese Verbindung - ;Password = ThePwd1 + # initial channel password (mode k) + ;Key = Secret - # Gruppe, zu der dieser Server gehoert (optional). - ;Group = 123 + # maximum users per channel (mode l) + ;MaxUsers = 23 + +[Channel] + # More [Channel] sections, if you like ... # -eof-