Core Concepts
Techniques
FTP
The FTP action can upload and download files via FTP, SFTP, or FTPS. The files to be uploaded are evaluated using file generators. Downloaded file data is available either as an UTF-8 string, or as a base64-encoded string, and can be used in followup task runs via mechanic/actions/perform.
A connecting service like Couchdrop can be used to relay these uploads on to other cloud locations, like Dropbox, Google Drive, and Amazon S3.
A single FTP action may download a maximum of 20MB of data, across all downloaded files.
Options
Option
Description
hostRequired; the hostname of the destination server
userRequired; a string
uploadsOptional; an object whose keys are file paths (relative or absolute), and whose values are file generators
downloadsOptional; an array of file paths (relative or absolute) to download
modeOptional; only available for FTP; can be set to
"ascii"passwordOptional; a string
portOptional; an integer specifying the server port on which FTP or SFTP is available
private_key_pemOptional; only available for SFTP; a PEM-formatted certificate for authentication
protocolOptional; can be
"ftp", "sftp", or "ftps"Authentication
The
user option is always required.When connecting to an FTP or FTPS server, authenticate with the
password option.When connecting to an SFTP server, authenticate using either
password or private_key_pem. PEM certificates may be given directly in the task code:1
{% capture private_key_pem %}
2
-----BEGIN OPENSSH PRIVATE KEY-----
3
l0UGrDQWWbOpUsLENHwD5ya478pmRXarmDj5Wh31B54nmuq7be4ZKD5eh9nEV42JCl4mX6
4
...
5
pZ/WFoT82brhooSfJDue14C0Y=
6
-----END OPENSSH PRIVATE KEY-----
7
{% endcapture %}
8
9
{% action "ftp" %}
10
{
11
"host": "example.com",
12
"port": 22,
13
"user": "sftp_user",
14
"private_key_pem": {{ private_key_pem | json }}
15
"uploads": {
16
"success.txt": "hooray!"
17
}
18
}
19
{% endaction %}
Copied!
File paths
Both
uploads and downloads allow the task author to define file paths. If only the filename is given (e.g. "sample.pdf"), the file will be resolved in the home directory of the user. If a relative path (e.g. "subdirectory/sample.pdf") or absolute path (e.g. "/tmp/sample.pdf") is given, it will be respected accordingly.Example
This example action results in (a) an upload to an absolute path, starting from the server root, (b) an upload to a nested directory within the user's home folder, and (c) an upload to a nested directory in another user's home folder (which may fail, depending on filesystem permissions).
1
{% action "ftp" %}
2
{
3
...
4
"uploads": {
5
"/absolute/path/to/success.txt": "hooray!",
6
"relative/path/to/success.txt": "hooray!",
7
"../another/relative/path/to/success.txt": "hooray!"
8
}
9
}
10
{% endaction %}
Copied!
Result
This action returns the following data structure, most useful in combination with mechanic/actions/perform (see Responding to action results):
1
{
2
"log": "connect: ftp.couchdrop.io, 21\n< 220 Couchdrop FTPD\n> USER ********\n< 331 Username ok, send password.\n> PASS ********\n< 230 Welcome ********\n> TYPE I\n< 200 Type set to: Binary.\n> TYPE I\n< 200 Type set to: Binary.\n> PASV\n< 227 Entering passive mode (178,128,9,71,234,153).\n> STOR journal.txt\n< 125 Data connection already open. Transfer starting.\n< 226 Transfer complete.\n> TYPE I\n< 200 Type set to: Binary.\n> TYPE I\n< 200 Type set to: Binary.\n> PASV\n< 227 Entering passive mode (178,128,9,71,234,98).\n> STOR table.csv\n< 125 Data connection already open. Transfer starting.\n< 226 Transfer complete.\n> TYPE I\n< 200 Type set to: Binary.\n> TYPE I\n< 200 Type set to: Binary.\n> PASV\n< 227 Entering passive mode (178,128,9,71,234,135).\n> STOR invoice.pdf\n< 125 Data connection already open. Transfer starting.\n< 226 Transfer complete.\n> TYPE I\n< 200 Type set to: Binary.\n> TYPE I\n< 200 Type set to: Binary.\n> PASV\n< 227 Entering passive mode (178,128,9,71,234,101).\n> STOR secure.zip\n< 125 Data connection already open. Transfer starting.\n< 226 Transfer complete.\n> TYPE I\n< 200 Type set to: Binary.\n> TYPE I\n< 200 Type set to: Binary.\n> PASV\n< 227 Entering passive mode (178,128,9,71,234,100).\n> STOR external.jpg\n< 125 Data connection already open. Transfer starting.\n< 226 Transfer complete.\n> TYPE I\n< 200 Type set to: Binary.\n> TYPE I\n< 200 Type set to: Binary.\n> PASV\n< 227 Entering passive mode (178,128,9,71,234,183).\n> RETR journal.txt\n< 125 Data connection already open. Transfer starting.\n< 226 Transfer complete.\n> TYPE I\n< 200 Type set to: Binary.\n> TYPE I\n< 200 Type set to: Binary.\n> PASV\n< 227 Entering passive mode (178,128,9,71,234,149).\n> RETR table.csv\n< 125 Data connection already open. Transfer starting.\n< 226 Transfer complete.\n> TYPE I\n< 200 Type set to: Binary.\n",
3
"uploads": {
4
"invoice.pdf": {
5
"size": 7232
6
},
7
"secure.zip": {
8
"size": 205
9
},
10
"external.jpg": {
11
"size": 27661
12
}
13
},
14
"downloads": {
15
"journal.txt": {
16
"size": 12,
17
"data": "hello world!",
18
"data_base64": "aGVsbG8gd29ybGQh"
19
},
20
"table.csv": {
21
"size": 27,
22
"data": "Title,SKU\nRed T-Shirt,TEE-R",
23
"data_base64": "VGl0bGUsU0tVClJlZCBULVNoaXJ0LFRFRS1S"
24
}
25
}
26
}
Copied!
Note that each uploaded and downloaded file is keyed by the path provided for that file in the action's options. Downloaded file data is available as a UTF-8 string; for binary data that cannot be represented in UTF-8, use the base64-encoded version, possibly in concert with the decode_base64 filter.
Testing
If a server is unavailable for testing, consider using Couchdrop, with their hosted storage service. This is a (nearly) configuration-free avenue for testing, using the hosts ftp.couchdrop.io or sftp.couchdrop.io.
Alternatively, ngrok can be used to create a public tunnel to a local FTP or SSH server. By running
ngrok tcp 22 (adjusting for the appropriate local port), ngrok will generate a temporary public host and port that's appropriate for use while testing.Uploads are processed before downloads; it can be useful to test by uploading a file, and then immediately downloading it again:
1
{% action "ftp" %}
2
{
3
"host": "ftp.couchdrop.io",
4
...
5
"uploads": {
6
"hello-world.txt": "hello world!"
7
},
8
"downloads": [
9
"hello-world.txt"
10
]
11
}
12
{% endaction %}
Copied!
Example
This task compiles all SKUs with their titles and prices, and uploads it as a CSV every night or on demand.
Subscriptions
Code
1
mechanic/scheduler/daily
2
mechanic/user/trigger
Copied!
1
{% assign csv_rows = array %}
2
3
{% assign header = "SKU,Title,Price" | split: "," %}
4
{% assign csv_rows[0] = header %}
5
6
{% for product in shop.products %}
7
{% for variant in product.variants %}
8
{% assign title = variant.title %}
9
{% if title == "Default Title" %}
10
{% assign title = product.title %}
11
{% endif %}
12
13
{% assign row = array %}
14
{% assign row[row.size] = variant.sku %}
15
{% assign row[row.size] = title %}
16
{% assign row[row.size] = variant.price %}
17
18
{% assign csv_rows[csv_rows.size] = row %}
19
{% endfor %}
20
{% endfor %}
21
22
{% capture filename %}product-export-{{ "now" | date: "%Y-%m-%d" }}.csv{% endcapture %}
23
24
{% action "ftp" %}
25
{
26
"host": "example.com",
27
"port": 21,
28
"user": "anonymous",
29
"password": null,
30
"uploads": {
31
{{ filename | json }}: {{ csv_rows | csv | json }}
32
}
33
}
34
{% endaction %}
Copied!
Last modified 1mo ago
Copy link
Edit on GitHub