Skip to main content

SSHStorageConfig

SSHStorageConfig represents the configuration that will be used if storage type is ssh within the client usage.
It composes of host, port, and credentials.

Each instance is produced automatically when creating a new rac-delta client with ssh storage type.


Structure

export interface SSHStorageConfig extends BaseStorageConfig {
type: 'ssh';
host: string;
port?: number;
credentials: {
username: string;
password?: string;
privateKey?: string;
};
}

Properties

PropertyTypeDescription
typesshConst string that identifies this configuration as ssh storage configuration.
hoststringHost to connect to ssh.
portnumberOptional port to connect to ssh, default is 22
credentialsObjectCredentials to connect to ssh host, username, password and optional private key