eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-22 19:19:45 +01:00
Code Issues Releases Wiki Activity
Mirror of home-manager
2138 commits 53 branches 0 tags 30 MiB
Nix 96.4%
Shell 2.9%
Ruby 0.3%
JavaScript 0.2%
Find a file
Naïm Camille Favier 64ab7d6e8d
Prepare inclusion in nixos-search (#2971) 
* Add flake.lock and clean up flake.nix

Add a lockfile to work around https://github.com/NixOS/nix/issues/6541
(and because it's a good idea anyway).

Also use flake-utils, and restrict ourselves to the five platforms
supported by nixpkgs. Otherwise, the IFD for nmd fails on weird
platforms. This fixes `nix flake check`.

Remove the redundant `apps` output, see https://github.com/nix-community/home-manager/pull/2442#issuecomment-1133670487

* nixos,nix-darwin: factor out into a common module

* nixos,nix-darwin: make `home-managers.users` shallowly visible

Make sure the option is included in the NixOS/nix-darwin manual (but the
HM submodule options aren't).

Also add a static description to the HM submodule type so that we don't need to
evaluate the submodules just to build the option manual. This makes
nixos-search able to index the home-manager flake.

Also clean up some TODOs.

* flake: add nmd and nmt

This avoids having to use `pkgs.fetchFromGitLab` in an IFD, which causes
issues when indexing packages with nixos-search because `pkgs` is
instantiated with every platform.
2022-06-07 20:45:06 +02:00
.github mopidy: add module 2022-05-19 00:31:37 +02:00
docs Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
home-manager Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
lib/bash home-manager: add basic i18n support 2021-12-13 21:47:28 +01:00
modules Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
nix-darwin Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
nixos Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
tests Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
.gitignore Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
.gitlab-ci.yml gitlab-ci: build HTML manual in a simpler way 2021-12-17 00:06:06 +01:00
.release Switch to 22.05 as current development release 2021-11-25 22:29:49 +01:00
default.nix Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
flake.lock Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
flake.nix Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
format Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
integration-common.nix Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
LICENSE docs: update copyright year 2022-06-01 21:42:55 +02:00
Makefile Makefile: add test-install target 2021-10-31 08:50:54 +01:00
overlay.nix overlay: rename parameters to flake specification 2022-03-27 01:08:52 +01:00
README.md docs: set 22.05 as stable version 2022-06-01 21:56:45 +02:00
xgettext home-manager: support i18n of install script 2021-12-14 18:53:54 +01:00

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