Mercurial > piecrust2
changeset 760:3cea11696a9e
docs: Add documentation about the SFTP publisher.
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Sat, 25 Jun 2016 17:18:26 -0700 |
parents | dd03385adb62 |
children | 4d8e82641597 |
files | docs/docs/99_reference/40_publishers.md |
diffstat | 1 files changed, 32 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/docs/99_reference/40_publishers.md Sat Jun 25 17:03:43 2016 -0700 +++ b/docs/docs/99_reference/40_publishers.md Sat Jun 25 17:18:26 2016 -0700 @@ -55,3 +55,35 @@ * `options` (`-avc --delete`): The options to pass to the `rsync` executable. By default, those will run `rsync` in "mirroring" mode. +The `rsync` provider support the simple URL syntax: + +``` +publish: + foobar: rsync://username:password@hostname/some/path +``` + + +## SFTP + +This publisher will connect to an FTP server over SSH, and upload the output of +the bake to a given directory. + +> PieCrust is using [Paramiko] for all the SFTP connection plumbing. + +* `type`: `sftp` +* `host`: The host to connect to (including a custom port, if any). +* `path`: The path to upload to (optional -- if not specified, the target path + is the remote user's home directory). +* `username`: Username to connect with (optional -- if specified, a password + will be prompted before uploading, if not, an SSH agent will be used to find + a key). + +The `sftp` provider supports the simple URL syntax: + +``` +publish: + foobar: sftp://username@hostname/some/path +``` + +[paramiko]: http://docs.paramiko.org/ +