Skip to content
Weik.ioDocs
2026.2
Try Weik.io

Remotes and credentials

Weik.io 2026.2

Write each end of a transfer as an rclone remote, in a variable or inline, and keep its credentials in secrets. 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

Write each end of a transfer as an rclone remote:

  • An FTP or SFTP server
  • An S3 bucket
  • An Azure storage account
  • A folder on the agent’s host

Any other rclone backend works too. Refer to a remote by name in the transfer, or write its definition inline.

A remote in a variable#

Keep a remote in a variable whose value is the remote’s rclone definition. Several transfers can then share the remote. The variable’s value can also differ by environment:

finance/variables/supplier-sftp.yaml
apiVersion: weik.io/v1
kind: variable
metadata: { name: supplier-sftp, project: finance }
spec:
  value: |
    type = sftp
    host = sftp.supplier.example
    user = weikio
    pass = {{supplier-sftp-password}}

The field names are rclone’s, as rclone config writes them for that backend. A transfer uses the remote by the variable’s name:

source: { remote: supplier-sftp, path: /outgoing }

Credentials#

Write a password or a key inside a remote as a {{placeholder}} for a secret, so the rest of the definition stays readable in Git and reviewable in a pull request. Then set the secret with the CLI:

Terminal
$ weikio secret set finance/supplier-sftp-password --env production

On every start, Weik.io sends the agent the remote with its secrets filled in. The agent writes it into the deployment’s rclone.conf, as What the agent sets up shows. A deploy whose remote needs a secret with no value in the environment fails and says which secret is missing.

When the server’s password changes, set the secret again. The transfer gets the new value at its next start. To restart it now, add --restart:

Terminal
$ weikio secret set finance/supplier-sftp-password --env production --restart

Everything in one file#

Separate documents for the transfer and its two remotes help when several transfers share a server, or when devtest and production use different servers. A one-off transfer doesn’t need them.

apply accepts multi-document YAML, so the two variables and the transfer can be in one supplier-invoices.yaml, separated by ---. Or write the rclone settings of each remote inline, in remote:

finance/transfers/supplier-invoices.yaml
apiVersion: weik.io/v1
kind: mft
metadata: { name: supplier-invoices, project: finance }
spec:
  schedule: "0 0 5 * * ?"
  source:
    remote: { type: ftp, host: ftp.supplier.example, user: weikio, pass: "{{supplier-ftp-password}}" }
    path: /outgoing
  destination:
    remote: { type: azureblob, account: financearchive, key: "{{invoice-archive-key}}" }
    path: invoices/incoming
  operation: move
  filters: ["*.pdf"]

Inline or named#

An inline remote is the same in every environment. Changing it makes a new version of the transfer. With a placeholder such as host: "{{supplier-ftp-host}}", each environment can have its own host. The kind of remote still stays fixed in the version, so devtest can’t be a local folder while production is an FTP server.

Use inline remotes for a transfer that runs in one environment only. Move the remotes into variables when you promote the transfer or when a second transfer needs the same server, as To production shows.

Check a transfer’s ends#

To check where each end of a transfer points, open the transfer’s page in the admin UI.

Remote Shown as
Inline Its type and place, such as SFTP sftp.supplier.example:/outgoing, Azure Blob invoices/incoming or local folder /var/lib/weikio/mft/outgoing
Inline, with the host from a value Its type and path, and the value that sets the host, as in SFTP /outgoing (host set by supplier-sftp-host)
In a variable or a secret Its name and path, such as bank-sftp:/outgoing

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