SFTP

Access remote files through the SSH SFTP subsystem using username and password authentication.

Adapter type: sftp. See Common configuration for mounting instructions.

Setup

Enable SSH/SFTP and prepare an account that permits password login.
Identify a directory visible to that SFTP account; use the jailed path when chroot is enabled.
Enter host, port, credentials, and root, then verify access with a small file.

Configuration

Field	Type	Required	Default	Description
`host`	string	Yes	—	Server hostname or IP, without a scheme or directory.
`port`	number	No	`22`	Service port.
`username`	string	Yes	—	Remote account username.
`password`	password	Yes	—	Remote account password.
`root`	string	Yes	—	Directory on the backend, separate from the mount path displayed in Foxel.
`timeout`	number	No	`15`	Request or connection timeout in seconds.
`allow_unknown_host`	boolean	No	`true`	Automatically accept unknown host keys; see implementation limits below.

Example

This is a config object. In the admin form, fill the corresponding fields rather than pasting the whole object. Replace credential placeholders with your own values.

json

{
  "host": "sftp.example.com",
  "port": 22,
  "username": "sftpuser",
  "password": "YOUR_PASSWORD",
  "root": "/files",
  "timeout": 15,
  "allow_unknown_host": true
}

Behavior and limitations

No private-key, SSH agent, or known_hosts path option is exposed.
allow_unknown_host: true automatically accepts unknown host keys; verify the target over a trusted network.
The current implementation does not load system known_hosts. Setting the flag to false generally causes the new client to reject the unknown host; accepting it once in a terminal does not configure this adapter.

Troubleshooting

Authentication fails: confirm SSH permits password authentication; key-only accounts cannot be used.
Path missing: inspect the path through SFTP with the same account instead of assuming the SSH shell path applies.
Host key error: see the implementation limitation above; no custom fingerprint can be supplied.

References

External documentation provides service and authorization context. Use this page and the current Foxel adapter for configuration fields and limitations.