summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorMarek Mahut <marek.mahut@gmail.com>2019-08-20 22:12:16 +0200
committerGitHub <noreply@github.com>2019-08-20 22:12:16 +0200
commit5dcc65a25b6d117a78579f4e3dc12e1c687c72be (patch)
tree21508db0a0c7c5595a4606331395cc0ad580a582 /nixos
parentcaa1f4ab632ba49b9e2342a69370341f3442da78 (diff)
parent8033c663896189ef9c89484fec459c89bf86c37b (diff)
downloadnixpkgs-5dcc65a25b6d117a78579f4e3dc12e1c687c72be.tar
nixpkgs-5dcc65a25b6d117a78579f4e3dc12e1c687c72be.tar.gz
nixpkgs-5dcc65a25b6d117a78579f4e3dc12e1c687c72be.tar.bz2
nixpkgs-5dcc65a25b6d117a78579f4e3dc12e1c687c72be.tar.lz
nixpkgs-5dcc65a25b6d117a78579f4e3dc12e1c687c72be.tar.xz
nixpkgs-5dcc65a25b6d117a78579f4e3dc12e1c687c72be.tar.zst
nixpkgs-5dcc65a25b6d117a78579f4e3dc12e1c687c72be.zip
Merge pull request #67109 from 1000101/master
trezord: add docs
Diffstat (limited to 'nixos')
-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>