]> arthur.barton.de Git - ngircd-alex.git/blobdiff - doc/sample-ngircd.conf
- Dokumentation aktualisiert bzw. begonnen.
[ngircd-alex.git] / doc / sample-ngircd.conf
index c7845135104eb67555e7a6b201fea7c76199fef6..49984e54c99b0d8054cf2a68873eec98f208369a 100644 (file)
-# $Id: sample-ngircd.conf,v 1.3 2002/02/17 17:34:50 alex Exp $
+# $Id: sample-ngircd.conf,v 1.14 2002/11/08 23:24:54 alex Exp $
+
+#
+# Das ist eine Beispiel-Konfiguration fuer den ngIRCd, die an die
+# jeweiligen Beduerfnisse angepasst werden kann/muss.
+#
+# Kommentare werden mit "#" oder ";" eingeleitet.
+#
+# +-----------------------------------------------------------------------+
+# | Please note: English translations of some of the german documentation |
+# | files can be found in the directory "doc/en" -- please have a look!   |
+# +-----------------------------------------------------------------------+
+#
+# Autor: Alexander Barton, <alex@barton.de>
+# Erweiterungen von Ilja Osthoff, <ilja@glide.ath.cx>
+#
 
 [Global]
+
+       #
+       # Im [Global]-Abschnitt der Konfigurationsdatei wird der Server
+       # "an sich" konfiguriert. Notwendig ist nur die Variable "Name",
+       # Info ist in der Regel ebengalls anzupassen. Fuer alle uebrigen
+       # Variablen koennen oft die Defaults benutzt werden, d.h. hier
+       # muss die Variable nicht angegeben werden.
+       #
+
+       # Servername im IRC-Netz
        Name = irc.the.net
+
+       # Info-Text des Servers. Dieser wird z.B. bei WHOIS- oder LINKS-
+       # Abfragen entsprechend mit ausgegeben.
        Info = Server Info Text
-       Ports = 6667, 6668, 6669
-       MotdFile = /usr/local/etc/ngircd.motd
-       PingTimeout = 120
-       PongTimeout = 10
-       ConnectRetry = 60
+       
+       # Informationen ueber den Server und Administrator fuer den
+       # ADMIN-Befehl:
+       ;AdminInfo1 = Beschreibung
+       ;AdminInfo2 = Standort
+       ;AdminEMail = admin@irc.server
+
+       # Ports, auf denen Verbindungen angenommen werden sollen. Es koennen
+       # mehrere Ports mit "," getrennt angegeben werden. (Default: 6667)
+       ;Ports = 6667, 6668, 6669
+
+       # Textdatei mit der "Message of the Day" (MOTD). Diese wird aus-
+       # gegeben, wenn sich ein User mit dem Server verbindet.
+       ;MotdFile = /usr/local/etc/ngircd.motd
+
+       # User-ID, unter der der Daemon laufen soll (dazu muss der Server
+       # jedoch mit root-Rechten gestartet werden). Es kann der Name oder
+       # die numerische ID angegeben werden.
+       # ACHTUNG: Die Konfigurations- und MOTD-Datei muessen fuer diesen
+       # Benutzer lesbar sein, ansonsten schlaegt ein RESTART fehl!
+       ;ServerUID = ircd
+
+       # Group-ID, zu der der Daemon wechseln soll (hierzu muss der Server
+       # jedoch mit root-Rechten gestartet werden). Es kann der Name oder
+       # die numerische ID angegeben werden.
+       ;ServerGID = daemon
+
+       # Nach <PingTimeout> Sekunden verschickt der Server bei Inaktivitaet
+       # von einem Client diesem ein PING.
+       ;PingTimeout = 120
+
+       # Antwortet ein Client, der ein PING bekam, nicht innerhalb von
+       # <PongTimeout> Sekunden mit einem PONG, so wird er disconnectiert.
+       ;PongTimeout = 20
+
+       # Der Server versucht alle <ConnectRetry> Sekunden, noch nicht bzw.
+       # nicht mehr connectierte Server-Links aufzubauen.
+       ;ConnectRetry = 60
+       
+       # Sollen IRC-Operatoren immer den MODE-Befehl in Channel benutzen
+       # koennen, auch wenn sie kein(!) Channel-Operator sind?
+       ;OperCanUseMode = no
+
+       # Maximale Anzahl von gleichzeitigen Verbindungen, die dieser
+       # Server annehmen darf (<=0: unlimitiert).
+       ;MaxConnections = -1
 
 [Operator]
-;      Name = TheOper
-;      Password = ThePwd
 
-[Server]
-;      Host = connect-to-host.the.net
-;      Name = irc2.the.net
-;      Port = 6666
-;      Password = ThePwd1
+       #
+       # Mit einem [Operator]-Block wird der Name und das Passwort eines
+       # IRC-Operators konfiguriert. Es darf mehrere [Operator]-Bloecke
+       # geben (fuer jeden Operator einen).
+       #
+
+       # ID des IRC-Operators (muss nicht mit dem Nick identisch sein).
+       ;Name = TheOper
+
+       # Passwort des IRC-Operators
+       ;Password = ThePwd
 
 [Server]
-;      Host = wait-for-host.the.net
-;      Name = irc3.the.net
-;      Password = ThePwd2
+
+       #
+       # In [Server]-Bloecken werden Server konfiguriert, zu denen sich
+       # dieser ngIRCd verbinden soll bzw. von denen Verbindungen angekommen
+       # werden duerfen.
+       # Es koennen mehrere Server konfiguriert werden, d.h. [Server]-
+       # Bloecke koennen mehrfach vorkommen.
+       # Wenn man fuer einen Server einen Port angegeben hat, dann versucht
+       # sich der ngIRCd mit der Gegenseite zu verbinden. Hat man keinen
+       # Port konfiguriert, dann wartet der ngIRCd darauf, dass sich die
+       # Gegenseite mit ihm verbindet.
+       #
+       # Server-Gruppen:
+       # Der ngIRCd unterstuetzt "Server-Gruppen": das bedeutet, man kann
+       # jedem Server, mit dem man sich verbinden will, einer Gruppe zu-
+       # ordnen. Wenn der ngIRCd sich dann mit einem Server aus der Gruppe
+       # verbinden will und keine Antwort erhaelt, dann wird der naechste
+       # Server aus der Gruppe versucht.
+       # Achtung: Gruppen werden nur beachtet, wenn man einen Port fur
+       # die Gegenseite angegeben hat!
+       #
+
+       # Hostname des Servers
+       ;Host = connect-to-host.the.net
+
+       # IRC-Name des Servers
+       ;Name = irc2.the.net
+
+       # Port, zu dem dieser Server eine Verbindung herstellen soll. Wird
+       # kein Port angegeben, so wird auf eine Verbindung der Gegenseite
+       # gewartet.
+       ;Port = 6666
+
+       # Passwort fuer diese Verbindung
+       ;Password = ThePwd1
+
+       # Gruppe, zu der dieser Server gehoert (optional).
+       ;Group = 123
+
+[Channel]
+
+       #
+       # Mit [Channel]-Bloecken werden "persistente Channels" definiert,
+       # die nach dem Start des Servers automatisch erzeugt werden und auch
+       # dann erhalten bleiben, wenn keine User mehr im Channel sind. Es
+       # koennen mehrere solcher Bloecke hier konfiguriert werden.
+       # Gekennzeichnet werden solche Channels mit dem Mode "P", der ganz
+       # normal gesetzt und geloescht werden kann.
+       #
+
+       # Name des Channels
+       ;Name = #TheName
+
+       # Topic, das gesetzt werden soll
+       ;Topic = Ein tolles Topic
+
+       # Channel-Modes
+       ;Modes = tn
 
 # -eof-