Merged from silc_1_0_branch.

[silc.git] / doc / example_silcd.conf.in

diff --git a/doc/example_silcd.conf.in b/doc/example_silcd.conf.in
index 9a79a679760774ec982f1097e67847bed9e1df89..41426d40497cc96af54d9858257d251fc5784657 100644 (file)
--- a/doc/example_silcd.conf.in
+++ b/doc/example_silcd.conf.in
@@ -138,6 +138,25 @@ General {
        # sessions are persistent as long as server is running.
        #detach_disabled = true;
        #detach_timeout = 1440;
+
+       # Quality of Service (QoS) settings.  The QoS can be used to handle
+       # the incoming data and limit its handling rate to avoid flooding.
+       # By default QoS is disabled and can be enabled by setting "qos" to
+       # true value.  The "qos_rate_limit" is the data reads per second,
+       # and if more frequently is read due to for example data flooding,
+       # QoS is applied to the data.  The "qos_bytes_limit" is maximum bytes
+       # allowed for incoming data.  If more is received at once the QoS
+       # is applied to the data.  The "qos_limit_sec" and "qos_limit_usec"
+       # is the timeout used to delay the data handling, seconds and
+       # microseconds, respectively.  NOTE: If you enable QoS in General
+       # section it applies to server connections as well.  Server
+       # connections SHOULD NOT use QoS.  This can be overridden with
+       # ConnectionParams.
+       #qos = true;
+       #qos_rate_limit = 10;
+       #qos_bytes_limit = 2048;
+       #qos_limit_sec = 0;
+       #qos_limit_usec = 500000;
 };
 
 #
@@ -351,8 +370,29 @@ ConnectionParams {
        # process somewhat slower, than without PFS.
        #key_exchange_pfs = true;
 
-       #TODO:
-       #connections_interval - incoming connection interval limit ?
+       # Anonymous connection.  This setting has effect only when this
+       # this is used with client connections.  If set to true then clients
+       # using this connection parameter will be anonymous connections.
+       # This means that the client's username and hostname information
+       # is scrambled and anonymous mode is set for the user.
+       #anonymous = true;
+
+       # Quality of Service (QoS) settings.  The QoS can be used to handle
+       # the incoming data and limit its handling rate to avoid flooding.
+       # By default QoS is disabled and can be enabled by setting "qos" to
+       # true value.  The "qos_rate_limit" is the incmoing data reading
+       # per second, and if more frequently than the set limit is read the
+       # QoS is applied to the data.  The "qos_bytes_limit" is maximum bytes
+       # allowed for incoming data.  If more is received at once the QoS
+       # is applied to the data.  The "qos_limit_sec" and "qos_limit_usec"
+       # is the timeout used to delay the data handling, seconds and
+       # microseconds, respectively.  For server connections QoS SHOULD NOT
+       # be set.
+       #qos = true;
+       #qos_rate_limit = 10;
+       #qos_bytes_limit = 2048;
+       #qos_limit_sec = 0;
+       #qos_limit_usec = 500000;
 };
 
 #
@@ -365,10 +405,9 @@ ConnectionParams {
 #
 # The authentication data is specified by Passphrase and/or PublicKey.
 # 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
-# public keys for one connection.
+# is allowed.  The "PublicKey" includes the single key contained in the
+# specified file, while "PublicKeyDir" includes all files in the specified
+# directory, which must all be valid public keys with ".pub" suffix.
 #
 # Next example connection will match to all incoming client connections,
 # and no authentication is required.
@@ -376,9 +415,10 @@ ConnectionParams {
 Client {
        #Host = "10.1.*";
        #Passphrase = "secret";
-       #PublicKey = "/path/to/the/user_my.key";
-       #PublicKey = "/path/to/the/user_221.key";
-       #PublicKey = "/path/to/the/user_313.key";
+       #PublicKey = "/path/to/the/user_my.pub";
+       #PublicKey = "/path/to/the/user_221.pub";
+       #PublicKey = "/path/to/the/user_313.pub";
+       #PublicKeyDir = "/path/to/keys/dir/";
        Params = "normal";
 };
 
@@ -399,7 +439,7 @@ Admin {
        User = "priikone";
        Nick = "pekka";
        Passphrase = "verysecret";
-       # PublicKey = "/path/to/the/public.key";
+       # PublicKey = "/path/to/the/public.pub";
 };
 
 #
@@ -423,7 +463,7 @@ Admin {
 ServerConnection {
        Host = "10.2.1.7";
        Passphrase = "verysecret";
-       #PublicKey = "/path/to/the/public.key";
+       #PublicKey = "/path/to/the/public.pub";
        Params = "normal";
        Backup = false;
 };
@@ -460,7 +500,7 @@ RouterConnection {
        Host = "10.2.1.100";
        Port = 706;
        Passphrase = "verysecret";
-       #PublicKey = "/path/to/the/public.key";
+       #PublicKey = "/path/to/the/public.pub";
        Params = "normal";
        Initiator = true;
        #BackupHost = "10.2.1.6";