Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added docs for remote_file SFTP #234

Merged
merged 1 commit into from
Nov 14, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion chef_master/source/resource_remote_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down