eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-15 23:59:45 +01:00
Code Issues Releases Wiki Activity
Mirror of home-manager
3140 commits 51 branches 0 tags 26 MiB
Nix 96.4%
Shell 3%
Ruby 0.3%
JavaScript 0.1%
Find a file
Thiago Kenji Okada 664086fa4c lib/shell: add appendToVar function
2023-11-21 18:38:57 +00:00
.builds ci: build manual and push to home-manager.dev 2023-06-25 00:55:43 +02:00
.github ci: bump actions/checkout from 3 to 4 2023-09-11 23:47:36 +02:00
docs docs: fix option name 2023-10-20 23:56:29 +02:00
home-manager home-manager: improve comment in example configuration 2023-11-19 10:10:20 +01:00
lib/bash lib/bash: make call to tput more robust 2022-10-13 11:56:47 +02:00
modules lib/shell: add appendToVar function 2023-11-21 18:38:57 +00:00
nix-darwin nix-darwin: simplify activation script invocation 2022-09-19 22:02:58 +02:00
nixos nixos: increase TimeoutStartSec from 1m30s to 5m 2023-09-10 21:54:17 +02:00
templates flake: correct nix-darwin flake description 2022-12-04 15:26:36 +01:00
tests home-environment: add home.sessionSearchVariables 2023-11-21 18:38:19 +00:00
.editorconfig home-manager: add .editorconfig 2023-10-17 08:05:15 +02:00
.gitignore Prepare inclusion in nixos-search (#2971) 2022-06-07 20:45:06 +02:00
.gitlab-ci.yml ci: don't run tests in GitLab CI 2022-10-27 22:47:27 +02:00
.release Switch current unstable version to 23.11 2023-05-31 19:11:30 +02:00
default.nix docs: use nixosOptionsDoc 2023-07-17 16:49:35 +01:00
flake.lock flake.lock: Update 2023-11-19 03:59:16 +00:00
flake.nix flake: fix nixpkgs config 2023-10-07 01:32:49 +02:00
format flake: add formatter (#3620) 2023-06-27 23:32:30 +02:00
LICENSE docs: update copyright years 2023-05-31 18:36:26 +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 readme: major cleanup 2023-10-22 01:31:56 +02:00
release.json version: add isReleaseBranch 2023-07-17 16:49:32 +01: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 "Contributing" in the manual.

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.

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