1<chapter xmlns="http://docbook.org/ns/docbook"
2 xmlns:xlink="http://www.w3.org/1999/xlink"
3 xmlns:xi="http://www.w3.org/2001/XInclude"
4 version="5.0"
5 xml:id="module-programs-digitalbitbox">
6
7 <title>Digital Bitbox</title>
8
9 <para>
10 Digital Bitbox is a hardware wallet and second-factor authenticator.
11 </para>
12
13 <para>
14 The <literal>digitalbitbox</literal> programs module may be
15 installed by setting <literal>programs.digitalbitbox</literal>
16 to <literal>true</literal> in a manner similar to
17
18<programlisting>
19<xref linkend="opt-programs.digitalbitbox.enable"/> = true;
20</programlisting>
21
22 and bundles the <literal>digitalbitbox</literal> package (see <xref
23 linkend="sec-digitalbitbox-package" />), which contains the
24 <literal>dbb-app</literal> and <literal>dbb-cli</literal> binaries,
25 along with the hardware module (see <xref
26 linkend="sec-digitalbitbox-hardware-module" />) which sets up the
27 necessary udev rules to access the device.
28 </para>
29
30 <para>
31 Enabling the digitalbitbox module is pretty much the easiest way to
32 get a Digital Bitbox device working on your system.
33 </para>
34
35 <para>
36 For more information, see
37 <link xlink:href="https://digitalbitbox.com/start_linux" />.
38 </para>
39
40 <section xml:id="sec-digitalbitbox-package">
41 <title>Package</title>
42
43 <para>
44 The binaries, <literal>dbb-app</literal> (a GUI tool) and
45 <literal>dbb-cli</literal> (a CLI tool), are available through the
46 <literal>digitalbitbox</literal> package which could be installed
47 as follows:
48
49<programlisting>
50<xref linkend="opt-environment.systemPackages"/> = [
51 pkgs.digitalbitbox
52];
53</programlisting>
54 </para>
55 </section>
56
57
58 <section xml:id="sec-digitalbitbox-hardware-module">
59 <title>Hardware</title>
60
61 <para>
62 The digitalbitbox hardware package enables the udev rules for
63 Digital Bitbox devices and may be installed as follows:
64
65<programlisting>
66<xref linkend="opt-hardware.digitalbitbox.enable"/> = true;
67</programlisting>
68 </para>
69
70 <para>
71 In order to alter the udev rules, one may provide different values for
72 the <literal>udevRule51</literal> and <literal>udevRule52</literal>
73 attributes by means of overriding as follows:
74
75<programlisting>
76programs.digitalbitbox = {
77 <link linkend="opt-programs.digitalbitbox.enable">enable</link> = true;
78 <link linkend="opt-programs.digitalbitbox.package">package</link> = pkgs.digitalbitbox.override {
79 udevRule51 = "something else";
80 };
81};
82</programlisting>
83 </para>
84 </section>
85</chapter>