From e3c28f050b13f51ffad059a593a66d23cbeb4908 Mon Sep 17 00:00:00 2001 From: Adam Ward Date: Mon, 14 Nov 2016 15:07:59 +1100 Subject: [PATCH] Added docs for remote_file SFTP Relates: chef/chef#4750 Closes: chef/chef-web-docs#220 Signed-off-by: Adam Ward --- chef_master/source/resource_remote_file.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/chef_master/source/resource_remote_file.rst b/chef_master/source/resource_remote_file.rst index 7b139ca9aa..77e2c08415 100644 --- a/chef_master/source/resource_remote_file.rst +++ b/chef_master/source/resource_remote_file.rst @@ -244,7 +244,7 @@ This resource has the following properties: ``source`` **Ruby Types:** String, Array - Required. The location of the source file. The location of the source file may be HTTP (``http://``), FTP (``ftp://``), local (``file:///``), or UNC (``\\host\share\file.tar.gz``). + Required. The location of the source file. The location of the source file may be HTTP (``http://``), FTP (``ftp://``), SFTP (``sftp://``), local (``file:///``), or UNC (``\\host\share\file.tar.gz``). There are many ways to define the location of a source file. By using a path: @@ -258,6 +258,12 @@ This resource has the following properties: source 'ftp://path/to/img/sketch.png' + By using SFTP: + + .. code-block:: ruby + + source 'sftp://username:password@remote_host:22/path/to/img/sketch.png' + By using a local path: .. code-block:: ruby