updates.
[silc.git] / doc / example_silcd.conf.in
index 2612c2197333cdcd332f74a13afb4ba5c85d1a9d..32726e0bf5b74cdd3728f2c2dd3df7b38fb28615 100644 (file)
@@ -59,6 +59,22 @@ General {
        # refused. This can be overridden with ConnectionParams.
        #connections_max_per_host = 10;
 
+       # Required version of the remote.  If these are specified then the
+       # remote must be of at least this version, or newer.  If older then
+       # the connection will not be allowed.
+       #
+       # version_protocol         - SILC protocol version ("major.minor")
+       # version_software         - software version ("major.minor")
+       # version_software_vendor  - vendor specific version extension
+       #
+       # The version_software_vendor may be for example a string or a build
+       # 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.1";
+       #version_software = "1.3";
+       #version_software_vendor = "SomeVendor";
+
        # Default keepalive frequency (seconds). This can be overridden
        # with ConnectionParams.
        keepalive_secs = 300;
@@ -89,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;
 
@@ -114,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;
 };
 
 #
@@ -183,37 +208,43 @@ ServerInfo {
 # There are only four defined channels allowed for defining (see below).
 # The log channels have an importance value, and most important channels
 # are redirected on the less important ones, thus setting a valid logging
-# file for "infologfile" will ensure logging for all channels, while setting
-# logging file for "errorlogfile" will ensure logging for channels "error"
-# and "fatal"
+# file for "Info" will ensure logging for all channels, while setting
+# logging file for "Errors" will ensure logging for channels "Errors"
+# and "Fatals"
 #
 Logging {
-       #
        # If QuickLogs is true, then the logging files will be updated
        # real-time. This causes a bit more CPU and HDD activity, but
-       # reduces memory usage. (if unsure say true).
+       # reduces memory usage.  By default it is false and log files are
+       # written with FlushDelay timeout.
        #
-       QuickLogs = false;
+       #QuickLogs = true;
 
-       #
-       # (Only if QuickLogs is false)
-       # FlushDelay tells log files update delay in case you have chosen
-       # buffering output.
+       # FlushDelay tells log files update delay (seconds) in case you 
+       # have chosen buffering output.  This setting has effect only if
+       # the QuickLogs is false.
        #
        FlushDelay = 180;
 
+       # Informational messages
        Info {
                File = "@LOGSDIR@/silcd.log";
                Size = "50k";
        };
+
+       # Warning messages
        Warnings {
                File = "@LOGSDIR@/silcd_warnings.log";
                Size = "50k";
        };
+
+       # Error messages
        Errors {
                File = "@LOGSDIR@/silcd_errors.log";
                Size = "50k";
        };
+
+       # Fatal messages
        Fatals {
                File = "@LOGSDIR@/silcd_fatals.log";
                Size = "50k";
@@ -250,6 +281,22 @@ ConnectionParams {
        # connections it is recommended that this value is set to one (1).
        connections_max_per_host = 10;
 
+       # Required version of the remote.  If these are specified then the
+       # remote must be of at least this version, or newer.  If older then
+       # the connection will not be allowed.
+       #
+       # version_protocol         - SILC protocol version
+       # version_software         - software version
+       # version_software_vendor  - vendor specific version extension
+       #
+       # The version_software_vendor may be for example a string or a build
+       # 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.1";
+       #version_software = "1.3";
+       #version_software_vendor = "SomeVendor";
+
        # Keepalive frequency (seconds).
        keepalive_secs = 300;
 
@@ -293,9 +340,9 @@ ConnectionParams {
 #
 # Configured client connections.
 #
-# The "host" defines the incoming IP address or hostname of the client.
+# The "Host" defines the incoming IP address or hostname of the client.
 # If it is omitted all hosts will match this client connection.  The
-# "param" is optional and can be used to set specific connection parameters
+# "Params" is optional and can be used to set specific connection parameters
 # for this connection.
 #
 # The authentication data is specified by Passphrase and/or PublicKey.
@@ -369,7 +416,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