* Added global variable silc_log_timestamp that tells silclog
[silc.git] / doc / example_silcd.conf.in
index ac8769a8d0201189a5f76af370834e1091858f6d..9a79a679760774ec982f1097e67847bed9e1df89 100644 (file)
 # The ServerInfo section is mandatory section.  Other sections are optional.
 # However, if General section is defined it must be defined before the
 # ConnectionParams sections.  On the other hand, the ConnectionParams section
-# must be defined before Client, ServerConnection or RouterConnection 
+# must be defined before Client, ServerConnection or RouterConnection
 # sections.  Other sections can be in free order.
 #
 
 #
-# Include global algorithms from the "silcalgs.conf" file. This file
-# defines ciphers, hash functions, HMACs and PKCS algorithms that can
-# be used.
+# Include global algorithms from the "silcalgs.conf" file.  This file defines
+# ciphers, hash functions, HMACs and PKCS algorithms that can be used.
 #
 Include "@ETCDIR@/silcalgs.conf";
 
@@ -45,7 +44,7 @@ General {
        #prefer_passphrase_auth = true;
 
        # Set this to true if the server should require fully qualified
-       # domain names (FQDN) for incoming connections. If true, a host
+       # domain names (FQDN) for incoming connections.  If true, a host
        # without FQDN cannot connect to the server.
        #require_reverse_lookup = true;
 
@@ -55,13 +54,13 @@ General {
 
        # Maximum number of incoming connections allowed per single host.
        # For example, if this is one (1) it means a host can link only
-       # once to the server. Attempting to connect more than once would be
-       # refused. This can be overridden with ConnectionParams.
+       # once to the server.  Attempting to connect more than once would
+       # be 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.
+       # Required version of the remote side.  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")
@@ -75,7 +74,7 @@ General {
        #version_software = "1.3";
        #version_software_vendor = "SomeVendor";
 
-       # Default keepalive frequency (seconds). This can be overridden
+       # Default keepalive frequency (seconds).  This can be overridden with
        # with ConnectionParams.
        keepalive_secs = 300;
 
@@ -93,7 +92,7 @@ General {
        # reconnect_interval_max - maximum interval for reconnect, the
        #                          server never waits longer than this to
        #                          reconnect (seconds).
-       # reconnect_keep_trying  - whether to keep trying even after 
+       # reconnect_keep_trying  - whether to keep trying even after
        #                          reconnect_count is reached (the interval
        #                          will be reconnect_interval_max).
        #
@@ -103,39 +102,39 @@ General {
        reconnect_interval_max = 600;
        reconnect_keep_trying = true;
 
-       # Key exchange protocol rekey interval (seconds). How often to
-       # regenerate the session key with the remote. Initiator will perform
+       # 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 initiator.
        # This can be overridden with ConnectionParams.
        #key_exchange_rekey = 3600;
 
-       # Key exchange with Perfect Forward Secrecy (PFS). This will perform
+       # Key exchange with Perfect Forward Secrecy (PFS).  This will perform
        # the rekey process with PFS, making the new key more secure since it
-       # is not dependent in any way of the old key. This will make the rekey
+       # is not dependent in any way of the old key.  This will make the rekey
        # process somewhat slower, than without PFS.  This can be overridden
        # with ConnectionParams.
        #key_exchange_pfs = true;
 
-       # Key exchange timeout (seconds). If the key exchange protocol is not
+       # Key exchange timeout (seconds).  If the key exchange protocol is not
        # finished in this time period the remote connection will be closed.
        #key_exchange_timeout = 60;
 
-       # Connection authentication timeout (seconds). If the connection
+       # Connection authentication timeout (seconds).  If the connection
        # authentication protocol is not finished in this time period the
        # remote connection will be closed.
        #conn_auth_timeout = 60;
 
-       # Channel key rekey interval (seconds). How often channel key is
-       # regenerated. Note that channel key is regenerated also always when
-       # someone joins or leaves the channel.
+       # Channel key rekey interval (seconds).  How often channel key is
+       # regenerated.  Note that channel key is regenerated also always when
+       # 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
+       # 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;
@@ -188,7 +187,7 @@ ServerInfo {
        AdminEmail = "foo-admin@bar.com";
 
        #
-       # Run SILC server as specific user and group. The server must be 
+       # Run SILC server as specific user and group.  The server must be
        # initially run as root.
        #
        User = "nobody";
@@ -227,14 +226,19 @@ ServerInfo {
 # and "Fatals"
 #
 Logging {
+       # Use timestamp in the logging files? (Usually it is a good idea,
+       # but you may want to disable this if you run silcd under some
+       # daemontool).
+       Timestamp = true;
+
        # If QuickLogs is true, then the logging files will be updated
-       # real-time. This causes a bit more CPU and HDD activity, but
+       # real-time.  This causes a bit more CPU and HDD activity, but
        # reduces memory usage.  By default it is false and log files are
        # written with FlushDelay timeout.
        #
        #QuickLogs = true;
 
-       # FlushDelay tells log files update delay (seconds) in case you 
+       # FlushDelay tells log files update delay (seconds) in case you
        # have chosen buffering output.  This setting has effect only if
        # the QuickLogs is false.
        #
@@ -277,17 +281,17 @@ Logging {
 # ConnectionParams blocks defined.
 #
 ConnectionParams {
-       # unique name. The name is used to reference to this parameter 
-       # block from the connections. This field is mandatory.
+       # unique name.  The name is used to reference to this parameter
+       # block from the connections.  This field is mandatory.
        name = "normal";
 
-       # Maximum number of connections allowed. More connections will be
-       # refused. This can be used for example to limit number of clients.
+       # Maximum number of connections allowed.  More connections will be
+       # refused.  This can be used for example to limit number of clients.
        # Note that this never can be larger than the connections_max
        # specified in General section.
        connections_max = 200;
 
-       # Maximum number of connections allowed per host. For example, if
+       # Maximum number of connections allowed per host.  For example, if
        # this is one (1) it means a host can link only once to the server.
        # Attempting to link more than once would be refused.
        #
@@ -295,18 +299,18 @@ 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.
+       # Required version of the remote side.  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_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.
+       # and can be omitted.  These can be overridden with ConnectionParams.
        #version_protocol = "1.1";
        #version_software = "1.3";
        #version_software_vendor = "SomeVendor";
@@ -328,7 +332,7 @@ ConnectionParams {
        # reconnect_interval_max - maximum interval for reconnect, the
        #                          server never waits longer than this to
        #                          reconnect (seconds).
-       # reconnect_keep_trying  - whether to keep trying even after 
+       # reconnect_keep_trying  - whether to keep trying even after
        #                          reconnect_count is reached (the interval
        #                          will be reconnect_interval_max).
        reconnect_count = 7;
@@ -336,8 +340,8 @@ ConnectionParams {
        reconnect_interval_max = 600;
        reconnect_keep_trying = true;
 
-       # Key exchange protocol rekey interval (seconds). How often to
-       # regenerate the session key with the remote. Initiator will perform
+       # 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 initiator.
        #key_exchange_rekey = 3600;
 
@@ -363,7 +367,7 @@ ConnectionParams {
 # If both are provided then both password and public key based authentication
 # is allowed.  If the Publickey is used it includes the file path to the
 # public key file.  If none of them is provided then authentication is not
-# required.  The PublicKey can be set multiple times to set multiple 
+# required.  The PublicKey can be set multiple times to set multiple
 # public keys for one connection.
 #
 # Next example connection will match to all incoming client connections,
@@ -413,7 +417,7 @@ Admin {
 # required.
 #
 # 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
+# to true.  For normal connections set it false.  If it is set to true then
 # your server will be backup router.
 #
 ServerConnection {
@@ -448,7 +452,7 @@ ServerConnection {
 # If the connection is backup router connection then set the "BackupHost"
 # option 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
-# "BackupPort" option.  For normal connection leave both commented. If this
+# "BackupPort" option.  For normal connection leave both commented.  If this
 # backup router is in our cell then set the "BackupLocal" option to true.
 # If the backup router is in other cell then set it to false.
 #
@@ -469,7 +473,7 @@ RouterConnection {
 #
 # These connections are denied to connect to our server.
 #
-# The "Reason" field is mandatory, while the "Host" field can be omitted to 
+# The "Reason" field is mandatory, while the "Host" field can be omitted to
 # match everything.
 #
 #Deny {