mirror of
https://github.com/nix-community/home-manager
synced 2024-08-07 12:37:49 +02:00
80ac72bf03
The `optionsDocBook` function is deprecated in nixpkgs since nixos-23.11. This commit updates the manual and manpages to use commonmark formatted documentation instead of the deprecated docbook format.
76 lines
2.7 KiB
Markdown
76 lines
2.7 KiB
Markdown
# Standalone installation {#sec-install-standalone}
|
|
|
|
1. Make sure you have a working Nix installation. Specifically, make
|
|
sure that your user is able to build and install Nix packages. For
|
|
example, you should be able to successfully run a command like
|
|
`nix-instantiate '<nixpkgs>' -A hello` without having to switch to
|
|
the root user. For a multi-user install of Nix this means that your
|
|
user must be covered by the
|
|
[`allowed-users`](https://nixos.org/nix/manual/#conf-allowed-users)
|
|
Nix option. On NixOS you can control this option using the
|
|
[`nix.settings.allowed-users`](https://nixos.org/manual/nixos/stable/options.html#opt-nix.settings.allowed-users)
|
|
system option.
|
|
|
|
2. Add the appropriate Home Manager channel. If you are following
|
|
Nixpkgs master or an unstable channel you can run
|
|
|
|
``` console
|
|
$ nix-channel --add https://github.com/nix-community/home-manager/archive/master.tar.gz home-manager
|
|
$ nix-channel --update
|
|
```
|
|
|
|
and if you follow a Nixpkgs version 23.05 channel you can run
|
|
|
|
``` console
|
|
$ nix-channel --add https://github.com/nix-community/home-manager/archive/release-23.05.tar.gz home-manager
|
|
$ nix-channel --update
|
|
```
|
|
|
|
3. Run the Home Manager installation command and create the first Home
|
|
Manager generation:
|
|
|
|
``` console
|
|
$ nix-shell '<home-manager>' -A install
|
|
```
|
|
|
|
Once finished, Home Manager should be active and available in your
|
|
user environment.
|
|
|
|
4. If you do not plan on having Home Manager manage your shell
|
|
configuration then you must source the
|
|
|
|
``` bash
|
|
$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh
|
|
```
|
|
|
|
file in your shell configuration. Alternatively source
|
|
|
|
``` bash
|
|
/etc/profiles/per-user/$USER/etc/profile.d/hm-session-vars.sh
|
|
```
|
|
|
|
when managing home configuration together with system configuration.
|
|
|
|
This file can be sourced directly by POSIX.2-like shells such as
|
|
[Bash](https://www.gnu.org/software/bash/) or [Z
|
|
shell](http://zsh.sourceforge.net/). [Fish](https://fishshell.com)
|
|
users can use utilities such as
|
|
[foreign-env](https://github.com/oh-my-fish/plugin-foreign-env) or
|
|
[babelfish](https://github.com/bouk/babelfish).
|
|
|
|
For example, if you use Bash then add
|
|
|
|
``` bash
|
|
. "$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh"
|
|
```
|
|
|
|
to your `~/.profile` file.
|
|
|
|
If instead of using channels you want to run Home Manager from a Git
|
|
checkout of the repository then you can use the
|
|
[home-manager.path](#opt-programs.home-manager.path) option to specify the absolute
|
|
path to the repository.
|
|
|
|
Once installed you can see [Using Home Manager](#ch-usage) for a more detailed
|
|
description of Home Manager and how to use it.
|