Skip to content

SFTP (Destination)

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy

Uploads Parquet files to a remote SFTP server.

Configuration

yaml
warehouse:
  kind: sftp
  host: sftp.example.com
  username: user
  password: ${SFTP_PASSWORD}
  remote_path: "/data/output"
FieldDefaultDescription
host(required)SFTP server hostname
port22SSH port
username(required)SSH username
passwordPassword authentication
private_key_pathPath to SSH private key
remote_path(required)Remote directory for uploads

Authentication

Use either a password or an SSH private key. Prefer private-key auth for long-lived pipelines. For security best practices, we strongly advise against storing the password in skippr.yaml. Use environment variable interpolation instead: replace the password value with your own ${ENV_VAR} reference.

The relevant part of skippr.yaml looks like this:

yaml
warehouse:
  kind: sftp
  password: ${SFTP_PASSWORD}

Set the env var before running skippr:

macOS / Linux

bash
export SFTP_PASSWORD="secret"

Windows PowerShell

powershell
$env:SFTP_PASSWORD = "secret"

Windows Command Prompt

cmd
set SFTP_PASSWORD=secret

Permissions or Network Requirements

The SSH user needs write access to the configured remote path, and the runner must be able to reach the SFTP host on the configured port.

Troubleshooting

SymptomFix
authentication failedVerify the username, password or private key path, and any host-based access controls.
uploads failCheck remote_path, available disk space, and whether the SSH user can create files in that directory.

Next steps

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy