home-manager README

The project's README from github.com/nix-community/home-manager. As one markdown file: 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 "Contributing" in the manual.

Releases

Home Manager is developed against the 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-26.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.

Words of warning

Unfortunately, it is quite possible to get difficult to understand errors when working with Home Manager. You should therefore be comfortable using the Nix language and the various tools in the Nix ecosystem.

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

Home Manager targets nixpkgs-unstable and NixOS version 26.05 (the current stable version), it may or may not work on other Linux distributions and NixOS versions.

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

License

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

home-manager (nix-community/home-manager)

Searching Database…

Что это такое?Home Manager управляет вашим пользовательским окружением с помощью пакетного менеджера Nix: вы описываете в конфигурации пакеты и дотфайлы для конкретного пользователя (не общесистемные) вместо того, чтобы вручную устанавливать и настраивать всё по отдельности.
Это отдельная утилита, которую я запускаю, или конфиг внутри NixOS?И то и другое: он распространяется как самостоятельный инструмент home-manager и как модули, которые можно подключить к системной конфигурации NixOS или nix-darwin, так что ваш пользовательский профиль собирается вместе с системой.
Как его настроить?Следуйте руководству для вашего режима: отдельная установка (единственный вариант вне NixOS и macOS), модуль NixOS, собираемый через nixos-rebuild, или модуль nix-darwin, собираемый через darwin-rebuild. Поддерживаются как варианты на основе каналов, так и на основе flakes.
Мне нужно уже знать язык Nix?По сути да — README просит перед началом работы уверенно владеть языком Nix и различными инструментами экосистемы Nix.
Что может пойти не так при использовании?Ошибки бывают трудночитаемыми, и Home Manager не всегда может определить, что сейчас перезапишет настройки, которые вы настроили вручную — например, модуль Gnome Terminal пишет напрямую в ваше хранилище dconf.
Для него обязателен NixOS?Нет. Вне NixOS и macOS отдельный инструмент — единственный вариант, и даже пользователям NixOS или macOS рекомендуется пользоваться именно им, если они хотят управлять домашним каталогом независимо от системы в целом.
Работает ли он вне NixOS, например на обычной машине с Debian или на Mac?Он ориентирован на nixpkgs-unstable и NixOS 26.05, поэтому на других дистрибутивах Linux он может работать, а может и нет. На macOS он интегрируется через nix-darwin; везде остальное используется отдельный инструмент.
Можно им пользоваться, пока я ещё учу Nix?Да, с одной оговоркой: авторы настоятельно советуют начать с маленькой, очень простой конфигурации и постепенно усложнять её по мере изучения Nix.
Есть ли Home Manager на других языках?У него есть базовая поддержка интернационализации через gettext, а переводы размещены на Weblate, где любой может предлагать улучшения.
Size
511 MB
Stars
10.4K
Updated
CommitOct 19
Age
9y
Commits · 90 Days