Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Simplify NixOS installation instructions #826

Merged
merged 1 commit into from
May 7, 2024
Merged

Simplify NixOS installation instructions #826

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
137 changes: 28 additions & 109 deletions doc/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,117 +384,46 @@ You can install `kmonad` via `xbps-install`:

### NixOS

There is not currently a `kmonad` package in `nixpkgs`, however the
following instructions show how to create your own adhoc derivation, and
how to configure udev rules in nixos. There is also a NixOS module
included in this repository that can be used instead of a manual
configuration.

#### The Derivation
Create a `kmonad.nix` derivation such as this one which fetches a static
binary release of kmonad and packages it in the nix-store:

``` nix
let
pkgs = import <nixpkgs> { };

kmonad-bin = pkgs.fetchurl {
url = "https://github.com/kmonad/kmonad/releases/download/0.4.2/kmonad";
sha256 = "0j73dzsfnsa7s96gnxhy9v2wz4l8pln0safdlbkz5j4gdasz3lsl";
};
in
pkgs.runCommand "kmonad" {}
''
#!${pkgs.stdenv.shell}
mkdir -p $out/bin
cp ${kmonad-bin} $out/bin/kmonad
chmod +x $out/bin/*
''
```

#### Configuration.nix
The following instructions show how to install and configure KMonad in NixOS.
There is a NixOS module included in this repository that can be used
instead of a manual configuration.

1. Import `kmonad.nix` into your `configuration.nix` file using a `let`
expression:
#### configuration.nix

``` nix
let
kmonad = import /path/to/kmonad.nix;
in {
<your_config>
}
```
1. Clone this repository or copy the file
[`nix/nixos-module.nix`](../nix/nixos-module.nix) somewhere to your system.

2. Add `kmonad` to `environment.systemPackages`:

``` nix
environment.systemPackages = with pkgs; [
...
kmonad
...
];
```

3. Create the `uinput` group and add your user to `uinput` and `input`:

``` nix
users.groups = { uinput = {}; };

users.extraUsers.userName = {
...
extraGroups = [ ... "input" "uinput" ];
};
```

4. Add `udev` rules:

``` nix
services.udev.extraRules =
''
# KMonad user access to /dev/uinput
KERNEL=="uinput", MODE="0660", GROUP="uinput", OPTIONS+="static_node=uinput"
'';
```

5. Rebuild system:

``` console
# nixos-rebuild switch
```

#### The NixOS module

1. Clone this repository or copy the file `nix/nixos-module.nix`
somewhere to your system.

2. Add `nixos-module.nix` into your `configuration.nix` as an import:
2. Import `nixos-module.nix`, install KMonad, and configure your keyboard in
`configuration.nix`

``` nix
imports =
[
/path/to/nixos-module.nix;
...
/path/to/nixos-module.nix
];
```

3. Configure the module:
environment.systemPackages = with pkgs; [
...
haskellPackages.kmonad
...
];

``` nix
services.kmonad = {
enable = true;
services.kmonad = {
enable = true;
keyboards = {
{ any name for your keyboard } = {
device = "/dev/input/by-id/{ your keyboard id that usually ends with -kbd }";
config = ''
{ content of config.kbd here }
'';
};
};
# Modify the following line if you copied nixos-module.nix elsewhere or if you want to use the derivation described above
# package = import /pack/to/kmonad.nix;
myKMonadOutput = {
device = "/dev/input/by-id/my-keyboard-kbd";
config = builtins.readFile /path/to/my/config.kbd;
};
};

# If you've installed KMonad from a different source, update this property
package = pkgs.haskellPackages.kmonad;
};
```

4. If you've set `enable = true;` at the previous step, do not put a
If you've set `enable = true;` in `services.kmonad`, do not put a
`setxkbmap` line in your `config.kbd`. Instead, set the options like
this:

Expand All @@ -505,18 +434,8 @@ binary release of kmonad and packages it in the nix-store:
};
```

5. If you want your main user to use kmonad, add it to the `uinput` and
`input` groups:

``` nix
users.extraUsers.userName = {
...
extraGroups = [ ... "input" "uinput" ];
};
```

6. Rebuild system:
3. Rebuild system:

``` console
# nixos-rebuild switch
nixos-rebuild switch
```