1
0
Fork 0
mirror of https://github.com/LnL7/nix-darwin.git synced 2024-12-15 17:51:01 +00:00
nix modules for darwin
Find a file
2020-05-11 22:26:37 +02:00
.github/workflows add debug action 2020-03-29 12:41:47 +02:00
doc/manual doc: fix module references 2019-05-04 21:23:53 +02:00
modules Set up XDG system environment variables sort of how they set them up 2020-05-11 06:56:21 -04:00
pkgs installer: try creating /run using synthetic.conf 2020-03-28 19:12:21 +01:00
tests Merge pull request #195 from hauleth/ft/add-dnsmasq-service 2020-05-03 18:57:17 +02:00
.gitignore Adds attrs type for defaults. Adds additional Dock settings. 2017-12-28 12:23:29 +09:00
CHANGELOG add changelog entry for manual 2019-05-04 16:15:55 +02:00
default.nix fix evaluation of darwin.pkgs for recent nixpkgs 2020-03-22 23:13:59 +01:00
LICENSE add license 2017-07-19 20:53:33 +02:00
README.md update badge 2020-03-28 19:24:59 +01:00
release.nix Merge pull request #195 from hauleth/ft/add-dnsmasq-service 2020-05-03 18:57:17 +02:00

logo

nix-darwin

Test

Nix modules for darwin, /etc/nixos/configuration.nix for macOS.

Install

nix-build https://github.com/LnL7/nix-darwin/archive/master.tar.gz -A installer
./result/bin/darwin-installer

or if you run into problems with that, try the older bootstrap.sh script

NOTE: the system activation scripts don't overwrite existing etc files, so files like /etc/bashrc and /etc/zshrc won't be updated by default. If you didn't use the installer or skipped some of the options you'll have to take care of this yourself. Either modify the existing file to source/import the one from /etc/static or remove it. Some examples:

  • mv /etc/bashrc /etc/bashrc.orig
  • echo 'if test -e /etc/static/bashrc; then . /etc/static/bashrc; fi' | sudo tee -a /etc/bashrc
  • echo 'if test -e /etc/static/bashrc; then . /etc/static/bashrc; fi' | tee -a ~/.bashrc

Updating

The installer will configure a channel for this repository.

nix-channel --update darwin
darwin-rebuild changelog

Uninstalling

There's also an uninstaller if you don't like the project and want to remove the configured files and services.

nix-build https://github.com/LnL7/nix-darwin/archive/master.tar.gz -A uninstaller
./result/bin/darwin-uninstaller

Example configuration

Check out modules/examples for some example configurations.

{ pkgs, ... }:
{
  # List packages installed in system profile. To search by name, run:
  # $ nix-env -qaP | grep wget
  environment.systemPackages =
    [ pkgs.vim
    ];

  # Auto upgrade nix package and the daemon service.
  services.nix-daemon.enable = true;
  nix.package = pkgs.nix;
}

Manual Install

sudo ln -s private/var/run /run

# Configure the channel
nix-channel --add https://github.com/LnL7/nix-darwin/archive/master.tar.gz darwin
nix-channel --update
export NIX_PATH=darwin-config=$HOME/.nixpkgs/darwin-configuration.nix:$HOME/.nix-defexpr/channels:$NIX_PATH

# Or use a local git repository
git clone git@github.com:LnL7/nix-darwin.git ~/.nix-defexpr/darwin
export NIX_PATH=darwin=$HOME/.nix-defexpr/darwin:darwin-config=$HOME/.nixpkgs/darwin-configuration.nix:$NIX_PATH

cp ~/.nix-defexpr/darwin/modules/examples/simple.nix ~/.nixpkgs/darwin-configuration.nix

# you can also use this to rebootstrap nix-darwin in case
# darwin-rebuild is to old to activate the system.
$(nix-build '<darwin>' -A system --no-out-link)/sw/bin/darwin-rebuild build
$(nix-build '<darwin>' -A system --no-out-link)/sw/bin/darwin-rebuild switch

. /etc/static/bashrc

... or for fish:

(nix-build '<darwin>' -A system --no-out-link)/sw/bin/darwin-rebuild build
(nix-build '<darwin>' -A system --no-out-link)/sw/bin/darwin-rebuild switch

This will create and manage a system profile in /run/current-system, just like nixos.

The default NIX_PATH in nix-darwin will look for this repository in ~/.nix-defexpr/darwin and for your configuration in ~/.nixpkgs/darwin-configuration.nix. If you want to change these you can set your own with nix.nixPath = [ ];.

$ darwin-rebuild switch
building the system configuration...
these derivations will be built:
  /nix/store/vfad6xgjzr56jcs051cg6vzch4dby92y-etc-zprofile.drv
  /nix/store/cbmkscxsz0k02ynaph5xaxm1aql0p3vq-etc.drv
  /nix/store/r5fpn177jhc16f8iyzk12gcw4pivzpbw-nixdarwin-system-16.09.drv
building path(s) /nix/store/wlq89shja597ip7mrmjv7yzk2lwyh8n0-etc-zprofile
building path(s) /nix/store/m8kcm1pa5j570h3indp71a439wsh9lzq-etc
building path(s) /nix/store/l735ffcdvcvy60i8pqf6v00vx7lnm6mz-nixdarwin-system-16.09
setting up /etc...
setting up launchd services...
writing defaults...
$
$ darwin-option services.activate-system.enable                                                                                                                                            ~/src/nix-darwin
Value:
true

Default:
false

Example:
no example

Description:
Whether to activate system at boot time.

Documentation

Reference documentation of all the options is available here https://lnl7.github.io/nix-darwin/manual/index.html#sec-options. This can also be accessed locally using man 5 configuration.nix.

There's also a small wiki https://github.com/LnL7/nix-darwin/wiki about specific topics, like macOS upgrades.

Tests

There are basic tests that run sanity checks for some of the modules, you can run them like this:

nix-build release.nix -A tests.environment-path

Contributing

Let's make nix on darwin awesome! Don't hesitate to contribute modules or open an issue.

To build your configuration with local changes you can run this. This flag can also be used to override darwin-config or nixpkgs, for more information on the -I flag look at the nix-build manpage.

darwin-rebuild switch -I darwin=.

Also feel free to contact me if you have questions,

  • IRC - LnL, you can find me in #nixos or #nix-darwin on freenode.net
  • @lnl7 on twitter