summary refs log tree commit diff
path: root/nixos/modules/services
diff options
context:
space:
mode:
authorJan Hrnko <jan.hrnko@satoshilabs.com>2019-08-20 20:25:51 +0200
committerJan Hrnko <jan.hrnko@satoshilabs.com>2019-08-20 21:09:32 +0200
commit8033c663896189ef9c89484fec459c89bf86c37b (patch)
tree1820c30855376d1f6ef6554487e10140e2a0a313 /nixos/modules/services
parent1c44d26f9132865ad5c69dcd009b9323c9d14122 (diff)
downloadnixpkgs-8033c663896189ef9c89484fec459c89bf86c37b.tar
nixpkgs-8033c663896189ef9c89484fec459c89bf86c37b.tar.gz
nixpkgs-8033c663896189ef9c89484fec459c89bf86c37b.tar.bz2
nixpkgs-8033c663896189ef9c89484fec459c89bf86c37b.tar.lz
nixpkgs-8033c663896189ef9c89484fec459c89bf86c37b.tar.xz
nixpkgs-8033c663896189ef9c89484fec459c89bf86c37b.tar.zst
nixpkgs-8033c663896189ef9c89484fec459c89bf86c37b.zip
trezord: add docs
Diffstat (limited to 'nixos/modules/services')
-rw-r--r--nixos/modules/services/hardware/trezord.nix6
-rw-r--r--nixos/modules/services/hardware/trezord.xml26
2 files changed, 32 insertions, 0 deletions
diff --git a/nixos/modules/services/hardware/trezord.nix b/nixos/modules/services/hardware/trezord.nix
index c06a0665d02..20bcbf83109 100644
--- a/nixos/modules/services/hardware/trezord.nix
+++ b/nixos/modules/services/hardware/trezord.nix
@@ -4,6 +4,12 @@ with lib;
 let
   cfg = config.services.trezord;
 in {
+
+  ### docs
+
+  meta = {
+    doc = ./trezord.xml;
+  };
   
   ### interface
 
diff --git a/nixos/modules/services/hardware/trezord.xml b/nixos/modules/services/hardware/trezord.xml
new file mode 100644
index 00000000000..972d409d9d0
--- /dev/null
+++ b/nixos/modules/services/hardware/trezord.xml
@@ -0,0 +1,26 @@
+<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="trezor">
+ <title>Trezor</title>
+ <para>
+  Trezor is an open-source cryptocurrency hardware wallet and security token
+  allowing secure storage of private keys.
+ </para>
+ <para>
+  It offers advanced features such U2F two-factor authorization, SSH login
+  through
+  <link xlink:href="https://wiki.trezor.io/Apps:SSH_agent">Trezor SSH agent</link>,
+  <link xlink:href="https://wiki.trezor.io/GPG">GPG</link> and a
+  <link xlink:href="https://wiki.trezor.io/Trezor_Password_Manager">password manager</link>.
+  For more information, guides and documentation, see <link xlink:href="https://wiki.trezor.io"/>.
+ </para>
+ <para>
+  To enable Trezor support, add the following to your <filename>configuration.nix</filename>:
+<programlisting>
+<xref linkend="opt-services.trezord.enable"/> = true;
+</programlisting>
+  This will add all necessary udev rules and start Trezor Bridge.
+ </para>
+</chapter>