nix::CommonSSHStoreConfig Struct Reference

Inheritance diagram for nix::CommonSSHStoreConfig:

Collaboration diagram for nix::CommonSSHStoreConfig:

Public Member Functions
	StoreConfig ()=delete
Public Member Functions inherited from nix::StoreConfig
virtual const std::string	name ()=0
virtual std::string	doc ()
virtual std::optional< ExperimentalFeature >	experimentalFeature () const
	Config (StringMap initials={})
Public Member Functions inherited from nix::Config
	Config (StringMap initials={})
bool	set (const std::string &name, const std::string &value, const ApplyConfigOptions &options={}) override
void	addSetting (AbstractSetting *setting)
void	getSettings (std::map< std::string, SettingInfo > &res, bool overriddenOnly=false) override
void	resetOverridden () override
JSON	toJSON () override
void	convertToArgs (Args &args, const std::string &category) override
Public Member Functions inherited from nix::AbstractConfig
void	applyConfig (const std::string &contents, const ApplyConfigOptions &options={})
void	warnUnknownSettings ()
void	reapplyUnknownSettings ()

Public Attributes
const Setting< std::optional< uint16_t > >	port
const Setting< Path >	sshKey
const Setting< std::string >	sshPublicHostKey
const Setting< bool >	compress
const Setting< std::string >	remoteStore
Public Attributes inherited from nix::StoreConfig
const PathsSetting< Path >	storeDir_
const Path	storeDir = storeDir_
const Setting< int >	pathInfoCacheSize
const Setting< bool >	isTrusted
Setting< int >	priority
Setting< bool >	wantMassQuery
Setting< StringSet >	systemFeatures

Additional Inherited Members
Public Types inherited from nix::StoreConfig
typedef std::map< std::string, std::string >	Params
Public Types inherited from nix::Config
using	Settings = std::map<std::string, SettingData>
Static Public Member Functions inherited from nix::StoreConfig
static StringSet	getDefaultSystemFeatures ()
Protected Member Functions inherited from nix::AbstractConfig
	AbstractConfig (StringMap initials={})
Protected Attributes inherited from nix::AbstractConfig
StringMap	unknownSettings

Member Data Documentation

compress

const Setting<bool> nix::CommonSSHStoreConfig::compress

Initial value:

{this, false, "compress",
        "Whether to enable SSH compression."}

port

const Setting<std::optional<uint16_t> > nix::CommonSSHStoreConfig::port

Initial value:

{this, std::nullopt, "port",
        "Port that should be used instead of the default on the remote machine."}

remoteStore

const Setting<std::string> nix::CommonSSHStoreConfig::remoteStore

Initial value:

{this, "", "remote-store",
        R"(
          [Store URL](@docroot@/command-ref/new-cli/nix3-help-stores.md#store-url-format)
          to be used on the remote machine. The default is `auto`
          (i.e. use the Nix daemon or `/nix/store` directly).
        )"}

sshKey

const Setting<Path> nix::CommonSSHStoreConfig::sshKey

Initial value:

{this, "", "ssh-key",
        "Path to the SSH private key used to authenticate to the remote machine."}

sshPublicHostKey

const Setting<std::string> nix::CommonSSHStoreConfig::sshPublicHostKey

Initial value:

{this, "", "base64-ssh-public-host-key",
        "The public host key of the remote machine."}

---

The documentation for this struct was generated from the following file:

• lix/libstore/ssh-store.hh