shajra-provisioning

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #llm #docker #nodejs #java #windows #vue #awesome-list #ios #openai #open-source

shajra-provisioning

(★ 42)

Personal provisioning machines with Nix

shajra-provisioning Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

- [About this project](#sec-1)
- [Community-curated configuration](#sec-2)
- [Basic operation](#sec-3)
- [Understanding this project](#sec-4)
- [Similar projects](#sec-5)
- [Release](#sec-6)
- [License](#sec-7)
- [Contribution](#sec-8)

[![img](https://github.com/shajra/shajra-provisioning/workflows/CI/badge.svg)](https://github.com/shajra/shajra-provisioning/actions)

# About this project<a id="sec-1"></a>

> This is either my love letter to Nix, or Nix's love letter to me, or both.

This project uses [Nix](https://nixos.org/nix) to provision three machines of mine. I may include more eventually.

The main idea of this project is to come into a vanilla OS installation and with only a few steps get a fully provisioned system including

-   all system-level and user-level packages installation and running services
-   all system-level and user-level “dot-file” configurations.

This project can be at least partially useful on any operating system that Nix can be installed on. For example, one of my machines runs NixOS, a full Linux operating system built upon Nix. Another runs macOS and has the Nix package manager installed within it.

Using Nix and the supporting Nix ecosystem gives us

-   strictly deterministic (reproducible) builds, package installation, and configuration
-   a concise and declarative configuration using community-curated modules
-   easy rollbacks of provisioning
-   easy updates
-   the ability to install multiple versions of software without worry of conflict.

A [provided introduction to Nix](doc/nix-introduction.md) explains motivations to use Nix more.

This repository is designed to be forked and modified. The likelihood that anyone else will want my exact configuration is infinitesimal. Still, you can look at this project to see how the code is laid out. For the most part, it just shows a recommended way to use a few tools to get a reasonably complete provisioning. If you're interested, I've documented [more about my personal configuration](doc/ux.md) in a separate document.

# Community-curated configuration<a id="sec-2"></a>

This project delegates heavily to the following tools:

-   [NixOS's `nixos-rebuild`](https://nixos.org/manual/nixos/stable/index.html#sec-changing-config), for NixOS system-level provisioning
-   [Nix-Darwin](https://daiderd.com/nix-darwin), for macOS system-level provisioning with Nix
-   [The Home Manager project for Nix](https://github.com/nix-community/home-manager), to provision a home directory in either NixOS or macOS.

Each project gives us a community-curated catalog of configuration modules that dramatically simplify the code we need. Our configurations can end up extraordinarily concise and declarative. Here's an example:

```text
{
    …
    hardware.pulse.audio.enable = true;
    …
}
```

You can find these configurations concretely in the [./home](./home) and [./machines](./machines) directories.

Upstream configuration modules also provide a battery of checking to make sure settings are valid and congruent.

# Basic operation<a id="sec-3"></a>

The only prerequisite should be the installation of the Nix package manager, after which we can execute the following commands.

> **WARNING:** Don't actually clone this repository and run the commands below. You'd attempt to turn your computer into mine.

On a NixOS machine:

```sh
nix run github:shajra/shajra-provisioning#shajra-nixos-rebuild boot
nix run github:shajra/shajra-provisioning#shajra-home-manager switch
```

On macOS with Nix installed:

```sh
nix run github:shajra/shajra-provisioning#shajra-darwin-rebuild switch
nix run github:shajra/shajra-provisioning#shajra-home-manager switch
```

In practice, my configuration requires [a little more setup](unmanaged/README.md) than just the installation of the Nix package manager.

Managing the home directory with a separate command from the command for system-level configuration is a design decision to help with system stability. We can experiment more with our user-level configuration without accidentally breaking the whole system. We don't even need to use the system-level provisioning if we don't want to, and we can use Home Manager alone.

Most of the time, I'm not bootstrapping a machine from scratch. I'll clone the repository to a target system. Then I can develop the code using `nix develop` which enters a shell, puts some helpful commands on the `PATH`, and prints a helpful message documenting these commands:

```sh
nix develop
```

[[general commands]]
    
      menu                           - prints this menu
      project-activate-system        - activate (switch) system configuration for this host
      project-bootstrap              - partial root config to run installers (missing SSH config)
      project-build                  - build both system and home configuration for this host
      project-build-home             - build both home configuration for this host
      project-build-system           - build both system configuration for this host
      project-check-caching          - check package caching assumptions
      project-check-caching-build    - check caching of packages expected to build
      project-check-caching-prebuilt - check caching of expected prebuilt packages
      project-check-flake            - run all flake checks
      project-format                 - format all files in one command
      project-install-home           - install home configuration for this host
      project-install-system         - install system configuration for this host (on NixOS, boot record only)
    
    [[release]]
    
      project-check                  - 2) check flake and builds comprehensively
      project-doc-gen                - 3) generate GitHub Markdown from Org files
      project-install                - 4) install both system and home configuration for this host
      project-update                 - 1) update project dependencies

Some of these "project-" commands detect the current platform and call the appropriate "shajra-" command (also on the `PATH`), which then calls the appropriate upstream command (`home-manager`, `nixos-rebuild`, or `darwin-rebuild`). Each "shajra-" command then detects the hostname to invoke the correct configuration. The goal of all these wrappers is to remove the need to call any of the "project-" commands with arguments.

Note, because all of the code needed for provisioning is within this repository, rolling back to a previous version can be as simple as checking out an alternate commit in history, and provisioning from that.

# Understanding this project<a id="sec-4"></a>

Many third-party software and conventions come together to enable all the features of this provisioning project. Hopefully, the code is well-factored and comprehensible, but it's still a lot to look at when coming in fresh.

To help, this project provides some standalone guides to help get started, linked below.

If you don't know much about Nix, consider reading the following provided guides:

-   [Introduction to Nix and motivations to use it](doc/nix-introduction.md)
-   [Nix installation and configuration guide](doc/nix-installation.md)
-   [Nix end user guide](doc/nix-usage-flakes.md)
-   [Introduction to the Nix programming language](doc/nix-language.md)

This project leans heavily on an experimental Nix feature called *flakes*. This project is built on top of another project called [Nix-project](https://github.com/shajra/nix-project), which factors out some helpful code for Nix projects in general. Nix-project doesn't have a lot of code and primarily builds on top of another project called [Flake-parts](https://github.com/hercules-ci/flake-parts). Flake-parts helps make working with flakes a little easier.

Once you're comfortable with Nix and basic usage, these next guides (two from another project) can help you get up to speed with this project:

-   [Nix-project's flakes basic development guide](https://github.com/shajra/nix-project/blob/main/doc/project-developing-basics.md)
-   [Nix-project's flake modules development guide](https://github.com/shajra/nix-project/blob/main/doc/project-developing-modules.md)
-   [A walk-through of this project](doc/provisioning-walkthrough.md)

The development guide introduces Nix flakes and Flake-parts in the context of Nix-project. The guide also covers some patterns for making packages typical in the Nix ecosystem (`callPackage` and *overlays*).

Finally, the walk-through explains how all of these projects and patterns come together in this project to provision my machines.

# Similar projects<a id="sec-5"></a>

This project wasn't made in isolation. It's just one of many other similar projects out there. I looked at all of these, some more than others:

-   [bkase/life](https://github.com/bkase/life)
-   [divnix/devos](https://github.com/divnix/devos)
-   [martinbaillie/dotfiles](https://github.com/martinbaillie/dotfiles)
-   [michaelpj/nixos-config](https://github.com/michaelpj/nixos-config)
-   [rossabaker/nix-config](https://gitlab.com/rossabaker/nix-config)

# Release<a id="sec-6"></a>

The "main" branch of the GitHub repository has the latest version of this code. There is currently no commitment to either forward or backward compatibility.

"user/shajra" branches are personal branches that may be force-pushed to. The "main" branch should not experience force-pushes and is recommended for general use.

# License<a id="sec-7"></a>

All files in this "shajra-provisioning" project are licensed under the terms of GPLv3 or (at your option) any later version.

Please see the [./COPYING.md](./COPYING.md) file for more details.

# Contribution<a id="sec-8"></a>

Feel free to file issues and submit pull requests with GitHub.

There is only one author to date, so the following copyright covers all files in this project:

shajra-provisioning

shajra-provisioning Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

shajra-provisioning

shajra-provisioning Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README