nixos/modules/programs/digitalbitbox/default.xml


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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

<!-- Do not edit this file directly, edit its companion .md instead
     and regenerate this file using nixos/doc/manual/md-to-db.sh -->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-programs-digitalbitbox">
  <title>Digital Bitbox</title>
  <para>
    Digital Bitbox is a hardware wallet and second-factor authenticator.
  </para>
  <para>
    The <literal>digitalbitbox</literal> programs module may be
    installed by setting <literal>programs.digitalbitbox</literal> to
    <literal>true</literal> in a manner similar to
  </para>
  <programlisting>
programs.digitalbitbox.enable = true;
</programlisting>
  <para>
    and bundles the <literal>digitalbitbox</literal> package (see
    <xref linkend="sec-digitalbitbox-package" />), which contains the
    <literal>dbb-app</literal> and <literal>dbb-cli</literal> binaries,
    along with the hardware module (see
    <xref linkend="sec-digitalbitbox-hardware-module" />) which sets up
    the necessary udev rules to access the device.
  </para>
  <para>
    Enabling the digitalbitbox module is pretty much the easiest way to
    get a Digital Bitbox device working on your system.
  </para>
  <para>
    For more information, see
    <link xlink:href="https://digitalbitbox.com/start_linux">https://digitalbitbox.com/start_linux</link>.
  </para>
  <section xml:id="sec-digitalbitbox-package">
    <title>Package</title>
    <para>
      The binaries, <literal>dbb-app</literal> (a GUI tool) and
      <literal>dbb-cli</literal> (a CLI tool), are available through the
      <literal>digitalbitbox</literal> package which could be installed
      as follows:
    </para>
    <programlisting>
environment.systemPackages = [
  pkgs.digitalbitbox
];
</programlisting>
  </section>
  <section xml:id="sec-digitalbitbox-hardware-module">
    <title>Hardware</title>
    <para>
      The digitalbitbox hardware package enables the udev rules for
      Digital Bitbox devices and may be installed as follows:
    </para>
    <programlisting>
hardware.digitalbitbox.enable = true;
</programlisting>
    <para>
      In order to alter the udev rules, one may provide different values
      for the <literal>udevRule51</literal> and
      <literal>udevRule52</literal> attributes by means of overriding as
      follows:
    </para>
    <programlisting>
programs.digitalbitbox = {
  enable = true;
  package = pkgs.digitalbitbox.override {
    udevRule51 = &quot;something else&quot;;
  };
};
</programlisting>
  </section>
</chapter>