Config

common config

{
 
  // string - sftp or ftp
  scheme: "sftp", 
 
  // string - Hostname or IP address of the server.
  host: "host",

  // integer - Port number of the server.
  port: 22,

  // string - Username for authentication.
  username: "username",

   // string - Password for password-based user authentication.
  password: null,

  // string - An absolute path on remote. This will be the root path of remote file system.
  rootPath: "/", 

  // integer - How long (in milliseconds) to wait for the connect to complete. 
  connectTimeout: 10000,
}

SFTP only Config

{
  // string - Path to ssh-agent's UNIX socket for ssh-agent-based user authentication.  Windows users: set to 'pageant' for authenticating with Pageant or (actual) path to a cygwin "UNIX socket".
  agent: null, 

  // string - Absolute path to user private key.
  privateKeyPath: null, 

  // mixed - For an encrypted private key, this is the passphrase string used to decrypt it. Set to true for enable passphrase dialog. This will prevent from using cleartext passphrase in this config.
  passphrase: null,

  // boolean - Set to true for enable verifyCode dialog. Keyboard interaction authentication mechanism. For example using Google Authentication (Multi factor)
  // (requires the server to have keyboard-interactive authentication enabled)
  interactiveAuth: false, 

  // Explicit overrides for the default transport layer algorithms used for the connection.
  algorithms: {
    "kex": [
      "ecdh-sha2-nistp256",
      "ecdh-sha2-nistp384",
      "ecdh-sha2-nistp521",
      "diffie-hellman-group-exchange-sha256",
      "diffie-hellman-group14-sha1"
    ],
    "cipher": [
      "aes128-ctr",
      "aes192-ctr",
      "aes256-ctr",
      "aes128-gcm",
      "[email protected]",
      "aes256-gcm",
      "[email protected]"
    ],
    "serverHostKey": [
      "ssh-rsa",
      "ecdsa-sha2-nistp256",
      "ecdsa-sha2-nistp384",
      "ecdsa-sha2-nistp521"
    ],
    "hmac": [
      "hmac-sha2-256",
      "hmac-sha2-512",
      "hmac-sha1"
    ]
  }
}