Skip to content
Weik.ioDocs
2026.2
Try Weik.io

Your first transfer

Weik.io 2026.2

Write a transfer in YAML and publish it with weikio apply, like any integration. Product page · Video

Watch: Your first transfer, 3:51

The video writes the supplier-invoices transfer with weikio init --kind mft and applies it.

On this page

You write a transfer as a document of kind: mft instead of a Camel route. Weik.io runs rclone on the transfer’s schedule.

Start from the scaffold#

weikio init writes a transfer that runs as soon as you deploy it:

Terminal
$ weikio init supplier-invoices --kind mft --project finance

With operation: copy, the scaffold’s transfer copies files on a schedule from a source to a local folder under /var/lib/weikio/mft/supplier-invoices. An agent on Linux can write to that folder. The fields you add next, such as the filters list of patterns for the files to copy, are commented out.

The supplier invoices transfer#

The finance team collects a supplier’s invoice PDFs from the supplier’s FTP server every morning at five and moves them into Azure Blob storage.

finance/transfers/supplier-invoices.yaml
apiVersion: weik.io/v1
kind: mft
metadata: { name: supplier-invoices, project: finance }
spec:
  schedule: "0 0 5 * * ?"
  source:      { remote: supplier-ftp,      path: /outgoing }
  destination: { remote: invoice-archive,   path: invoices/incoming }
  operation: move
  filters: ["*.pdf"]
Field What it says
schedule A cron expression in UTC whose six fields start with the seconds. 0 0 5 * * ? is every day at 05:00 UTC.
source, destination The rclone remote and the path on it. A remote is the name of a variable that has the remote’s definition, or the definition itself.
operation The rclone command to run. Most transfers use copy, move or sync. Other rclone commands such as check work too.
filters Patterns for the files to move. Only files that match one of them move.

The two ends#

Each remote is a variable whose value is the remote’s rclone definition. In place of the password, the definition has a placeholder for a secret:

finance/variables/supplier-ftp.yaml
apiVersion: weik.io/v1
kind: variable
metadata: { name: supplier-ftp, project: finance }
spec:
  value: |
    type = ftp
    host = ftp.supplier.example
    user = weikio
    pass = {{supplier-ftp-password}}
finance/variables/invoice-archive.yaml
apiVersion: weik.io/v1
kind: variable
metadata: { name: invoice-archive, project: finance }
spec:
  value: |
    type = azureblob
    account = financearchive
    key = {{invoice-archive-key}}

Set the two secrets for devtest with the CLI rather than in a file:

Terminal
$ weikio secret set finance/supplier-ftp-password --env devtest
$ weikio secret set finance/invoice-archive-key --env devtest

Before you promote the transfer, set the two secrets for production the same way.

See Remotes and credentials for every way to write a remote. One of them puts the transfer and its remotes in a single file.

Publish it#

Terminal
$ weikio apply -f ./finance/

The apply fails on a field that isn’t valid, such as an operation that the agent’s rclone doesn’t have. Otherwise it publishes the transfer as a version that doesn’t run until you deploy it.

In the admin UI, choose New integration and the kind File transfer. The same document then opens in the editor.

Sign in to the live demo

Sign in with the shared viewer account. It can open every screen of the example projects but can't change anything.

E-mail
viewer@demo.weik.io
Password
try-weikio-live-demo
Open the live demo