Skip to content

Commit e86fad4

Browse files
authored
docs/nixos-facter: move to upstream module (#611)
2 parents c39fbfb + b2e1f1d commit e86fad4

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

docs/quickstart.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -179,38 +179,31 @@ machine to be saved.
179179

180180
#### 8.1 nixos-facter
181181

182-
As an alternative to `nixos-generate-config`, you can use the experimental
183-
[nixos-facter](https://github.com/numtide/nixos-facter) command, which offers
184-
more comprehensive hardware reports and advanced configuration options.
182+
As an alternative to `nixos-generate-config`, you can use
183+
[nixos-facter](https://github.com/nix-community/nixos-facter), which offers more
184+
comprehensive hardware reports and advanced configuration options. The
185+
nixos-facter module is included in nixpkgs and automatically configures drivers,
186+
kernel modules, firmware, and various hardware support based on the detected
187+
hardware.
185188

186-
To use `nixos-facter`, add the following to your flake inputs:
187-
188-
```diff
189-
{
190-
+ inputs.nixos-facter-modules.url = "github:numtide/nixos-facter-modules";
191-
}
192-
```
193-
194-
Next, import the module into your configuration and specify `facter.json` as the
195-
path where the hardware report will be saved:
189+
To use `nixos-facter`, specify `facter.json` as the path where the hardware
190+
report will be saved:
196191

197192
```diff
198193
nixosConfigurations.generic-nixos-facter = nixpkgs.lib.nixosSystem {
199194
system = "x86_64-linux";
200195
modules = [
201196
disko.nixosModules.disko
202197
./configuration.nix
203-
+ nixos-facter-modules.nixosModules.facter
204-
+ { config.facter.reportPath = ./facter.json }
198+
+ { hardware.facter.reportPath = ./facter.json; }
205199
];
206200
};
207201
```
208202

209203
To generate the configuration for `nixos-facter` with `nixos-anywhere`, use the
210204
following flags: `--generate-hardware-config nixos-facter ./facter.json`. The
211-
second flag, `./facter.json`, specifies where `nixos-generate-config` will store
212-
the hardware report. Adjust this path to suit the location where you want the
213-
`facter.json` to be saved.
205+
second argument, `./facter.json`, specifies where `nixos-facter` will store the
206+
hardware report. Adjust this path to suit your flake layout.
214207

215208
### 9. Run it
216209

0 commit comments

Comments
 (0)