[Zope-CVS] CVS: Packages/SFTPGateway/doc - README.txt:1.6

[Fred L. Drake, Jr.]

Update of /cvs-repository/Packages/SFTPGateway/doc
In directory cvs.zope.org:/tmp/cvs-serv23256

Modified Files:
	README.txt 
Log Message:
checkpoint some elaborations in the configuraiton docs


=== Packages/SFTPGateway/doc/README.txt 1.5 => 1.6 ===
--- Packages/SFTPGateway/doc/README.txt:1.5	Fri Dec 19 17:54:13 2003
+++ Packages/SFTPGateway/doc/README.txt	Fri Dec 19 20:43:27 2003
@@ -66,6 +66,14 @@
 Configuring SFTP Gateway
 ------------------------
 
+**SFTP Gateway** is a stand-alone SFTP server; it is not integrated
+with other servers at all.  In particular, it is not a replacement for
+the OpenSSH **sftp-server** component.  This necessitates some care in
+setting configuring the server and clients.  None of this is
+particularly difficult, but you need to be aware of the issues.
+
+XXX more is needed here
+
 The **SFTP Gateway** uses a configuration file to specify a handful of
 settings that control it's operation.  The software's **etc/**
 directory contains a sample configuraion file named **sample.conf**.
@@ -81,6 +89,9 @@
   port is omitted, port 22 is used.  If the hostname is omitted, all
   addresses handled by the system are used.
 
+  If a low-numbered port is used, the gateway will need to run as
+  ``root`` in order to bind the port.
+
   Examples::
 
     # This specifies both the hostname and port the SFTP server
@@ -129,12 +140,15 @@
   This is the path name of the private key file to use for incoming
   SSH2 connections.  If other SSH services are running on the system
   (such as the **sshd** server from OpenSSH), this should point to the
-  same host key used by those services.
+  same host key used by those services.  The gateway will need to run
+  as a user with permission to read this key file.
 
   Only one key can be specified at this time.
 
   Examples::
 
+    # This points to an OpenSSH private key:
+    #
     private-host-key  /etc/ssh/ssh_host_dsa_key
 
 
@@ -156,6 +170,8 @@
 
   Examples::
 
+    # This points to an OpenSSH public key:
+    #
     public-host-key   /etc/ssh/ssh_host_dsa_key.pub