2020-10-12 00:22:58 +00:00
|
|
|
Home Manager using Nix
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
This project provides a basic system for managing a user environment
|
|
|
|
|
using the [Nix][] package manager together with the Nix libraries
|
2021-07-02 22:36:30 +00:00
|
|
|
found in [Nixpkgs][]. It allows declarative configuration of user
|
|
|
|
|
specific (non global) packages and dotfiles.
|
|
|
|
|
|
2023-01-10 09:35:00 +00:00
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
2021-07-02 22:36:30 +00:00
|
|
|
Before attempting to use Home Manager please read the warning below.
|
2020-10-12 00:22:58 +00:00
|
|
|
|
2023-01-10 09:35:00 +00:00
|
|
|
For a systematic overview of Home Manager and its available options,
|
|
|
|
|
please see
|
|
|
|
|
|
|
|
|
|
- the [Home Manager manual][manual],
|
|
|
|
|
- the [Home Manager configuration options][configuration options], and
|
|
|
|
|
- the 3rd party [Home Manager option search](https://mipmip.github.io/home-manager-option-search/).
|
|
|
|
|
|
|
|
|
|
If you would like to contribute to Home Manager
|
|
|
|
|
then please have a look at the [contributing][] chapter of the manual.
|
2020-10-12 00:22:58 +00:00
|
|
|
|
2023-08-08 10:19:01 +00:00
|
|
|
Releases
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Home Manager is developed against `nixpkgs-unstable` branch, which
|
|
|
|
|
often causes it to contain tweaks for changes/packages not yet
|
|
|
|
|
released in stable NixOS. To avoid breaking users' configurations,
|
|
|
|
|
Home Manager is released in branches corresponding to NixOS releases
|
|
|
|
|
(e.g. `release-23.05`). These branches get fixes, but usually not new
|
|
|
|
|
modules. If you need a module to be backported, then feel free to open
|
|
|
|
|
an issue.
|
|
|
|
|
|
2020-10-12 00:22:58 +00:00
|
|
|
Words of warning
|
|
|
|
|
----------------
|
|
|
|
|
|
2021-07-02 22:36:30 +00:00
|
|
|
Unfortunately, it is quite possible to get difficult to understand
|
2023-08-08 10:19:01 +00:00
|
|
|
errors when working with Home Manager. You should therefore be
|
|
|
|
|
comfortable using the Nix language and the various tools in the Nix
|
|
|
|
|
ecosystem.
|
2020-10-12 00:22:58 +00:00
|
|
|
|
2021-07-02 22:36:30 +00:00
|
|
|
If you are not very familiar with Nix but still want to use Home
|
|
|
|
|
Manager then you are strongly encouraged to start with a small and
|
|
|
|
|
very simple configuration and gradually make it more elaborate as you
|
|
|
|
|
learn.
|
2020-10-12 00:22:58 +00:00
|
|
|
|
|
|
|
|
In some cases Home Manager cannot detect whether it will overwrite a
|
|
|
|
|
previous manual configuration. For example, the Gnome Terminal module
|
|
|
|
|
will write to your dconf store and cannot tell whether a configuration
|
2021-07-02 22:36:30 +00:00
|
|
|
that it is about to be overwritten was from a previous Home Manager
|
2020-10-12 00:22:58 +00:00
|
|
|
generation or from manual configuration.
|
|
|
|
|
|
2023-08-08 10:19:01 +00:00
|
|
|
Home Manager targets [NixOS][] unstable and NixOS version 23.05 (the
|
2020-10-12 00:22:58 +00:00
|
|
|
current stable version), it may or may not work on other Linux
|
|
|
|
|
distributions and NixOS versions.
|
|
|
|
|
|
|
|
|
|
Also, the `home-manager` tool does not explicitly support rollbacks at
|
|
|
|
|
the moment so if your home directory gets messed up you'll have to fix
|
2023-01-10 09:35:00 +00:00
|
|
|
it yourself. See the [rollbacks][] section for instructions on how to
|
|
|
|
|
manually perform a rollback.
|
2020-10-12 00:22:58 +00:00
|
|
|
|
|
|
|
|
Now when your expectations have been built up and you are eager to try
|
|
|
|
|
all this out you can go ahead and read the rest of this text.
|
|
|
|
|
|
|
|
|
|
Contact
|
|
|
|
|
-------
|
|
|
|
|
|
2023-01-10 09:35:00 +00:00
|
|
|
You can chat with us on IRC in the channel [#home-manager][] on [OFTC][].
|
|
|
|
|
There is also a [Matrix room](https://matrix.to/#/#hm:rycee.net),
|
|
|
|
|
which is bridged to the IRC channel.
|
2020-10-12 00:22:58 +00:00
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
2021-12-03 05:30:34 +00:00
|
|
|
Home Manager can be used in three primary ways:
|
2020-10-12 00:22:58 +00:00
|
|
|
|
2021-12-03 05:30:34 +00:00
|
|
|
1. Using the standalone `home-manager` tool. For platforms other than
|
|
|
|
|
NixOS and Darwin, this is the only available choice. It is also
|
|
|
|
|
recommended for people on NixOS or Darwin that want to manage their
|
|
|
|
|
home directory independently of the system as a whole. See
|
|
|
|
|
[Standalone installation][manual standalone install] in the manual
|
|
|
|
|
for instructions on how to perform this installation.
|
2020-10-12 00:22:58 +00:00
|
|
|
|
2021-12-03 05:30:34 +00:00
|
|
|
2. As a module within a NixOS system configuration. This allows the
|
|
|
|
|
user profiles to be built together with the system when running
|
|
|
|
|
`nixos-rebuild`. See [NixOS module installation][manual nixos
|
|
|
|
|
install] in the manual for a description of this setup.
|
2021-07-02 22:36:30 +00:00
|
|
|
|
2021-12-03 05:30:34 +00:00
|
|
|
3. As a module within a [nix-darwin][] system configuration. This
|
|
|
|
|
allows the user profiles to be built together with the system when
|
|
|
|
|
running `darwin-rebuild`. See [nix-darwin module
|
|
|
|
|
installation][manual nix-darwin install] in the manual for a
|
|
|
|
|
description of this setup.
|
2020-10-12 00:22:58 +00:00
|
|
|
|
2023-01-10 09:35:00 +00:00
|
|
|
Home Manager provides both the channel-based setup and the flake-based one.
|
|
|
|
|
See [Nix Flakes][manual nix flakes] for a description of the flake-based setup.
|
|
|
|
|
|
|
|
|
|
Translations
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Home Manager has basic support for internationalization through
|
|
|
|
|
[gettext](https://www.gnu.org/software/gettext/). The translations are
|
|
|
|
|
hosted by [Weblate](https://weblate.org/). If you would like to
|
|
|
|
|
contribute to the translation effort then start by going to the
|
|
|
|
|
[Home Manager Weblate project](https://hosted.weblate.org/engage/home-manager/).
|
|
|
|
|
|
|
|
|
|
<a href="https://hosted.weblate.org/engage/home-manager/">
|
|
|
|
|
<img src="https://hosted.weblate.org/widgets/home-manager/-/multi-auto.svg" alt="Translation status" />
|
|
|
|
|
</a>
|
2021-07-02 22:36:30 +00:00
|
|
|
|
2021-12-03 05:30:34 +00:00
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
This project is licensed under the terms of the [MIT license](LICENSE).
|
|
|
|
|
|
2023-01-10 09:35:00 +00:00
|
|
|
[Nix]: https://nixos.org/explore.html
|
2020-10-12 00:22:58 +00:00
|
|
|
[NixOS]: https://nixos.org/
|
2023-01-10 09:35:00 +00:00
|
|
|
[Nixpkgs]: https://github.com/NixOS/nixpkgs
|
|
|
|
|
[manual]: https://nix-community.github.io/home-manager/index.html
|
|
|
|
|
[contributing]: https://nix-community.github.io/home-manager/#ch-contributing
|
2021-12-03 05:30:34 +00:00
|
|
|
[manual usage]: https://nix-community.github.io/home-manager/#ch-usage
|
2020-10-12 00:22:58 +00:00
|
|
|
[configuration options]: https://nix-community.github.io/home-manager/options.html
|
2021-07-02 22:36:30 +00:00
|
|
|
[#home-manager]: https://webchat.oftc.net/?channels=home-manager
|
|
|
|
|
[OFTC]: https://oftc.net/
|
2020-10-12 00:22:58 +00:00
|
|
|
[Nix Flakes]: https://nixos.wiki/wiki/Flakes
|
2023-01-10 09:35:00 +00:00
|
|
|
[nix-darwin]: https://github.com/LnL7/nix-darwin
|
2021-12-03 05:30:34 +00:00
|
|
|
[manual standalone install]: https://nix-community.github.io/home-manager/index.html#sec-install-standalone
|
|
|
|
|
[manual nixos install]: https://nix-community.github.io/home-manager/index.html#sec-install-nixos-module
|
|
|
|
|
[manual nix-darwin install]: https://nix-community.github.io/home-manager/index.html#sec-install-nix-darwin-module
|
2023-01-10 09:35:00 +00:00
|
|
|
[manual nix flakes]: https://nix-community.github.io/home-manager/index.html#ch-nix-flakes
|
|
|
|
|
[rollbacks]: https://nix-community.github.io/home-manager/index.html#sec-usage-rollbacks
|
