]> arthur.barton.de Git - ngircd-alex.git/blobdiff - doc/sample-ngircd.conf.tmpl
Spelling fix: "nick name" -> "nickname"
[ngircd-alex.git] / doc / sample-ngircd.conf.tmpl
index fc903cd2135d5b6c4324e9e9d4478e1ddbfbdaa7..997a983d2bc08fbeb9bc9b2250bd487c631e779d 100644 (file)
@@ -57,7 +57,7 @@
        # This tells ngIRCd to write its current process ID to a file.
        # Note that the pidfile is written AFTER chroot and switching the
        # user ID, e.g. the directory the pidfile resides in must be
-       # writeable by the ngIRCd user and exist in the chroot directory.
+       # writable by the ngIRCd user and exist in the chroot directory.
        ;PidFile = /var/run/ngircd/ngircd.pid
 
        # Ports on which the server should listen. There may be more than
        # Maximum number of channels a user can be member of (0: no limit):
        ;MaxJoins = 10
 
-       # Maximum length of an user nick name (Default: 9, as in RFC 2812).
+       # Maximum length of an user nickname (Default: 9, as in RFC 2812).
        # Please note that all servers in an IRC network MUST use the same
-       # maximum nick name length!
+       # maximum nickname length!
        ;MaxNickLength = 9
 
+       # Maximum number of channels returned in response to a /list
+       # command (0: unlimited):
+       ;MaxListSize = 100
+
        # After <PingTimeout> seconds of inactivity the server will send a
        # PING to the peer to test whether it is alive or not.
        ;PingTimeout = 120
 
 [Options]
        # Optional features and configuration options to further tweak the
-       # behavior of ngIRCd. If you wan't to get started quickly, you most
+       # behavior of ngIRCd. If you want to get started quickly, you most
        # probably don't have to make changes here -- they are all optional.
 
        # Are remote IRC operators allowed to control this server, e.g.
        ;ChrootDir = /var/empty
 
        # Set this hostname for every client instead of the real one.
-       # Please note: don't use the percentage sign ("%"), it is reserved for
-       # future extensions!
-       ;CloakHost = irc.example.net
+       # Use %x to add the hashed value of the original hostname.
+       ;CloakHost = cloaked.host
+
+       # Use this hostname for hostname cloaking on clients that have the
+       # user mode "+x" set, instead of the name of the server.
+       # Use %x to add the hashed value of the original hostname.
+       ;CloakHostModeX = cloaked.user
+
+       # The Salt for cloaked hostname hashing. When undefined a random
+       # hash is generated after each server start.
+       ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
 
-       # Set every clients' user name to their nick name
+       # Set every clients' user name to their nickname
        ;CloakUserToNick = yes
 
        # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
        ;DNS = yes
 
        # Do IDENT lookups if ngIRCd has been compiled with support for it.
+       # Users identified using IDENT are registered without the "~" character
+       # prepended to their user name.
        ;Ident = yes
 
+       # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
+       # by censoring some information like idle time, logon time, etc.
+       ;MorePrivacy = no
+
        # Normally ngIRCd doesn't send any messages to a client until it is
        # registered. Enable this option to let the daemon send "NOTICE AUTH"
        # messages to clients while connecting.
        # they are not(!) channel-operators?
        ;OperCanUseMode = no
 
+       # Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
+       ;OperChanPAutoOp = yes
+
        # Mask IRC Operator mode requests as if they were coming from the
        # server? (This is a compatibility hack for ircd-irc2 servers)
        ;OperServerMode = no
 
        # Use PAM if ngIRCd has been compiled with support for it.
-       ;PAM = no
+       # Users identified using PAM are registered without the "~" character
+       # prepended to their user name.
+       ;PAM = yes
+
+       # When PAM is enabled, all clients are required to be authenticated
+       # using PAM; connecting to the server without successful PAM
+       # authentication isn't possible.
+       # If this option is set, clients not sending a password are still
+       # allowed to connect: they won't become "identified" and keep the "~"
+       # character prepended to their supplied user name.
+       # Please note: To make some use of this behavior, it most probably
+       # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
+       # same time, because you wouldn't be able to distinguish between
+       # Ident'ified and PAM-authenticated users: both don't have a "~"
+       # character prepended to their respective user names!
+       ;PAMIsOptional = no
 
        # Allow Pre-Defined Channels only (see Section [Channels])
        ;PredefChannelsOnly = no
        # "PONG" reply.
        ;RequireAuthPing = no
 
-       # Silently drop all incomming CTCP requests.
+       # Silently drop all incoming CTCP requests.
        ;ScrubCTCP = no
 
        # Syslog "facility" to which ngIRCd should send log messages.
        # [Operator] sections are used to define IRC Operators. There may be
        # more than one [Operator] block, one for each local operator.
 
-       # ID of the operator (may be different of the nick name)
+       # ID of the operator (may be different of the nickname)
        ;Name = TheOper
 
        # Password of the IRC operator
        # Connect to the remote server using TLS/SSL (Default: false)
        ;SSLConnect = yes
 
-       # Define a (case insensitive) mask matching nick names that should be
-       # treated as IRC services when introduced via this remote server.
+       # Define a (case insensitive) list of masks matching nicknames that
+       # should be treated as IRC services when introduced via this remote
+       # server, separated by commas (",").
        # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
        # (which is the default).
        # When you are connecting IRC services which mask as a IRC server
        # and which use "virtual users" to communicate with, for example
        # "NickServ" and "ChanServ", you should set this parameter to
-       # something like "*Serv".
-       ;ServiceMask = *Serv
+       # something like "*Serv" or "NickServ,ChanServ,XyzServ".
+       ;ServiceMask = *Serv,Global
 
 [Server]
        # More [Server] sections, if you like ...