sftp

Documentation

Overview

Package sftp implements blob storage provided for SFTP/SSH.

Index

• func New(ctx context.Context, opts *Options, isCreate bool) (blob.Storage, error)
• type Options

Functions

func New

func New(ctx context.Context, opts *Options, isCreate bool) (blob.Storage, error)

New creates new ssh-backed storage in a specified host.

Types

type Options

type Options struct {
	Path string `json:"path"`

	Host     string `json:"host"`
	Port     int    `json:"port"`
	Username string `json:"username"`
	// if password is specified Keyfile/Keydata is ignored.
	Password       string `json:"password" kopia:"sensitive"`
	Keyfile        string `json:"keyfile,omitempty"`
	KeyData        string `json:"keyData,omitempty" kopia:"sensitive"`
	KnownHostsFile string `json:"knownHostsFile,omitempty"`
	KnownHostsData string `json:"knownHostsData,omitempty"`

	ExternalSSH  bool   `json:"externalSSH"`
	SSHCommand   string `json:"sshCommand,omitempty"` // default "ssh"
	SSHArguments string `json:"sshArguments,omitempty"`

	sharded.Options
	throttling.Limits
}

Options defines options for sftp-backed storage.