Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/numtide/nixos-facter
Declarative hardware configuration for NixOS [maintainer=@numtide]
https://github.com/numtide/nixos-facter
buildbot-numtide nix nixos
Last synced: 4 days ago
JSON representation
Declarative hardware configuration for NixOS [maintainer=@numtide]
- Host: GitHub
- URL: https://github.com/numtide/nixos-facter
- Owner: numtide
- License: other
- Created: 2024-06-12T08:51:04.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-16T10:24:33.000Z (6 days ago)
- Last Synced: 2024-12-18T00:40:23.958Z (5 days ago)
- Topics: buildbot-numtide, nix, nixos
- Language: Go
- Homepage: https://numtide.github.io/nixos-facter/
- Size: 6.16 MB
- Stars: 241
- Watchers: 14
- Forks: 6
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NixOS Facter
> [!NOTE]
> **Status: beta**
NixOS Facter aims to be an alternative to projects such as [NixOS Hardware] and [nixos-generate-config].
It solves the problem of bootstrapping [NixOS configurations] by deferring decisions about hardware and other
aspects of the target platform to NixOS modules.
We do this by first generating a machine-readable report (JSON) which captures detailed information about the machine
or virtual environment it was executed within.
This report is then passed to a series of [NixOS modules] which can make a variety of decisions,
some simple, some more complex, enabling things like automatic configuration of network controllers or graphics cards,
USB devices, and so on.
## Project Structure
This repository contains the binary for generating the report.
[NixOS Facter Modules] contains the necessary NixOS modules for making use of the report in a NixOS configuration.
For more information, please see the [docs].
## Quick Start
To generate a report using `nixos-facter` from nixpkgs:
```console
# you must run this as root
❯ sudo nix run --option experimental-features "nix-command flakes" nixpkgs#nixos-facter -- -o facter.json
```
To use the latest development version from this flake:
```console
# you must run this as root
❯ sudo nix run \
--option experimental-features "nix-command flakes" \
--option extra-substituters https://numtide.cachix.org \
--option extra-trusted-public-keys numtide.cachix.org-1:2ps1kLBUWjxIneOy1Ik6cQjb41X0iXVXeHigGmycPPE= \
github:numtide/nixos-facter -- -o facter.json
```
## Contributing
Contributions are always welcome!
## License
This software is provided free under [GNU GPL v3].
---
This project is supported by [Numtide](https://numtide.com/).
We’re a team of independent freelancers that love open source.
We help our customers make their project lifecycles more efficient by:
- Providing and supporting useful tools such as this one.
- Building and deploying infrastructure, and offering dedicated DevOps support.
- Building their in-house Nix skills, and integrating Nix with their workflows.
- Developing additional features and tools.
- Carrying out custom research and development.
[Contact us](https://numtide.com/contact) if you have a project in mind,
or if you need help with any of our supported tools, including this one.
We'd love to hear from you.
[NixOS configurations]: https://nixos.org/manual/nixos/stable/#sec-configuration-syntax
[NixOS Hardware]: https://github.com/NixOS/nixos-hardware
[NixOS Facter Modules]: https://github.com/numtide/nixos-facter-modules
[NixOS modules]: https://github.com/numtide/nixos-facter-modules
[nixos-generate-config]: https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/installer/tools/nixos-generate-config.pl
[Numtide Binary Cache]: https://numtide.cachix.org
[nixos-facter]: https://github.com/numtide/nixos-facter
[nixpkgs]: https://github.com/nixos/nixpkgs
[docs]: https://numtide.github.io/nixos-facter
[GNU GPL v3]: ./LICENSE