Add documentation for the newly added SFTP transporter.

wimleers · Apr 16, 2011 · 99331c3 · 99331c3
1 parent 3a51d53
commit 99331c3
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/code/INSTALL.txt b/code/INSTALL.txt
@@ -121,3 +121,21 @@ Processor module: link_updater
 * instructions:
  1) download the Python Egg from http://code.google.com/p/cssutils/
  2) easy_install cssutils-<VERSION>-py<PYTHON VERSION>.egg
+
+
+==============================================================================
+| Per-transporter module additional instructions                             |
+==============================================================================
+
+Transporter module: sftp
+------------------------
+This transporter requires the Python module "paramiko" to be installed.
+
+* homepage: http://www.lag.net/paramiko/
+* instructions:
+	- Debian/Ubuntu: sudo apt-get install python-paramiko
+	- Other:
+		1. download 1.7.4 or newer from http://www.lag.net/paramiko/download/
+		2. extract
+		3. cd to the extracted folder (where setup.py lives)
+		2. easy_install ./
diff --git a/code/README.txt b/code/README.txt
@@ -244,6 +244,21 @@ Available settings:
 - host
 - username
 - password
+- url
+- port
+- path
+- key
+
+
+Transporter: SFTP (sftp)
+------------------------
+Value to enter: "sftp".
+
+Available settings:
+- host
+- username
+- password
+- url
 - port
 - path