4781e7fa70
This makes for more useful manual table of contents, that displays the information at a glance. The `nix help-stores` command is kept as-is, even though it will show up in the manual with the same information as these pages due to the way it is written as a "`--help`-style" command. Deciding what to do with that command is left for a later PR. This change also lists all store types at the top of the respective overview page. Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems
30 lines
840 B
C++
30 lines
840 B
C++
#pragma once
|
|
///@file
|
|
|
|
#include "store-api.hh"
|
|
|
|
namespace nix {
|
|
|
|
struct CommonSSHStoreConfig : virtual StoreConfig
|
|
{
|
|
using StoreConfig::StoreConfig;
|
|
|
|
const Setting<Path> sshKey{this, "", "ssh-key",
|
|
"Path to the SSH private key used to authenticate to the remote machine."};
|
|
|
|
const Setting<std::string> sshPublicHostKey{this, "", "base64-ssh-public-host-key",
|
|
"The public host key of the remote machine."};
|
|
|
|
const Setting<bool> compress{this, false, "compress",
|
|
"Whether to enable SSH compression."};
|
|
|
|
const Setting<std::string> remoteStore{this, "", "remote-store",
|
|
R"(
|
|
[Store URL](@docroot@/store/types/index.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).
|
|
)"};
|
|
};
|
|
|
|
}
|