X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=doc%2Fsample-ngircd.conf;h=fe34dffae1afc58230ecd4335ac4ebbb9eca972e;hp=e17b0e60690dd5b46a886985391acc7a083c3b9d;hb=a988bbc86aed404b7bcfdbceafc030ea4bc5ecab;hpb=b160f574dee613598d3adcb46169d898ca45f252 diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf index e17b0e60..fe34dffa 100644 --- a/doc/sample-ngircd.conf +++ b/doc/sample-ngircd.conf @@ -1,18 +1,19 @@ -# $Id: sample-ngircd.conf,v 1.41 2007/10/13 20:45:11 fw Exp $ - # -# This is a sample configuration file for the ngIRCd, which must be adepted -# to the local preferences and needs. +# This is a sample configuration file for the ngIRCd IRC daemon, which must +# be customized to the local preferences and needs. # # Comments are started with "#" or ";". # # A lot of configuration options in this file start with a ";". You have # to remove the ";" in front of each variable to actually set a value! -# The disabled variables are shown with example values for completeness. +# The disabled variables are shown with example values for completeness only +# and the daemon is using compiled-in default settings. # # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the # server interprets the configuration file as expected! # +# Please see ngircd.conf(5) for a complete list of configuration options. +# [Global] # The [Global] section of this file is used to define the main @@ -27,9 +28,15 @@ # LINKS requests for example. Info = Server Info Text - # Global password for all users needed to connect to the server + # Global password for all users needed to connect to the server. + # (Default: not set) ;Password = abc + # Password required for using the WEBIRC command used by some + # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't + # be used. (Default: not set) + ;WebircPassword = xyz + # Information about the server and the administrator, used by the # ADMIN command. Not required by server but by RFC! ;AdminInfo1 = Description @@ -40,16 +47,39 @@ # 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 + # Additional Listen Ports that expect SSL/TLS encrypted connections + ;SSLPorts = 6697, 9999 + + # SSL Server Key + ;SSLKeyFile = /usr/local/etc/ngircd/ssl/server-key.pem + + # password to decrypt SSLKeyFile (OpenSSL only) + ;SSLKeyFilePassword = secret + + # SSL Server Key Certificate + ;SSLCertFile = /usr/local/etc/ngircd/ssl/server-cert.pem + + # Diffie-Hellman parameters + ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem + + # comma separated list of IP addresses on which the server should + # listen. Default values are: + # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0" + # so the server listens on all IP addresses of the system by default. + ;Listen = 127.0.0.1,192.168.0.1 + + # Syslog "facility" to which ngIRCd should send log messages. + # Possible values are system dependant, but most probably auth, daemon, + # user and local1 through local7 are possible values; see syslog(3). + # Default is "local5" for historical reasons, you probably want to + # change this to "daemon", for example. + SyslogFacility = local1 # 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 @@ -97,11 +127,33 @@ # server? (This is a compatibility hack for ircd-irc2 servers) ;OperServerMode = no + # Are remote IRC operators allowed to control this server, e. g. + # use commands like CONNECT, SQUIT, DIE, ...? + ;AllowRemoteOper = no + # Allow Pre-Defined Channels only (see Section [Channels]) ;PredefChannelsOnly = no - # Maximum number of simultaneous connection the server is allowed - # to accept (0: unlimited): + # Don't do any DNS lookups when a client connects to the server. + ;NoDNS = no + + # Don't do any IDENT lookups, even if ngIRCd has been compiled + # with support for it. + ;NoIdent = no + + # Don't use PAM, even if ngIRCd has been compiled with support for it. + ;NoPAM = no + + # Don't use ZeroConf service registration, even if ngIRCd has been + # compiled with support for it (e.g. Howl, Avahi, Mac OS X). + ;NoZeroConf = no + + # try to connect to other irc servers using ipv4 and ipv6, if possible + ;ConnectIPv6 = yes + ;ConnectIPv4 = yes + + # Maximum number of simultaneous in- and outbound connections the + # server is allowed to accept (0: unlimited): ;MaxConnections = 0 # Maximum number of simultaneous connections from a single IP address @@ -111,6 +163,11 @@ # 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). + # Please note that all servers in an IRC network MUST use the same + # maximum nick name length! + ;MaxNickLength = 9 + [Operator] # [Operator] sections are used to define IRC Operators. There may be # more than one [Operator] block, one for each local operator. @@ -144,11 +201,15 @@ # 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 + # IP address to use as _source_ address for the connection. if + # unspecified, ngircd will let the operating system pick an address. + ;Bind = 10.0.0.1 + # Port of the server to which the ngIRCd should connect. If you # assign no port the ngIRCd waits for incoming connections. ;Port = 6667 @@ -166,11 +227,24 @@ # Set the "Passive" option to "yes" if you don't want this ngIRCd to # connect to the configured peer (same as leaving the "Port" variable - # empty). The advantage of this option is that you can actually configure - # a port an use the IRC command CONNECT more easily to manually connect - # this specific server later. + # empty). The advantage of this option is that you can actually + # configure a port an use the IRC command CONNECT more easily to + # manually connect this specific server later. ;Passive = no + # 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. + # 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 + [Server] # More [Server] sections, if you like ... @@ -194,6 +268,10 @@ # initial channel password (mode k) ;Key = Secret + # Key file, syntax for each line: "::". + # Default: none. + ;KeyFile = /etc/ngircd/#chan.key + # maximum users per channel (mode l) ;MaxUsers = 23