[Zope-CVS] CVS: Packages/SFTPGateway/etc - sample.conf:1.3

[Fred L. Drake, Jr.]

Update of /cvs-repository/Packages/SFTPGateway/etc
In directory cvs.zope.org:/tmp/cvs-serv25927

Modified Files:
	sample.conf 
Log Message:
added more documentation, mostly to cover the <runner> section, but
also a little about the logging section


=== Packages/SFTPGateway/etc/sample.conf 1.2 => 1.3 ===
--- Packages/SFTPGateway/etc/sample.conf:1.2	Tue Dec 23 15:39:47 2003
+++ Packages/SFTPGateway/etc/sample.conf	Tue Jan  6 15:56:05 2004
@@ -7,6 +7,25 @@
 # You may either copy this file and edit the copy, or use it as a
 # model for your configuration file.
 #
+# SFTP Gateway configuration files consist of a series of sections:
+#
+#   sftp-gateway
+#     This contains information specific to the operation of the
+#     gateway itself.  This section is required.
+#
+#   runner
+#     Configuration to support running SFTP Gateway using the
+#     sftpgatewayctl script.  This section is required only by
+#     sftpgatewayctl.
+#
+#   logger
+#     The logger section configures logging for the gateway.  This may
+#     also be used by the sftpgatewayctl script if alternate logging
+#     information is not provided in that section.  A default
+#     configuration will be used if none is provided.
+#
+# These sections are described in this order in this file.
+#
 # There are three configuration settings which must be given, and a
 # fourth which is optional.  These are all specified in the
 # "sftp-gateway" section.
@@ -70,3 +89,96 @@
 #public-host-key    /etc/ssh/ssh_host_dsa_key.pub
 
 </sftp-gateway>
+
+
+# For convenience, define two variables that will be used a few times
+# in the remainder of the sample configuration.  The "%define" syntax
+# is a feature of the ZConfig configuration language.
+
+%define base    /opt/Zope/SFTPGateway
+%define logfile $base/log/sftpgateway.log
+
+
+# The <runner> section is used to configure the "daemonizer" invoked
+# by the sftpgatewayctl script.  The daemonizer is a common component
+# used for many applications in Zope, so needs a little more
+# configuration than may be expected.  There are many options which
+# can be set here, but there are only two that are really required,
+# and one more which can be very useful when initially setting up a
+# new configuration.
+
+<runner>
+
+# program
+#
+# This specifies the command which actually runs the gateway; the only
+# change that should be needed from this sample value is the name of
+# the configuration file to use.
+#
+program   $base/bin/sftpgateway -C etc/sftpgateway.conf
+
+# daemon
+#
+# This specifies whether the gateway should be run as a Unix "daemon"
+# process or as a normal foreground process.  The value should be
+# 'yes' or 'no' (without quotes).  The default is 'no'.  This should
+# be set to 'yes' for all production servers.
+#
+daemon    yes
+
+# logfile
+#
+# (Optional.)
+#
+# This is only needed if you want to use sftpgatewayctl's "logtail"
+# command.  This is mostly useful when setting up a new installation
+# and you want to check that everything is working properly (or want
+# to see what went wrong!).  The "logtail" command is similar to the
+# Unix "tail -f" command, but uses this configuration setting to
+# determine what file to show.
+#
+# This should point to the log file of daemonizer.  If a logging
+# configuration section is specified inside the <runner> section, this
+# could be set to a file mentioned in a <logfile> handler section, or
+# it could be set to some log generated as a side-effect of syslog
+# logging.  If there is no logging section specific to the <runner>
+# section, the daemonizer will use the logging section at the top
+# level if there is one, in which case this setting should indicate
+# some file created by that configuration.
+#
+logfile   $logfile
+
+</runner>
+
+
+# Logger configuration is entirely optional.  SFTP Gateway can use
+# either the traditional <eventlog> section as used by the Zope
+# application server, or an alternate <logger> section, which is (very
+# slightly) more general.
+#
+# The details of the <eventlog> and <logger> sections will be
+# described elsewhere.  This sample should get you started:
+
+<logger>
+  name          sftpgateway
+  propagate     no
+  level         info
+
+  # A <logger> supports one or more "handlers".  Several can be
+  # specified if desired.
+  #
+  # The most common type of handler is <logfile>.  This is used to
+  # specify that the log is written directly to a file in the
+  # filesystem of the local machine.
+  #
+  <logfile>
+    path        $logfile
+    dateformat  %Y-%m-%d %H:%M:%S
+    format      %(asctime)s %(name)s %(message)s
+  </logfile>
+
+  # Other types of handlers include <syslog> and (for high-priority
+  # events) <email-notifier>.  Each type of handler can contain
+  # settings appropriate to the behavior it implements.
+
+</logger>