Nix-Darwin Configuration

Table of Contents

• Repository Structure
• Features
• Setup Tutorial
  • Prerequisites
  • Installation Steps
  • 1Password Setup
• Usage Guide
  • Updating Your System
  • Adding New Packages
  • Adding New Applications
  • Changing User Information
• Customization
  • System Preferences
  • Shell Configuration
  • Git Configuration
  • Window Management
• Troubleshooting

A declarative macOS system configuration using nix-darwin, home-manager, and homebrew.

Repository Structure

/etc/nix-darwin/
├── flake.nix               # Main configuration entry point
├── config/
│   ├── default.nix         # Import all configurations
│   ├── home.nix            # Home-manager configuration
│   ├── homebrew.nix        # Homebrew packages and casks
│   ├── packages.nix        # System packages configuration
│   └── system.nix          # System preferences and defaults
├── apps/
│   ├── default.nix         # Import all app configurations
│   ├── aerospace/
│   │   └── aerospace.flake # Aerospace window manager configuration
│   ├── git/
│   │   └── git.flake       # Git configuration 
│   └── zsh/
│       └── zsh.flake       # ZSH shell configuration
├── scripts/
│   └── fetch-email.sh      # Script for 1Password email fetching
└── README.md               # This file

Features

• Declarative System Configuration: Define your entire macOS setup in code
• Package Management: Manage packages with Nix and Homebrew
• Dotfile Management: Configure your shell and tools with home-manager
• Reproducible: Easily replicate your setup on a new machine
• 1Password Integration: Securely retrieve secrets from 1Password
• Modular Structure: Easily maintain and extend configurations
• External Scripts: Separation of logic from configuration
• Window Management: Tiling window management with Aerospace

Setup Tutorial

Prerequisites

• macOS 12+
• Administrative access

Installation Steps

1. Install Nix package manager using Lix (recommended):

   curl -sSf -L https://install.lix.systems/lix | sh -s -- install --nix-build-group-id 30000

   • Answer Y when prompted to install Nix
   • Answer Y when prompted to set up the nix-daemon

2. Source the Nix profile:

   . /nix/var/nix/profiles/default/etc/profile.d/nix-daemon.sh

3. Create and set permissions for the nix-darwin directory:

   sudo mkdir -p /etc/nix-darwin
   sudo chown $(id -nu):$(id -ng) /etc/nix-darwin

4. Clone this repository (or create a new one from the template):

   # Option 1: Clone this repository
   git clone https://github.com/dededecline/nixos-config.git /etc/nix-darwin
   
   # Option 2: Create a new configuration from template
   cd /etc/nix-darwin
   nix flake init -t nix-darwin/nix-darwin-24.11

5. If using Option 2, customize the configuration files to match your needs.

6. Apply the configuration:

   nix run nix-darwin/nix-darwin-24.11#darwin-rebuild -- switch

7. After the first install, you can use the simplified command:

   darwin-rebuild switch

1Password Setup

This configuration uses 1Password to store sensitive information such as your Git email. To set this up:

1. Install 1Password (already included in the configuration)

2. Create an item in 1Password with the title "git-email" and a field called "email"

3. Ensure you're signed in to 1Password CLI:

   op signin

Usage Guide

Updating Your System

Update and rebuild your system with:

darwin-rebuild switch --flake /etc/nix-darwin

Or use the alias defined in the configuration:

update

Adding New Packages

1. Edit config/packages.nix to add system-wide packages
2. Edit config/homebrew.nix to add Homebrew packages or casks
3. Edit config/home.nix to add user-specific packages

Adding New Applications

To add a new application configuration:

1. Create a new directory in apps/ for your application
2. Create a configuration file (e.g., myapp.flake)
3. Add it to the imports in apps/default.nix

Example for a new app configuration:

# apps/newapp/newapp.flake
{ pkgs, user, ... }: {
  home-manager.users.${user.username} = { ... }: {
    programs.newapp = {
      enable = true;
      # Configuration options here
    };
  };
}

Changing User Information

User information is centralized in flake.nix (or config/host.nix if extracted):

user = {
  name = "Dani Klein";
  username = "daniklein";
  githubUsername = "dededecline";
  homeDirectory = "/Users/daniklein";
};

Customization

System Preferences

System preferences are configured in config/system.nix.

Shell Configuration

Shell aliases and configuration are defined in apps/zsh/zsh.flake.

Git Configuration

Git settings are configured in apps/git/git.flake.

Window Management

Aerospace window manager settings are configured in apps/aerospace/aerospace.flake. This includes:

• Keyboard shortcuts for window manipulation
• Gap and padding settings
• Window layouts and workspace configuration
• Application-specific rules
• Integration with sketchybar and borders

Troubleshooting

If you encounter issues:

1. Check Nix store permissions:

   sudo chown -R root:wheel /nix

2. Ensure proper permissions on configuration directory:

   sudo chown -R $(id -nu):$(id -ng) /etc/nix-darwin

3. For more help, consult:

   • nix-darwin documentation
   • home-manager documentation