Added example files for backup router in doc/examples.
[crypto.git] / doc / example_silcd.conf.in
index bf0a81b4ff509e78bea59d088adf5609593c0c7a..ac8769a8d0201189a5f76af370834e1091858f6d 100644 (file)
@@ -63,7 +63,7 @@ General {
        # remote must be of at least this version, or newer.  If older then
        # the connection will not be allowed.
        #
-       # version_protocol         - SILC protocol version ("majog.minor")
+       # version_protocol         - SILC protocol version ("major.minor")
        # version_software         - software version ("major.minor")
        # version_software_vendor  - vendor specific version extension
        #
@@ -71,7 +71,7 @@ General {
        # number of the software.  The string can be a regex string to match
        # more widely.  Usually the vendor version checking is not necessary
        # and can be omitted.  These can be overridden with ConnectionParams.
-       #version_protocol = "1.0";
+       #version_protocol = "1.1";
        #version_software = "1.3";
        #version_software_vendor = "SomeVendor";
 
@@ -105,7 +105,7 @@ General {
 
        # Key exchange protocol rekey interval (seconds). How often to
        # regenerate the session key with the remote. Initiator will perform
-       # the rekey and this setting affects only when connecting as intiator.
+       # the rekey and this setting affects only when connecting as initiator.
        # This can be overridden with ConnectionParams.
        #key_exchange_rekey = 3600;
 
@@ -130,6 +130,15 @@ General {
        # someone joins or leaves the channel.
        #channel_rekey_secs = 3600;
 
+       # SILC session detachment disabling and limiting.  By default clients
+       # can detach their sessions from server.  If you set detach_disabled
+       # to true the DETACH command cannot be used by clients.  If you
+       # want to limit for how long the server keeps detached sessions you
+       # can set the time (minutes) in detach_timeout.  After that timeout
+       # the detached session is closed if it is not resumed.  By default
+       # sessions are persistent as long as server is running.
+       #detach_disabled = true;
+       #detach_timeout = 1440;
 };
 
 #
@@ -137,11 +146,25 @@ General {
 #
 ServerInfo {
        #
-       # Server FQDN and IP address
+       # Server name (FQDN)
        #
        hostname = "lassi.kuo.fi.ssh.com";
-       ip = "10.2.1.6";
-       port = 706;
+
+       #
+       # Primary listener.  Specify the IP address and the port to bind
+       # the server.
+       #
+       Primary {
+               ip = "10.2.1.6";
+               port = 706;
+       };
+
+       #
+       # Secondary listener(s).  If you need to bind your server into
+       # several interfaces use the Secondary to specify the listener(s).
+       #
+       #Secondary { ip = "10.2.1.60"; port = 706; };
+       #Secondary { ip = "10.2.1.160"; port = 706; };
 
        #
        # ServerType field specifies the purpose of this server
@@ -284,7 +307,7 @@ ConnectionParams {
        # number of the software.  The string can be a regex string to match
        # more widely.  Usually the vendor version checking is not necessary
        # and can be omitted.
-       #version_protocol = "1.0";
+       #version_protocol = "1.1";
        #version_software = "1.3";
        #version_software_vendor = "SomeVendor";
 
@@ -391,7 +414,7 @@ Admin {
 #
 # If the connection is backup connection then set the "Backup" option
 # to true. For normal connections set it false. If it is set to true then
-# this server will be backup router.
+# your server will be backup router.
 #
 ServerConnection {
        Host = "10.2.1.7";
@@ -407,7 +430,10 @@ ServerConnection {
 # For normal servers only one entry maybe configured to this section.  It
 # must be the router this server will be connected to.  For router servers,
 # this section includes all configured router connections.  The first
-# configured connection is the primary route.
+# configured connection is the primary route.  The Host specifies the
+# remote hostname or IP address.  The Port specifies the remote port to
+# connect when Initiator is true.  When Initiator is false the Port
+# specifies the local port (listener port).
 #
 # The authentication data is specified by Passphrase and/or PublicKey.
 # If both are provided then both password and public key based authentication