about summary refs log tree commit diff
path: root/nixos/modules/programs/digitalbitbox/default.md
blob: 9bca14e97ffefcae6e831e4c7beaca6fffc28043 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# Digital Bitbox {#module-programs-digitalbitbox}

Digital Bitbox is a hardware wallet and second-factor authenticator.

The `digitalbitbox` programs module may be installed by setting
`programs.digitalbitbox` to `true` in a manner similar to
```
programs.digitalbitbox.enable = true;
```
and bundles the `digitalbitbox` package (see [](#sec-digitalbitbox-package)),
which contains the `dbb-app` and `dbb-cli` binaries, along with the hardware
module (see [](#sec-digitalbitbox-hardware-module)) which sets up the necessary
udev rules to access the device.

Enabling the digitalbitbox module is pretty much the easiest way to get a
Digital Bitbox device working on your system.

For more information, see <https://digitalbitbox.com/start_linux>.

## Package {#sec-digitalbitbox-package}

The binaries, `dbb-app` (a GUI tool) and `dbb-cli` (a CLI tool), are available
through the `digitalbitbox` package which could be installed as follows:
```
environment.systemPackages = [
  pkgs.digitalbitbox
];
```

## Hardware {#sec-digitalbitbox-hardware-module}

The digitalbitbox hardware package enables the udev rules for Digital Bitbox
devices and may be installed as follows:
```
hardware.digitalbitbox.enable = true;
```

In order to alter the udev rules, one may provide different values for the
`udevRule51` and `udevRule52` attributes by means of overriding as follows:
```
programs.digitalbitbox = {
  enable = true;
  package = pkgs.digitalbitbox.override {
    udevRule51 = "something else";
  };
};
```