nixos/trezord: convert manual chapter to MD

This commit is contained in:
pennae 2023-01-03 03:01:45 +01:00
parent 77ee5a1436
commit a553f57cb6
3 changed files with 43 additions and 23 deletions

View file

@ -0,0 +1,17 @@
# Trezor {#trezor}
Trezor is an open-source cryptocurrency hardware wallet and security token
allowing secure storage of private keys.
It offers advanced features such U2F two-factor authorization, SSH login
through
[Trezor SSH agent](https://wiki.trezor.io/Apps:SSH_agent),
[GPG](https://wiki.trezor.io/GPG) and a
[password manager](https://wiki.trezor.io/Trezor_Password_Manager).
For more information, guides and documentation, see <https://wiki.trezor.io>.
To enable Trezor support, add the following to your {file}`configuration.nix`:
services.trezord.enable = true;
This will add all necessary udev rules and start Trezor Bridge.

View file

@ -8,6 +8,8 @@ in {
### docs
meta = {
# Don't edit the docbook xml directly, edit the md and generate it:
# `pandoc trezord.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > trezord.xml`
doc = ./trezord.xml;
};

View file

@ -1,26 +1,27 @@
<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>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" 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" role="uri">https://wiki.trezor.io</link>.
</para>
<para>
To enable Trezor support, add the following to your
<filename>configuration.nix</filename>:
</para>
<programlisting>
services.trezord.enable = true;
</programlisting>
This will add all necessary udev rules and start Trezor Bridge.
</para>
<para>
This will add all necessary udev rules and start Trezor Bridge.
</para>
</chapter>