添加自定义缓存服务器
什么是 Nix 缓存服务器
Nix 提供了官方缓存服务器 https://cache.nixos.org，它缓存了 nixpkgs 中所有 packages 在常用 CPU 指令集下的构建结果，当你在本地执行 Nix 构建指令时，如果 Nix 在服务器中匹配到对应的缓存，就会直接下载该缓存文件，跳过耗时的本地编译构建从而大大提升构建速度。
为什么要添加自定义缓存服务器
注意：这里介绍的手段只能加速部分包的下载，许多 inputs 数据源仍然会从 Github 拉取。 另外如果找不到缓存，会执行本地构建，这通常仍然需要从国外下载源码与构建依赖，因此仍然会很慢。为了完全解决速度问题，仍然建议使用旁路网关或 TUN 等全局代理方案。
两个原因：
- 添加一些第三方项目的缓存服务器，例如 nix-community 的缓存服务器 https://nix-community.cachix.org，这可以大大提升这些第三方项目的构建速度。
- 添加离用户最近的缓存服务器镜像站，用于加速下载。
- 官方缓存服务器在中国的访问速度非常慢，如果没有局域网全局代理的话，基本上是无法使用的。添加国内的 ustc/sjtu/tuna 等 Nix 缓存镜像源可以缓解此问题。
如何添加自定义缓存服务器
Nix 中通过如下几个 options 来配置缓存服务器：
- substituters: 它是一个字符串数组，每个字符串都是一个缓存服务器的地址，Nix 会按照数组中的顺序依次尝试从这些服务器中查找缓存。
- trusted-public-keys: 为了防范恶意攻击，Nix 默认启用 require-sigs 功能，只有附带了签名、且签名能被
trusted-public-keys中的任意一个公钥验证通过的缓存，才会被 Nix 使用。因此我们需要将substituters对应的公钥添加到trusted-public-keys中。- 国内的镜像源都是直接从官方缓存服务器中同步的，因此它们的公钥与官方缓存服务器的公钥是一致的，我们可以直接使用官方缓存服务器的公钥，无需额外配置。
- 这种完全依赖公钥机制的验证方式，实际是将安全责任转嫁给了用户。用户如果希望使用某个第三方库，但又希望使用它的第三方缓存服务器加快构建速度，那就必须自己承担对应的安全风险，自行决策是否将该缓存服务器的公钥添加进
trusted-public-keys。为了完全解决这个信任问题，Nix 推出了实验特性 ca-derivations，它不依赖trusted-public-keys进行签名校验，有兴趣的可以自行了解。
可通过如下几种方式来配置 substituters trusted-public-keys 两个参数：
- 在
/etc/nix/nix.conf中配置，这是全局配置，对所有用户生效。- 可在任一 NixOS Module 中通过
nix.settings.substituters与nix.settings.trusted-public-keys来声明式地生成/etc/nix/nix.conf.
- 可在任一 NixOS Module 中通过
- 在 flake 项目的
flake.nix中通过nixConfig.substituters来配置，此配置仅对当前 flake 生效。 - 可通过
nix指令的--option substituters="http://xxx"参数来临时设定，此配置仅对当前指令生效。
上面三种方式中，除了第一种全局配置外，其他两种都是临时配置。如果同时使用了多种方式，那么后面的配置会直接覆盖前面的配置。
但临时设置 substituters 存在安全风险，前面我们也解释了基于 trusted-public-keys 的安全验证机制存在缺陷。 将一个不可信的缓存服务器添加到 substituters 中，可能会导致包含恶意内容的缓存被复制到 Nix Store 中。 因此 Nix 对 substituters 的临时设置做出了限制，要想通过第二三种方式设定 substituers，前提是满足如下任意一个条件：
/etc/nix/nix.conf中的trusted-users参数列表中包含当前用户。/etc/nix/nix.conf中的trusted-substituters参数列表中包含我们临时指定的 substituters.
基于上述信息，如下是上述三种配置方式的示例。
首先是通过 nix.settings 声明式地配置系统层面的 substituters 与 trusted-public-keys, 将如下配置添加到 /etc/nixos/configuration.nix 或其他任一 NixOS Module 中即可：
{
lib,
...
}: {
# ...
nix.settings = {
# given the users in this list the right to specify additional substituters via:
# 1. `nixConfig.substituters` in `flake.nix`
# 2. command line args `--options substituters http://xxx`
trusted-users = ["ryan"];
第二种方案是通过 flake.nix 配置 substituters 与 trusted-public-keys，将如下配置添加到 flake.nix 中即可：
如前所述，此配置中的
nix.settings.trusted-users也是必须配置的，否则我们在这里设置的substituters将无法生效。
{
description = "NixOS configuration of Ryan Yin";
# the nixConfig here only affects the flake itself, not the system configuration!
nixConfig = {
# override the default substituters
substituters = [
# cache mirror located in China
# status: https://mirror.sjtu.edu.cn/
"https://mirror.sjtu.edu.cn/nix-channels/store"
# status: https://mirrors.ustc.edu.cn/status/
# "https://mirrors.ustc.edu.cn/nix-channels/store"
以及第三种方案，使用如下命令在部署时临时指定 substituters 与 trusted-public-keys:
sudo nixos-rebuild switch --option substituters "https://nix-community.cachix.org" --option trusted-public-keys "nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs="选择上述三种方案的任一一种进行配置并部署，部署成功之后，后续所有的包都会优先从国内镜像源查找缓存。
如果你的系统 Hostname 不是
my-nixos，你需要在flake.nix中修改nixosConfigurations的名称，或者使用--flake /etc/nixos#my-nixos来指定配置名称。
Nix options 参数的 extra- 前缀
前面提到的三种方式配置的 substituters 会相互覆盖，但比较理想的情况应该是：
- 在系统层面的
/etc/nix/nix.conf中仅配置最通用的 substituters 与 trusted-public-keys，例如官方缓存服务器与国内镜像源。 - 在每个 flake 项目的
flake.nix中配置该项目特有的 substituters 与 trusted-public-keys，例如 nix-community 等非官方的缓存服务器。 - 在构建 flake 项目时，应该将
flake.nix与/etx/nix/nix.conf中配置的 substituters 与 trusted-public-keys 合并使用。
Nix 提供了 extra- 前缀 实现了这个合并功能。
据官方文档介绍，如果 xxx 参数的值是一个列表，那么 extra-xxx 参数的值会被追加到 xxx 参数的值后面：
也就是说我们可以这么用：
{
description = "NixOS configuration of Ryan Yin";
# the nixConfig here only affects the flake itself, not the system configuration!
nixConfig = {
# will be appended to the system-level substituters
extra-substituters = [
# nix community's cache server
"https://nix-community.cachix.org"
];
# will be appended to the system-level trusted-public-keys
extra-trusted-public-keys = [
# nix community's cache server public key
"nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs="
];
};
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-23.11";
# 省略若干配置...
};
outputs = inputs@{
self,
nixpkgs,
...
}: {
nixosConfigurations = {
ai = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [
./hardware-configuration.nix
./configuration.nix
{
# given the users in this list the right to specify additional substituters via:
# 1. `nixConfig.substituters` in `flake.nix`
nix.settings.trusted-users = [ "ryan" ];
通过代理加速包下载
参考了 Issue: roaming laptop: network proxy configuration - NixOS/nixpkgs
虽然前面提到了，旁路网关可以完全解决 NixOS 的包下载速度问题，但是旁路网关的配置比较麻烦，而且经常需要额外的硬件支持。
更多的用户可能会希望能直接通过 HTTP/Socks5 代理来加速包下载，这里介绍下怎么设置。
直接在 Terminal 中使用 export HTTPS_PROXY=http://127.0.0.1:7890 这类方式是无法生效的，因为 nix 实际干活的是一个叫 nix-daemon 的后台进程，而不是直接在 Terminal 中执行的命令。
nix-daemon 的实现代码是 nixpkgs/nixos/modules/services/system/nix-daemon.nix， 它通过 systemd.services.nix-daemon.environment 选项设置了环境变量，我们也能通过同样的手段来往 nix-daemon 的运行环境中添加代理相关的环境变量，一个示例 Module 如下：
{
systemd.services.nix-daemon.environment = {
# socks5h mean that the hostname is resolved by the SOCKS server
https_proxy = "socks5h://localhost:7891";
# https_proxy = "http://localhost:7890"; # or use http prctocol instead of socks5
};
}部署此配置后，可通过 sudo cat /proc/$(pidof nix-daemon)/environ | tr '\0' '\n' 查看 nix-daemon 进程的所有环境变量，确认环境变量的设置是否生效。
但是要注意，当代理服务器不可用时，nix-daemon 将无法访问任何缓存服务器！所以我还是更建议使用旁路网关等透明代理方案。
如果你只是临时需要使用代理，可以通过如下命令设置代理环境变量：
sudo mkdir /run/systemd/system/nix-daemon.service.d/
cat << EOF >/run/systemd/system/nix-daemon.service.d/override.conf
[Service]
Environment="https_proxy=socks5h://localhost:7891"
EOF
sudo systemctl daemon-reload
sudo systemctl restart nix-daemon位于 /run/systemd/system/nix-daemon.service.d/override.conf 的设置会在系统重启后被自动删除，或者你可以手动删除它并重启 nix-daemon 服务来恢复原始设置。
使用一些商用代理或公共代理时你可能会遇到 GitHub 下载时报 HTTP 403 错误（nixos-and-flakes-book/issues/74）， 可尝试通过更换代理服务器或者设置 access-tokens 来解决。