nix-super/doc/manual/source/package-management/ssh-substituter.md

63 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2020-07-23 00:17:48 +03:00
# Serving a Nix store via SSH
You can tell Nix to automatically fetch needed binaries from a remote
Nix store via SSH. For example, the following installs Firefox,
automatically fetching any store paths in Firefoxs closure if they are
available on the server `avalon`:
2020-07-31 16:43:25 +03:00
```console
$ nix-env --install --attr nixpkgs.firefox --substituters ssh://alice@avalon
2020-07-31 16:43:25 +03:00
```
2020-07-23 00:17:48 +03:00
This works similar to the binary cache substituter that Nix usually
uses, only using SSH instead of HTTP: if a store path `P` is needed, Nix
will first check if its available in the Nix store on `avalon`. If not,
it will fall back to using the binary cache substituter, and then to
building from source.
> **Note**
>
> The SSH substituter currently does not allow you to enter an SSH
> passphrase interactively. Therefore, you should use `ssh-add` to load
> the decrypted private key into `ssh-agent`.
You can also copy the closure of some store path, without installing it
into your profile, e.g.
2020-07-31 16:43:25 +03:00
```console
$ nix-store --realise /nix/store/m85bxg…-firefox-34.0.5 --substituters
2020-07-31 16:43:25 +03:00
ssh://alice@avalon
```
2020-07-23 00:17:48 +03:00
This is essentially equivalent to doing
2020-07-31 16:43:25 +03:00
```console
$ nix-copy-closure --from alice@avalon
/nix/store/m85bxg…-firefox-34.0.5
```
2020-07-23 00:17:48 +03:00
You can use SSHs *forced command* feature to set up a restricted user
account for SSH substituter access, allowing read-only access to the
local Nix store, but nothing more. For example, add the following lines
to `sshd_config` to restrict the user `nix-ssh`:
Match User nix-ssh
AllowAgentForwarding no
AllowTcpForwarding no
PermitTTY no
PermitTunnel no
X11Forwarding no
ForceCommand nix-store --serve
Match All
On NixOS, you can accomplish the same by adding the following to your
`configuration.nix`:
2020-07-31 16:43:25 +03:00
```nix
nix.sshServe.enable = true;
nix.sshServe.keys = [ "ssh-dss AAAAB3NzaC1k... bob@example.org" ];
```
2020-07-23 00:17:48 +03:00
where the latter line lists the public keys of users that are allowed to
connect.