nixpkgs-suyu/nixos/modules/programs/digitalbitbox/doc.xml

<chapter xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         version="5.0"
         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

<programlisting>
<xref linkend="opt-programs.digitalbitbox.enable"/> = true;
</programlisting>

    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" />.
  </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:

<programlisting>
<xref linkend="opt-environment.systemPackages"/> = [
  pkgs.digitalbitbox
];
</programlisting>
    </para>
  </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:

<programlisting>
<xref linkend="opt-hardware.digitalbitbox.enable"/> = true;
</programlisting>
    </para>

    <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:

<programlisting>
programs.digitalbitbox = {
  <link linkend="opt-programs.digitalbitbox.enable">enable</link> = true;
  <link linkend="opt-programs.digitalbitbox.package">package</link> = pkgs.digitalbitbox.override {
    udevRule51 = "something else";
  };
};
</programlisting>
    </para>
  </section>
</chapter>