Mirror of home-manager
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Philipp Mildenberger 3bf16c0fd1
udiskie: add option settings
4 weeks ago
.github udiskie: add option settings 6 days ago
docs docs,tests: fetch nmd and nmt using fetchTarball 1 week ago
home-manager format: update and remove exceptions (#3029) 3 weeks ago
lib/bash home-manager: add basic i18n support 7 months ago
modules udiskie: add option settings 6 days ago
nix-darwin udiskie: add option settings 6 days ago
nixos udiskie: add option settings 6 days ago
tests docs,tests: fetch nmd and nmt using fetchTarball 1 week ago
.gitignore Add basic gitignore file 4 years ago
.gitlab-ci.yml gitlab-ci: build HTML manual in a simpler way 7 months ago
.release Bump .release file 2 weeks ago
LICENSE docs: update copyright year 1 month ago
Makefile Makefile: add test-install target 8 months ago
README.md docs: set 22.05 as stable version 1 month ago
default.nix ci: verify that `meta.maintainers` evaluate 6 months ago
flake.lock Revert "integration-common: set hmModule's description directly" 7 days ago
flake.nix docs,tests: fetch nmd and nmt using fetchTarball 1 week ago
format format: update and remove exceptions (#3029) 3 weeks ago
overlay.nix overlay: rename parameters to flake specification 3 months ago
xgettext home-manager: support i18n of install script 7 months ago

README.md

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 found in Nixpkgs. It allows declarative configuration of user specific (non global) packages and dotfiles.

Usage

Before attempting to use Home Manager please read the warning below.

For a systematic overview of Home Manager and its available options, please see

If you would like to contribute to Home Manager then please have a look at the contributing chapter of the manual.

Words of warning

Unfortunately, it is quite possible to get difficult to understand errors when working with Home Manager, such as infinite loops with no clear source reference. You should therefore be comfortable using the Nix language and the various tools in the Nix ecosystem. Reading through the Nix Pills document is a good way to familiarize yourself with them.

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.

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 that it is about to be overwritten was from a previous Home Manager generation or from manual configuration.

Home Manager targets NixOS unstable and NixOS version 22.05 (the 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 it yourself. See the rollbacks section for instructions on how to manually perform a rollback.

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

You can chat with us on IRC in the channel #home-manager on OFTC. There is also a Matrix room, which is bridged to the IRC channel.

Installation

Home Manager can be used in three primary ways:

  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 in the manual for instructions on how to perform this installation.

  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.

  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 in the manual for a description of this setup.

Home Manager provides both the channel-based setup and the flake-based one. See Nix Flakes for a description of the flake-based setup.

Translations

Home Manager has basic support for internationalization through gettext. The translations are hosted by Weblate. If you would like to contribute to the translation effort then start by going to the Home Manager Weblate project.

Translation status

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-22.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.

License

This project is licensed under the terms of the MIT license.