2017-02-19 16:49:00 +00:00
[<img src="https://lnl7.github.io/nix-darwin/images/nix-darwin.png" width="200px" alt="logo" /> ](https://github.com/LnL7/nix-darwin )
2016-12-12 16:37:50 +00:00
# nix-darwin
2016-11-01 20:25:22 +00:00
2020-03-28 18:24:59 +00:00
![Test ](https://github.com/LnL7/nix-darwin/workflows/Test/badge.svg )
2017-02-19 14:00:27 +00:00
2016-12-15 11:39:56 +00:00
Nix modules for darwin, `/etc/nixos/configuration.nix` for macOS.
2016-12-15 21:03:06 +00:00
2016-12-11 12:33:01 +00:00
## Install
2017-06-03 09:27:22 +00:00
```bash
2018-01-14 18:29:30 +00:00
nix-build https://github.com/LnL7/nix-darwin/archive/master.tar.gz -A installer
./result/bin/darwin-installer
2017-06-03 09:27:22 +00:00
```
2018-01-14 18:29:30 +00:00
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:
2017-06-03 09:24:48 +00:00
- `mv /etc/bashrc /etc/bashrc.orig`
- `echo 'if test -e /etc/static/bashrc; then . /etc/static/bashrc; fi' | sudo tee -a /etc/bashrc`
2017-06-03 09:27:22 +00:00
- `echo 'if test -e /etc/static/bashrc; then . /etc/static/bashrc; fi' | tee -a ~/.bashrc`
2017-06-03 09:24:48 +00:00
2017-06-03 10:00:13 +00:00
## Updating
2018-01-14 18:29:30 +00:00
The installer will configure a channel for this repository.
2017-06-03 10:00:13 +00:00
```bash
2017-09-06 21:37:34 +00:00
nix-channel --update darwin
2017-07-24 21:27:41 +00:00
darwin-rebuild changelog
2017-06-03 10:00:13 +00:00
```
2018-01-15 23:54:35 +00:00
## Uninstalling
There's also an uninstaller if you don't like the project and want to
remove the configured files and services.
```bash
nix-build https://github.com/LnL7/nix-darwin/archive/master.tar.gz -A uninstaller
./result/bin/darwin-uninstaller
```
2017-06-03 09:24:48 +00:00
## Example configuration
Check out [modules/examples ](https://github.com/LnL7/nix-darwin/tree/master/modules/examples ) for some example configurations.
```nix
{ pkgs, ... }:
{
# List packages installed in system profile. To search by name, run:
# $ nix-env -qaP | grep wget
environment.systemPackages =
2018-08-21 20:42:33 +00:00
[ pkgs.vim
2017-06-03 09:24:48 +00:00
];
2018-03-26 20:47:40 +00:00
# Auto upgrade nix package and the daemon service.
services.nix-daemon.enable = true;
nix.package = pkgs.nix;
2017-06-03 09:24:48 +00:00
}
```
## Manual Install
2016-12-11 12:49:00 +00:00
2016-12-11 12:33:01 +00:00
```bash
2016-12-18 16:58:09 +00:00
sudo ln -s private/var/run /run
2017-10-10 20:21:30 +00:00
# Configure the channel
nix-channel --add https://github.com/LnL7/nix-darwin/archive/master.tar.gz darwin
nix-channel --update
2019-10-17 12:59:00 +00:00
export NIX_PATH=darwin-config=$HOME/.nixpkgs/darwin-configuration.nix:$HOME/.nix-defexpr/channels:$NIX_PATH
2016-12-11 14:17:04 +00:00
2017-10-10 20:21:30 +00:00
# Or use a local git repository
git clone git@github.com:LnL7/nix-darwin.git ~/.nix-defexpr/darwin
2016-12-15 14:03:57 +00:00
export NIX_PATH=darwin=$HOME/.nix-defexpr/darwin:darwin-config=$HOME/.nixpkgs/darwin-configuration.nix:$NIX_PATH
2016-12-11 12:33:01 +00:00
2017-10-10 20:21:30 +00:00
cp ~/.nix-defexpr/darwin/modules/examples/simple.nix ~/.nixpkgs/darwin-configuration.nix
2016-12-15 14:03:57 +00:00
# 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
2016-12-15 11:39:56 +00:00
$(nix-build '< darwin > ' -A system --no-out-link)/sw/bin/darwin-rebuild switch
2017-01-05 22:57:09 +00:00
. /etc/static/bashrc
2016-12-15 11:39:56 +00:00
```
2017-03-12 00:00:10 +00:00
... or for `fish` :
```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
```
2017-03-12 15:35:56 +00:00
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.
```
2019-05-04 14:10:00 +00:00
## 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.
2017-07-19 19:30:28 +00:00
2017-11-05 21:16:51 +00:00
## Tests
There are basic tests that run sanity checks for some of the modules,
you can run them like this:
```bash
nix-build release.nix -A tests.environment-path
```
2017-07-19 19:30:28 +00:00
## Contributing
Let's make nix on darwin awesome!
Don't hesitate to contribute modules or open an issue.
2017-10-06 17:42:43 +00:00
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.
2017-11-05 21:16:51 +00:00
```bash
2017-10-06 17:42:43 +00:00
darwin-rebuild switch -I darwin=.
```
2017-07-19 19:30:28 +00:00
Also feel free to contact me if you have questions,
2018-01-03 22:07:32 +00:00
- IRC - LnL, you can find me in #nixos or #nix -darwin on freenode.net
2017-07-19 19:30:28 +00:00
- @lnl7 on twitter