diff --git a/CLAUDE.md b/CLAUDE.md index 8921f0c..43018cf 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -101,6 +101,20 @@ Beyond `codex-setup.sh`/`codex-maintenance.sh` above, `scripts/` also has: - `scripts/env.sh` — shared config (`PROXMOX_HOST`, storage pool, bridge, default cores/memory) sourced by `create-proxmox-resource.sh`. Add new cross-script config here instead of duplicating it per-script. +- `scripts/configure-nix-cache-client.sh [--dry-run] [--no-remote-builder] + [--no-restart]` — the non-NixOS equivalent of + `modules/nix-cache/client.nix`/`remote-builder-client.nix`, for a plain + Debian machine with the Nix package manager (not NixOS) already + installed: run as root *on that machine* to add nix-cache as a + substituter in `/etc/nix/nix.conf` (`https://cache.nixos.org/` kept as + fallback) via `extra-substituters`/`extra-trusted-public-keys` so it + layers on top of whatever's already there instead of clobbering it, and, + if `/root/.ssh/nixremote` is already present (see docs/nix-cache.md + "Remote builder SSH keys"), configures it as a distributed-build + machine too and trusts nix-cache's SSH host key in + `/etc/ssh/ssh_known_hosts`. Idempotent (re-running replaces its own + marked block rather than duplicating it); restarts `nix-daemon` by + default so the change takes effect immediately. - `scripts/bump-nixpkgs-release.sh` — bumps `flake.nix`'s `nixpkgs.url`/ `home-manager.url` in place. Exists because flake input URLs can't reference `variables.nix` (confirmed empirically — `nix flake metadata` diff --git a/scripts/configure-nix-cache-client.sh b/scripts/configure-nix-cache-client.sh new file mode 100755 index 0000000..6c6c66f --- /dev/null +++ b/scripts/configure-nix-cache-client.sh @@ -0,0 +1,172 @@ +#!/usr/bin/env bash +# Points a non-NixOS Debian machine's Nix install at nix-cache: adds it as +# a substituter (with cache.nixos.org kept as fallback) and, once the +# remote-builder private key is installed, as a distributed-build machine +# too. +# +# This is the non-NixOS equivalent of modules/nix-cache/client.nix + +# modules/nix-cache/remote-builder-client.nix -- those two only apply to +# hosts built from this flake. A plain Debian box with Nix installed +# (single- or multi-user install, nix-daemon running) has no NixOS module +# system to pick that config up, so this edits /etc/nix/nix.conf by hand +# instead. Run this ON the target Debian machine, as root. +# +# The values below mirror variables.nix / modules/nix-cache/client.nix in +# this repo -- update both if nix-cache is ever rebuilt with a new host +# key or the cache signing key is rotated (see docs/nix-cache.md). +# +# Usage: +# sudo ./configure-nix-cache-client.sh [--dry-run] [--no-remote-builder] [--no-restart] +# +# Env overrides (defaults match variables.nix): +# NIX_CACHE_HOST, NIX_CACHE_HOST_KEY, REMOTE_BUILDER_USER, REMOTE_BUILDER_KEY + +set -euo pipefail + +: "${NIX_CACHE_HOST:=nix-cache}" +: "${NIX_CACHE_HOST_KEY:=ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIHrMKZlIGUd3pH9G3AqbsruqUGjxIXMAZw52u9MwiBCn lxc-nix-cache}" +: "${REMOTE_BUILDER_USER:=nixremote}" +: "${REMOTE_BUILDER_KEY:=/root/.ssh/nixremote}" + +CACHE_PUB_KEY="cache.local-1:usoWYanY3Kpq2+kDIS2nhWoLZiRxanmdysdzqCFBHW4=" +FALLBACK_URL="https://cache.nixos.org/" +FALLBACK_PUB_KEY="cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=" + +NIX_CONF="/etc/nix/nix.conf" +KNOWN_HOSTS="/etc/ssh/ssh_known_hosts" +MARKER_BEGIN="# BEGIN nix-cache client config (configure-nix-cache-client.sh)" +MARKER_END="# END nix-cache client config" + +dry_run=0 +with_remote_builder=1 +restart_daemon=1 + +for arg in "$@"; do + case "$arg" in + --dry-run) dry_run=1 ;; + --no-remote-builder) with_remote_builder=0 ;; + --no-restart) restart_daemon=0 ;; + -h|--help) + sed -n '2,20p' "$0" + exit 0 + ;; + *) + echo "ERROR: unknown argument: $arg" >&2 + exit 1 + ;; + esac +done + +if [[ "$dry_run" -eq 0 && "$EUID" -ne 0 ]]; then + echo "ERROR: must run as root (writes $NIX_CONF and, unless --no-remote-builder, $KNOWN_HOSTS)." >&2 + exit 1 +fi + +if ! command -v nix >/dev/null 2>&1; then + echo "ERROR: no 'nix' binary on PATH -- install the Nix package manager first." >&2 + exit 1 +fi + +if [[ ! -f "$NIX_CONF" ]]; then + echo "ERROR: $NIX_CONF not found -- expected an existing multi-user Nix install." >&2 + exit 1 +fi + +builder_line="" +if [[ "$with_remote_builder" -eq 1 ]]; then + if [[ -f "$REMOTE_BUILDER_KEY" ]]; then + case "$(uname -m)" in + x86_64) nix_system="x86_64-linux" ;; + aarch64) nix_system="aarch64-linux" ;; + *) + echo "WARNING: unrecognized architecture '$(uname -m)' -- skipping remote builder, keeping substituter config." >&2 + with_remote_builder=0 + ;; + esac + if [[ "$with_remote_builder" -eq 1 ]]; then + builder_line="builders = ssh://${REMOTE_BUILDER_USER}@${NIX_CACHE_HOST} ${nix_system} ${REMOTE_BUILDER_KEY} 4 2 big-parallel,kvm,nixos-test,benchmark" + fi + else + echo "WARNING: $REMOTE_BUILDER_KEY not found -- skipping remote builder config (substituter still configured)." >&2 + echo " See docs/nix-cache.md 'Remote builder SSH keys' for how to install it, then re-run this script." >&2 + with_remote_builder=0 + fi +fi + +block="$(cat < "$tmp_conf" + else + cp "$NIX_CONF" "$tmp_conf" + printf '\n%s\n' "$block" >> "$tmp_conf" + fi + + cp "$NIX_CONF" "${NIX_CONF}.bak.$(date +%Y%m%d%H%M%S)" + install -m 0644 "$tmp_conf" "$NIX_CONF" + echo "Updated $NIX_CONF (backup saved alongside it)." +fi + +if [[ "$with_remote_builder" -eq 1 ]]; then + known_hosts_line="${NIX_CACHE_HOST} ${NIX_CACHE_HOST_KEY}" + if [[ "$dry_run" -eq 1 ]]; then + echo "(--dry-run: would ensure this line is present in $KNOWN_HOSTS)" + echo " $known_hosts_line" + else + mkdir -p "$(dirname "$KNOWN_HOSTS")" + touch "$KNOWN_HOSTS" + if ! grep -qF "$known_hosts_line" "$KNOWN_HOSTS" 2>/dev/null; then + echo "$known_hosts_line" >> "$KNOWN_HOSTS" + echo "Added nix-cache's SSH host key to $KNOWN_HOSTS." + fi + fi +fi + +if [[ "$dry_run" -eq 0 && "$restart_daemon" -eq 1 ]]; then + if command -v systemctl >/dev/null 2>&1 && systemctl is-active --quiet nix-daemon 2>/dev/null; then + systemctl restart nix-daemon + echo "Restarted nix-daemon to pick up the new config." + else + echo "nix-daemon not managed by systemd (or not running) -- restart it manually to pick up the new config." + fi +fi + +cat <