tweakstreet-logo
  • Enter search terms

Apache vfs2

Apache vfs2 filesystem for sftp, ftp, http, zip, jar, tar

The apache vfs2 filesystem supports a variety of file protocols

Auth Options

Name Type Description
User
 string Username to use if none specified in file url.
Password
 string Password to use if none specified in file urls.
Domain
 string The domain to use for SMBv1 connections. Set to nil if not required.

Ftp Options

Name Type Description
User dir is root
 boolean Use user directory as root of the file system
Server Timezone
 string The time zone of the ftp server
Passive Mode
 boolean Check to enable FTP passive mode
Control Encoding
 string Encoding used communicating with the server.
Connect Timeout
 long Timeout when establishing connection in milliseconds, set to nil to disable timeout.
Data Timeout
 long Timeout reading from data channel, set to nil to disable timeout.
Socket Timeout
 long Timeout on ftp socket, set to nil to disable timeout.
Proxy Type
 string

Controls which type of proxy to use, if any:

  • If set to "none", no proxy is used
  • If set to "http", a http proxy is used
  • If set to "socks5", a socks5 proxy is used
Proxy Host
 string The hostname of the proxy
Proxy Port
 long The port number of the proxy
Proxy User
 string The username to use for the proxy
Proxy Password
 string The password to use for the proxy

Sftp Options

Name Type Description
User dir is root
 boolean Use user directory as root of the file system
Use exec Channel
 boolean Try using exec channel in addition to sftp to enable or speed up file operations
Known Hosts File
 string

Path to the known hosts file.

If nil or empty, the default known hosts file $HOME/.ssh/known_hosts is used.
Strict Host Key Checking
 string

This setting controls how server host keys are handled:

  • If set to "yes", host keys will never be automatically added to the $HOME/.ssh/known_hosts file, connections to hosts whose host key has changed are refused. As a result, you must manually add all new hosts.

  • If set to "no", new host keys are automatically added to the user known hosts files.
Preferred Auth Order
 string

Controls which order to try authentication methods in:

  • If set to "publickey,password", key based authentication is tried first, falling back to password authentication
  • If set to "password,publickey", password authentication is tried first, falling back to key based authentication
  • If set to "publickey", only key based authentication is tried
  • If set to "password", only password authentication is tried
Identities
 list

Supplies identities for key-based authentication.

A list of dicts each representing a key pair.

If nil or empty, default key pair id_rsa and id_rsa.pub in $HOME/.ssh is used.

Identities can be given as paths to key files, or as key file contents.

To provide identities through paths to key files, supply the following in an entry:

  • :private_key contains the absolute path to the private key file
  • :public_key contains the absolute path to the public key file. If nil or empty the private key path with suffix .pub is used.
  • :passphrase contains the password used to decrypt an ecnrypted private key. Set to nil or empty if the private key is not encrypted.

To provide identities as data, supply the following in an entry:

  • :private_key as a binary value of the full content of the private key file
  • :public_key as a binary value of the full content of the public key file
  • :passphrase contains the password used to decrypt an ecnrypted private key. Set to nil or empty if the private key is not encrypted.
Connect Timeout
 long Timeout when establishing connection in milliseconds.
Session Timeout
 long Timeout reading from socket on an established session in milliseconds.
Proxy Type
 string

Controls which type of proxy to use, if any:

  • If set to "none", no proxy is used
  • If set to "http", a http proxy is used
  • If set to "socks5", a socks5 proxy is used
Proxy Host
 string The hostname of the proxy
Proxy Port
 long The port number of the proxy
Proxy User
 string The username to use for the proxy
Proxy Password
 string The password to use for the proxy

Http Options

Name Type Description
Follow Redirects
 boolean Whether to follow HTTP redirects
User Agent
 string The user agent to set for HTTP requests
Url Charset
 string Charset of URL
Preemptive Auth
 boolean Send authentication pre-emptively, as opposed to only when challenged
Verify Hostname
 boolean If checked, verifies the hostname when using SSL
Key Store File
 string Path to key store file for SSL connections
Key Store Password
 string Password for key store file
Keep Alive
 boolean Set keep alive flag on requests
Connect Timeout
 long Timeout when establishing connection in milliseconds.
Socket Timeout
 long Socket timeout in milliseconds.
Max Connections per Host
 long Maximum connections open to a single host
Max Connections Total
 long Maximum total connections open
Proxy Host
 string The hostname of the proxy
Proxy Port
 long The port number of the proxy
Proxy User
 string The username to use for the proxy
Proxy Password
 string The password to use for the proxy

Zip, Jar, Tar Options

Name Type Description
Charset
 string Charset used for file paths in compressed archives.

Test Definition

You can test the filesystem definition from the context menu.

On this page