Hjem

https://hjem.feel-co.org
Admin
Hjem is a NixOS and nix-darwin module for declarative, simple home directory and user configuration...
Tokens:7,412
Snippets:110
Trust Score:4.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Configure start time

Source: https://hjem.feel-co.org/options.html

Example of setting a specific calendar time for the unit to start.

```nix
"Sun 14:00:00"
```

--------------------------------

### Configure User Packages

Source: https://hjem.feel-co.org/options.html

Define a list of packages to install for the user.

```nix
[pkgs.hello]
```

--------------------------------

### Defining a Hjem Module

Source: https://hjem.feel-co.org/extending.html

An example of a Hjem module structure using 'options' to define settings and 'config' to apply them. This snippet demonstrates how to use 'mkEnableOption' and 'mkPackageOption' to manage package installation and shell integrations.

```nix
{  
  lib,  
  pkgs,  
  config,  
  ...  
}: let  
  inherit (lib.meta) getExe;  
  inherit (lib.modules) mkAfter mkIf;  
  inherit (lib.options) mkEnableOption mkPackageOption;  
  
  cfg = config.rum.programs.fzf;  
in {  
  options.rum.programs.fzf = {  
    enable = mkEnableOption "fzf";  
  
    package = mkPackageOption pkgs "fzf" {nullable = true;};  
  
    integrations = {  
      fish.enable = mkEnableOption "fzf integration with fish";  
      zsh.enable = mkEnableOption "fzf integration with zsh";  
      };  
  };  
  
  config = mkIf cfg.enable {  
    packages = mkIf (cfg.package != null) [cfg.package];  
  
    rum.programs.fish.config = mkIf cfg.integrations.fish.enable (  
      mkAfter "${getExe cfg.package} --fish | source"  
    );  
    rum.programs.zsh.initConfig = mkIf cfg.integrations.zsh.enable (  
      mkAfter "source <(${getExe cfg.package} --zsh)"  
    );  
  };  
}
```

--------------------------------

### Configure script arguments

Source: https://hjem.feel-co.org/options.html

Example of setting arguments for the main process script using systemd specifiers.

```nix
"%i"
```

--------------------------------

### Define MIME application associations

Source: https://hjem.feel-co.org/options.html

Example of mapping mimetypes to desktop application files.

```nix
{
  mimetype1 = [
    "foo1.desktop"
    "foo2.desktop"
    "foo3.desktop"
  ];
  mimetype2 = "foo4.desktop";
}
```

--------------------------------

### Configure service settings

Source: https://hjem.feel-co.org/options.html

Example of defining options for the [Service] section of a systemd unit.

```nix
{
  RestartSec = 5;
}
```

--------------------------------

### Define XDG cache files

Source: https://hjem.feel-co.org/options.html

Example configuration for managing a cache file with Hjem.

```nix
{
  "foo.txt" = {
    source = "Hello World";
  };
}
```

--------------------------------

### Configure home directory files with Hjem

Source: https://hjem.feel-co.org/index.html

Demonstrates using the files submodule to write text files, source files from writers, and generate files from Nix values.

```nix
{  
  pkgs,  
  lib,  
  ...  
}: {  
  hjem.users.alice = {  
    directory = "/home/alice"; # Alice's $HOME  
    files = {  
      # Write a text file in '/home/alice/.config/foo'  
      # with the contents 'bar'  
      ".config/foo".text = "bar";  
  
      # Alternatively, create the file source using a writer. This can be used  
      # to generate config files with various formats expected by different  
      # programs such as but not limited to JSON and YAML.  
      ".config/bar".source = pkgs.writeTextFile "file-foo" "file contents";  
  
      # Generators can also be used to transform Nix values directly as an  
      # alternative to passing the generator result to 'source'.  
      ".config/baz" = {  
        # 'generator' works with `pkgs.formats` too!  
        generator = lib.generators.toJSON {};  
        value = {  
          some = "contents";  
        };  
      };  
  
      # Write a folder in '/home/alice/.config/qux'  
      ".config/qux".source = ./qux-folder;  
    };  
  };  
}  
```

--------------------------------

### Link a file from a store path

Source: https://hjem.feel-co.org/index.html

Uses the .source attribute to link a file generated by pkgs.writeTextFile to a specific location.

```nix
".config/bar".source = pkgs.writeTextFile {  
  name = "file-foo";  
  text = ''  
    file contents  
  '';  
}  
```

--------------------------------

### Import Hjem Module into System Configuration

Source: https://hjem.feel-co.org/index.html

Integrate Hjem into your system configuration by adding the module to your system definition.

```nix
# flake.nix  
{  
  inputs = {  
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";  
  
    hjem = {  
      url = "github:feel-co/hjem";  
      inputs.nixpkgs.follows = "nixpkgs";  
    };  
  };  
  
  outputs = inputs: {  
    nixosConfigurations."<your_configuration>" = inputs.nixpkgs.lib.nixosSystem {  
      # ...  
      modules = [  
        inputs.hjem.nixosModules.default # <- needed for 'config.hjem' options  
        # ...  
      ];  
      # ...  
    };  
  };  
}  
```

```nix
# flake.nix  
{  
  inputs = {  
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";  
  
    nix-darwin = {  
      url = "github:nix-darwin/nix-darwin";  
      inputs.nixpkgs.follows = "nixpkgs";  
    };  
  
    hjem = {  
      url = "github:feel-co/hjem";  
      inputs.nixpkgs.follows = "nixpkgs";  
    };  
  };  
  
  outputs = inputs: {  
    darwinConfigurations."<your_configuration>" = inputs.nix-darwin.lib.darwinSystem {  
      # ...  
      modules = [  
        inputs.hjem.darwinModules.default # <- needed for 'config.hjem' options  
        # ...  
      ];  
      # ...  
    };  
  };  
}  
```

```nix
# flake.nix  
{  
  inputs = {  
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";  
  
    finix.url = "github:finix-community/finix";  
  
    hjem = {  
      url = "github:feel-co/hjem";  
      inputs.nixpkgs.follows = "nixpkgs";  
    };  
  };  
  
  outputs = inputs: {  
    nixosConfigurations."<your_configuration>" = inputs.finix.lib.finixSystem {  
      # ...  
      modules = [  
        inputs.hjem.finixModules.default # <- needed for 'config.hjem' options  
        # ...  
      ];  
      # ...  
    };  
  };  
}  
```

--------------------------------

### Configure Hjem specialArgs

Source: https://hjem.feel-co.org/options.html

Pass additional arguments to all imported modules.

```nix
{ inherit inputs; }
```

--------------------------------

### Define user session variables

Source: https://hjem.feel-co.org/options.html

Set environment variables for the user session.

```nix
{
  EDITOR = "nvim";
  VISUAL = "nvim";
}
```

--------------------------------

### Exporting Hjem Modules

Source: https://hjem.feel-co.org/extending.html

Demonstrates how to expose custom modules via the 'hjemModules' attribute in a flake, allowing others to consume them.

```nix
{  
  inputs = { /* ... */ };  
  outputs = {self, ...}: {  
    hjemModules = {  
      my-fzf-module = ./modules/fzf.nix; # The name is once again arbitrary.  
      default = self.hjemModules.my-fzf-module; # You can set a default.  
    };  
  };  
}
```

--------------------------------

### Configure XDG default applications

Source: https://hjem.feel-co.org/options.html

Defines the default applications for specific mimetypes using a list of desktop files.

```nix
{
  mimetype1 = [
    "default1.desktop"
    "default2.desktop"
  ];
}
```

--------------------------------

### Integrating a Module in flake.nix

Source: https://hjem.feel-co.org/extending.html

Shows how to import Hjem as a NixOS module and register custom modules via 'hjem.extraModules' within a flake configuration.

```nix
{  
  # flake.nix  
  inputs = {  
    nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";  
    hjem.url = "github:feel-co/hjem";  
  };  
  
  # One example of importing the module into your system configuration  
  outputs = {nixpkgs, ...} @ inputs: {  
    nixosConfigurations = {  
      default = nixpkgs.lib.nixosSystem {  
        specialArgs = {inherit inputs;};  
        modules = [  
          # 1. First import the Hjem module  
          inputs.hjem.nixosModules.default  
  
          # 2. Now set `hjem.extraModules`  
          ({pkgs, ...}: {  
            hjem.extraModules = [  
              # 3. We previously made a module in ./modules/fzf.nix. Let's import it  
              # so that our new options are available.  
              ./modules/fzf.nix # <- has to be a valid module!  
            ];  
  
            # 4. Now let's set some of our options, we previously made them available  
            # under 'rum.programs.fzf', so let's go with that. The name is arbitrary, and  
            # you can set it anything you want; for example 'mymodule.programs.fzf-yay' is  
            # perfectly valid too!  
            rum.programs.fzf = {  
              enable = true;  
              package = pkgs.fzf; # or something like pkgs.fzf.override { ... }  
            };  
          })  
        ];  
      };  
    };  
  };  
}
```

--------------------------------

### Manage files with Hjem

Source: https://hjem.feel-co.org/options.html

Define files to be managed by Hjem for a user.

```nix
{
  ".config/foo.txt" = {
    source = "Hello World";
  };
}
```

--------------------------------

### Configure File Generator

Source: https://hjem.feel-co.org/options.html

Specify a generator function for file content creation.

```nix
lib.generators.toGitINI
```

--------------------------------

### Configure File Value

Source: https://hjem.feel-co.org/options.html

Define the attribute set passed to the generator.

```nix
{
  user = {
    email = "me@example.com";
  };
}
```

--------------------------------

### Configure Path Unit Settings

Source: https://hjem.feel-co.org/options.html

Defines options for the [Path] section of a systemd unit, such as monitoring specific file paths.

```nix
{
  PathChanged = "/some/path";
  Unit = "changedpath.service";
}
```

--------------------------------

### Configure Timer Settings

Source: https://hjem.feel-co.org/options.html

Defines options for the [Timer] section of a systemd unit.

```nix
{
  OnCalendar = "Sun 14:00:00";
  Unit = "foo.service";
}
```

--------------------------------

### Add Hjem as a Flake Input

Source: https://hjem.feel-co.org/index.html

Include Hjem in the inputs section of your flake.nix file.

```nix
# flake.nix  
{  
  inputs = {  
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";  
  
    # ↓  Add here in the 'inputs' section. The name is arbitrary.  
    hjem = {  
      url = "github:feel-co/hjem";  
      inputs.nixpkgs.follows = "nixpkgs";  
    };  
  };  
}  
```

--------------------------------

### Define a Hjem user

Source: https://hjem.feel-co.org/index.html

Configures a user's home directory and identity within the Hjem system.

```nix
{  
  hjem.users = {  
    alice = {  
      # enable = true; # This is not necessary, since enable is 'true' by default  
      user = "alice"; # this is the name of the user  
      directory = "/home/alice"; # where the user's $HOME resides  
    };  
  };  
}  
```

--------------------------------

### Configure unitConfig for systemd paths

Source: https://hjem.feel-co.org/options.html

Use this attribute set to define options within the [Unit] section of a systemd path unit.

```nix
{
  RequiresMountsFor = "/data";
}
```

--------------------------------

### Define ListenDatagrams for Socket Units

Source: https://hjem.feel-co.org/options.html

Configures ListenDatagram options for a systemd socket unit.

```nix
[
  "0.0.0.0:993"
  "/run/my-socket"
]
```

--------------------------------

### Configure Service Environment Variables

Source: https://hjem.feel-co.org/options.html

Defines environment variables passed to the service's processes using an attribute set.

```nix
{
  LANG = "nl_NL.UTF-8";
  PATH = "/foo/bar/bin";
}
```

--------------------------------

### Disable home management for a user

Source: https://hjem.feel-co.org/options.html

Toggle the enable status for a specific user's home management.

```nix
false
```

--------------------------------

### Configure systemd socket options

Source: https://hjem.feel-co.org/options.html

Defines options for the [Socket] section of a systemd unit.

```nix
{
  ListenStream = "/run/my-socket";
}
```

--------------------------------

### Configure sliceConfig for systemd slices

Source: https://hjem.feel-co.org/options.html

Defines options for the [Slice] section of the unit, such as memory limits.

```nix
{
  MemoryMax = "2G";
}
```

--------------------------------

### Set clobberFiles for a user

Source: https://hjem.feel-co.org/options.html

Override the default file clobbering behavior for a specific user.

```nix
true
```

--------------------------------

### Generate files using formatters

Source: https://hjem.feel-co.org/index.html

Uses the generator attribute to transform values into specific file formats like JSON or TOML.

```nix
".config/baz" = {  
 generator = lib.generators.toJSON {};  
   value = {  
     some = "contents";  
   };  
 };  
```

```nix
".config/baz" = {  
   generator = (pkgs.formats.toml {}).generate "baz";  
   value = {  
     "ui.graph".style = "curved";  
     "ui.movement".edit = true;  
   };  
 };  
```

--------------------------------

### Remove XDG mime-app associations

Source: https://hjem.feel-co.org/options.html

Removes specific application associations for a given mimetype.

```nix
{
  mimetype1 = "foo5.desktop";
}
```
Tokens:
Raw