0
@@ -7,52 +7,64 @@
0
 #
0
 # Using this sink will ultimately yield a command similar to:
0
 # <code>scp <local_path> <host>:<remote_path></code>
0
+#
0
+# When using <code>blanket-cfg</code> with the <code>-o Scp</code> argument,
0
+# you'll need to supply the correct details for the following attributes
0
+# in the source.yml file.
0
+#
0
+# [user] Username on the remote system.
0
+# [password] Password on the remote system.
0
+# [host] Domain name of the remote system.
0
+# [remote_path] The path on the remote system that you'd like to upload the blanket to.
0
+# [local_path] The location on client running the blanket where the database backup is stored before being sent to a sink.
0
+
0
+
0
 class Scp < Sink
0
   
0
-  def initialize(reader) # :nodoc:
0
+  def initialize(reader) #:nodoc:
0
     @reader = reader
0
   end
0
   
0
-  def self.attribute_symbols # :nodoc:
0
+  def self.attribute_symbols #:nodoc:
0
     [:sink_type, :host, :user, :password, :remote_path, :local_path ]
0
   end
0
   
0
-  def self.default_sink_type
0
+  def self.default_sink_type #:nodoc:
0
     "Scp"
0
   end
0
   
0
-  def self.default_host
0
+  def self.default_host #:nodoc:
0
     "yourhost.com"
0
   end
0
   
0
   # Your username on the remote system.
0
-  def self.default_user
0
+  def self.default_user #:nodoc:
0
     "username"
0
   end
0
   
0
   # Your password for the remote system.  May not be needed if you have
0
   # set up SSH keys.
0
-  def self.default_password
0
+  def self.default_password #:nodoc:
0
     "password"
0
   end
0
   
0
   # The path on the remote filesystem that you want to SCP the file.  You
0
   # may have success with relative paths, but I haven't.
0
-  def self.default_remote_path
0
+  def self.default_remote_path #:nodoc:
0
     "/path/to/remote/backup/directory"
0
   end
0
   
0
   # The path on the client filesystem where the backup file resides after
0
   # downloading from the source.  Right now, there is only good support
0
-  # for having this path within your blanket task directory itself.
0
-  # See http://bigfleet.lighthouseapp.com/projects/8764/tickets/4-remove-task-directory-dependence-for-storing-backup-file-on-client
0
-  def self.default_local_path
0
+  # for having this path within your blanket task directory itself. See the ticket.
0
+  # [http://bigfleet.lighthouseapp.com/projects/8764/tickets/4-remove-task-directory-dependence-for-storing-backup-file-on-client]
0
+  def self.default_local_path #:nodoc:
0
     "/path/to/local/blanket"
0
   end
0
   
0
   # Not sure how this will be used yet, planned for a part of an 
0
   # upcoming release.
0
-  def cleanup_command
0
+  def cleanup_command #:nodoc:
0
     noop
0
   end
0