TLS/SSL support: documentation.

[ngircd-alex.git] / doc / sample-ngircd.conf

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 924f0595450939600f516516f97bf5b063bca401..ba2d477b10d99d2f91753ae46c000bfe08b81adb 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,4 +1,4 @@
-# $Id: sample-ngircd.conf,v 1.42 2007/11/21 12:16:35 alex Exp $
+# $Id: sample-ngircd.conf,v 1.44 2008/01/07 23:02:29 alex Exp $
 
 #
 # This is a sample configuration file for the ngIRCd, which must be adepted
@@ -13,6 +13,8 @@
 # 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
@@ -40,9 +42,26 @@
        # 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 = 9999,6668
+
+       # 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 seperated 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
 
        # Text file with the "message of the day" (MOTD). This message will
        # be shown to all users connecting to the server:
@@ -100,6 +119,13 @@
        # Allow Pre-Defined Channels only (see Section [Channels])
        ;PredefChannelsOnly = no
 
+       # Don't do any DNS lookups when a client connects to the server.
+       ;NoDNS = no
+
+       # try to connect to other irc servers using ipv4 and ipv6, if possible
+       ;ConnectIPv6 = yes
+       ;ConnectIPv4 = yes
+
        # Maximum number of simultaneous connection the server is allowed
        # to accept (0: unlimited):
        ;MaxConnections = 0
@@ -149,11 +175,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
@@ -176,6 +206,9 @@
        # this specific server later.
        ;Passive = no
 
+       # Connect to the remote server using TLS/SSL (Default: false)
+       ; SSLConnect = yes
+
 [Server]
        # More [Server] sections, if you like ...