updates.

[silc.git] / doc / example_silcd.conf

diff --git a/doc/example_silcd.conf b/doc/example_silcd.conf
index c149bc00598ad6daad71891d0354534aa4e06049..aa29aabf4969fe7c099460aa636d22ac7224f0aa 100644 (file)
--- a/doc/example_silcd.conf
+++ b/doc/example_silcd.conf
@@ -1,3 +1,9 @@
+#
+# Example configuration file.  Note that this attempts to present various
+# configuration possibilities and may not actually give any sensible 
+# configuration.  For real life example see the examples/ directory.
+#
+
 #
 # Configured ciphers.
 #
@@ -43,13 +49,10 @@ hmac-md5:md5:16
 #
 # Configured PKCS.
 #
-# Format: <name>:<module path>:<key length>
-#
-# NOTE: <module path> must be omitted as PKCS cannot be modules currently.
+# Format: <name>
 #
-#[PKCS]
-#rsa::1024
-#dss::1024
+[PKCS]
+rsa
 
 #
 # Run SILC server as specific user and group. The server must be initially
@@ -87,7 +90,7 @@ lassi.kuo.fi.ssh.com:10.2.1.6:Kuopio, Finland:706
 #
 # Listenning ports.
 #
-# Format: <local IP/UNIX socket path>:<remote IP>:<port>
+# Format: <local IP>:<Listener IP>:<port>
 #
 [ListenPort]
 10.2.1.6:10.2.1.6:706
@@ -132,7 +135,7 @@ infologfile:/usr/local/silc/logs/silcd.log:10000
 # file.
 #
 [ClientConnection]
-:::1333:1
+:::706:1
 
 #
 # Configured server administrator connections
@@ -153,13 +156,19 @@ infologfile:/usr/local/silc/logs/silcd.log:10000
 # Thus, if your server is not router do not configure this section.  If
 # your server is router, this must be configured.
 #
-# Format: <remote host>:<auth method>:<auth data>:<port>:<version ID>:<vlass>
+# Format: <remote host>:<auth method>:<auth data>:<port>:
+#         <version ID>:<class>:<backup connection>
 #
 # The <auth data> is either passphrase or file path to the public key
-# file.
+# file. If the connection is backup connection then set the <backup 
+# connection> to value 1. For normal connections set it 0. If it is
+# set to value 1 then this server will be backup router.
 #
 [ServerConnection]
-10.2.1.7:passwd:veryscret:706:1:1
+10.2.1.7:passwd:veryscret:706:1:1:0
+10.2.1.17:passwd:veryscret13:706:1:1:1   # backup connection, that host
+                                         # will use this server as backup
+                                         # router.
 
 #
 # Configured router connections.
@@ -169,19 +178,33 @@ infologfile:/usr/local/silc/logs/silcd.log:10000
 # this sections includes all configured router connections.  The first
 # configured connection is the primary route.
 #
-# Format: <remote host>:<auth method>:<auth data>:<port>:<version ID>:<class>:<initiator>
+# Format: <remote host>:<auth method>:<auth data>:<port>:<version ID>:
+#         <class>:<initiator>:<backup replace IP>:<backup replace port>:
+#         <local backup>
 #
 # The <auth data> is either passphrase or file path to the public key
-# file.
+# file. If you are the initiator of the connection then set the <initiator>
+# to value 1.  If you are the responder of the connection (waiting for 
+# incoming connection) then set it to 0.
+#
+# If the connection is backup router connection then set the <backup
+# replace IP> to the IP address of the router that the backup router will
+# replace if it becomes unavailable.  Set also the router's port to the
+# <backup replace port>.  For normal connection leave both empty. If this
+# backup router is in our cell then set the <local backup> to value 1.
+# If the backup router is in other cell then set it to value 0.
 #
 [RouterConnection]
 #10.2.1.100:passwd:veryverysecret:706:1:1:1
+#10.2.100.131:pubkey:/path/to/the/publickey:706:1:1:1
+#10.2.100.100:pubkey:/path/to/the/publickey:706:1:1:0:10.2.1.6:706:1
 
 #
 # Denied connections.
 #
 # These connections are denied to connect our server.
 #
-# Format: <remote host/nickname>:<time interval>:<comment>:<port>
+# Format: <remote host>:<port>:<comment>
 #
 [DenyConnection]
+#10.2.1.99:0:Your connection has been denied