nixos/modules/programs/digitalbitbox/default.md

   1 # Digital Bitbox {#module-programs-digitalbitbox}
   2
   3 Digital Bitbox is a hardware wallet and second-factor authenticator.
   4
   5 The `digitalbitbox` programs module may be installed by setting
   6 `programs.digitalbitbox` to `true` in a manner similar to
   7 ```nix
   8 {
   9   programs.digitalbitbox.enable = true;
  10 }
  11 ```
  12 and bundles the `digitalbitbox` package (see [](#sec-digitalbitbox-package)),
  13 which contains the `dbb-app` and `dbb-cli` binaries, along with the hardware
  14 module (see [](#sec-digitalbitbox-hardware-module)) which sets up the necessary
  15 udev rules to access the device.
  16
  17 Enabling the digitalbitbox module is pretty much the easiest way to get a
  18 Digital Bitbox device working on your system.
  19
  20 For more information, see <https://digitalbitbox.com/start_linux>.
  21
  22 ## Package {#sec-digitalbitbox-package}
  23
  24 The binaries, `dbb-app` (a GUI tool) and `dbb-cli` (a CLI tool), are available
  25 through the `digitalbitbox` package which could be installed as follows:
  26 ```nix
  27 {
  28   environment.systemPackages = [
  29     pkgs.digitalbitbox
  30   ];
  31 }
  32 ```
  33
  34 ## Hardware {#sec-digitalbitbox-hardware-module}
  35
  36 The digitalbitbox hardware package enables the udev rules for Digital Bitbox
  37 devices and may be installed as follows:
  38 ```nix
  39 {
  40   hardware.digitalbitbox.enable = true;
  41 }
  42 ```
  43
  44 In order to alter the udev rules, one may provide different values for the
  45 `udevRule51` and `udevRule52` attributes by means of overriding as follows:
  46 ```nix
  47 {
  48   programs.digitalbitbox = {
  49     enable = true;
  50     package = pkgs.digitalbitbox.override {
  51       udevRule51 = "something else";
  52     };
  53   };
  54 }
  55 ```