TLS/SSL support: documentation.

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 87a94d9df8be365b4de8d2597cf06ed4d316800b..ba2d477b10d99d2f91753ae46c000bfe08b81adb 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -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,6 +42,21 @@
        # one port, separated with ",". (Default: 6667)
        ;Ports = 6667, 6668, 6669
 
+       # 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"
@@ -158,7 +175,7 @@
        # 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
@@ -189,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 ...