Read from the package's own PHP files at the commit 206fff7d82de: its namespaces, classes, interfaces and enums, their public constants, properties and methods with their PHPDoc, and the options its factories take. Nothing of it is run.
SftpDriveFactoryclassA directory of an SFTP server, over SSH, through league/flysystem-sftp-v3 (phpseclib 3, pure PHP: no ssh2 extension):
7 options
Omnidrive\Sftp
SftpDriveFactory class
final class SftpDriveFactory extends FlysystemDriveFactory SftpDriveFactory.php:26
A directory of an SFTP server, over SSH, through league/flysystem-sftp-v3 (phpseclib 3, pure PHP: no ssh2 extension):
(new SftpDriveFactory())->create(['host' => 'backup.example.org', 'username' => 'site', 'private_key' => '/run/secrets/id_ed25519', 'root' => '/srv/backup']);
Options: host and username (required), password, private_key (a path or the key itself) and its passphrase, use_agent (the SSH agent's keys), port (22), root (the directory behind the drive's paths, "/"), host_fingerprint (the server's key checked, "SHA256:..." or the MD5 form phpseclib gives), timeout (10 s), max_tries (4), public_url, visibility, directory_visibility, permissions (as every drive).
The connection is opened on the first operation, not here.
Options
| Option | Default | |
|---|---|---|
port | 22 | |
root | '/' | |
use_agent | false | |
timeout | 10 | |
max_tries | 4 | |
host | required | |
username | required |