From 01dba9f77095b5f03102533169760a81c51f2205 Mon Sep 17 00:00:00 2001 From: Sander Date: Tue, 14 May 2024 22:11:41 +0000 Subject: [PATCH] Update README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a7c06fd..265fbff 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ or [pin nixpkgs yourself](https://nix.dev/reference/pinning-nixpkgs) - Allows specifying extra Nix configuration options via `extra_nix_config` - Allows specifying `$NIX_PATH` and channels via `nix_path` - Share `/nix/store` between builds using [cachix-action](https://github.com/cachix/cachix-action) for simple binary cache setup to speed up your builds and share binaries with your team -- Enables `flakes` and `nix-command` experimental features by default (to disable, set `experimental-features` via `extra_nix_config`) +- Enables KVM on supported machines: run VMs and NixOS tests with full hardware-acceleration ## Usage @@ -75,6 +75,19 @@ To install Nix from any commit, go to [the corresponding installer_test action]( - `enable_kvm`: whether to enable KVM for hardware-accelerated virtualization on Linux. Enabled by default if available. + +## Differences from the default Nix installer + +Some settings have been optimised for use in CI environments: + +- `nix.conf` settings: + + - The experimental `flakes` and `nix-command` features are enabled. Disable by overriding `experimental-features` in `extra_nix_config`. + + - `always-allow-substitutes` is set to `true`. Disable by overriding `always-allow-substitutes` in `extra_nix_config`. + +- KVM is enabled if available. Disable by setting `enable_kvm: false`. + --- ## FAQ