Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
93ce9ee
ADD es translation to docs pages
westoleaboat Oct 24, 2025
2613ac1
fix menu for translations
tadeubas Oct 24, 2025
03c9bd6
moved templates img to correct folder
tadeubas Oct 25, 2025
3898184
dark and light modes
tadeubas Oct 25, 2025
4b29d05
top menu titles and subentries translated to es
tadeubas Oct 25, 2025
af8f2af
Fix mnemonic printing issue with long words
tadeubas Oct 25, 2025
51a1c96
Added es imgs and fix sequences
tadeubas Oct 25, 2025
510fa9d
(ADD) windows installing doc in spanish
westoleaboat Oct 25, 2025
ce1ea09
fix typo
westoleaboat Oct 25, 2025
4d94d57
Added missing imgs and other small fixes
tadeubas Oct 26, 2025
8d1a17a
(ADD) esp snippets
westoleaboat Nov 11, 2025
cd0a641
(ADD) esp lang snippets
westoleaboat Nov 23, 2025
024b87d
(ADD) esp docs
westoleaboat Nov 23, 2025
13dc281
Updated image references to use absolute paths instead of relative links
tadeubas Nov 11, 2025
2eeba0f
(ADD) espanish docs installing-from-gui linux mac windows other
westoleaboat Nov 26, 2025
b9d416a
(FIX) improved choosing of words for better understanding in spanish
westoleaboat Nov 26, 2025
0e0bdd2
(ADD) installing from- esp docs
westoleaboat Dec 17, 2025
7758867
installing from source and usage index pages in spanish
westoleaboat Dec 30, 2025
7254557
(ADD) loading/generating a mnemonic docs into spanish
westoleaboat Jan 21, 2026
da1235f
docs: rebase conflicts
tadeubas Jan 21, 2026
74afb5d
Merge pull request #7 from tadeubas/esp-rebase-merge-conflicts
westoleaboat Jan 21, 2026
de28303
(FIX) typos and improvements to translations; (ADD) verify-download r…
westoleaboat Feb 14, 2026
2c8e7e0
fix translations; added /es/img link
westoleaboat Mar 21, 2026
e8bfb0e
FIX translations and translated img links
westoleaboat Mar 21, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion docs/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
}

.md-typeset h5 {
color: black;
text-transform: none;
}

Expand Down
29 changes: 29 additions & 0 deletions docs/faq.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## ¿Es Krux una cartera electrónica (hardware wallet)?
El término "cartera electrónica" suele referirse a dispositivos diseñados específicamente para almacenar llaves privadas y firmar transacciones. Estos dispositivos normalmente incluyen componentes de seguridad dedicados, como chips de elemento seguro (secure element chips).

Krux fue desarrollado inicialmente como un firmador (signer), funcionando exclusivamente en modo amnésico, lo que significa que el usuario debe cargar sus llaves cada vez que enciende el dispositivo. Sin embargo, Krux ha evolucionado y ahora ofrece la opción de almacenar frases mnemonicas (semillas), de manera similar a las carteras de hardware tradicionales. Estas semillas mnemonicas pueden guardarse en la memoria interna del dispositivo o en tarjetas SD.

Krux no incluye chips de seguridad física (secure elements). La protección de los datos almacenados depende del cifrado. Puedes leer más sobre este tema en: [Krux Encryption - Regarding BIP39 Mnemonics](getting-started/features/encryption/encryption.md/#regarding-bip39-mnemonics).

**Nota**: Débido a la fragilidad inherente de los componentes electrónicos, no utilices tu dispositivo Krux ni una tarjeta SD cifrada como único método de respaldo. Mantén siempre una copia física adicional de seguridad.

## ¿Qué es la versión de prueba (beta)?
La versión de prueba o beta incluye las funciones más nuevas y experimentales, que ocasionalmente compartimos en nuestras redes sociales. el programa se encuentra exclusivamente en el [repositoro de pruebas (beta)](https://github.com/odudex/krux_binaries). Puedes usar o instalar ("flashear") el programa beta si tienes curiosidad por probar nuevas funciones o deseas participar en el proceso de desarrollo, ayudando a encontrar errores (bugs), enviando comentarios o compartiendo ideas en los grupos de Telegram y otras plataformas sociales.

Solo recuerda que para el uso habitual, se recomienda utilizar siempre las versiones oficiales, que están firmadas, completamente probadas y bien documentadas.

## ¿Qué es la aplicación móvil Krux para Android?

### ¿Dónde puedo encontrarla?
La aplicación Krux Mobile para Android se encuentra en la fase beta y esta disponible como archivo APK en [KruxMobileApp](https://github.com/selfcustody/KruxMobileApp). Requiere Android 6.0 o superior.

### ¿Cómo se instala?
El archivo APK no está disponible en la Play Store. Puedes descargarlo directamente o transferirlo a tu dispositivo Android mediante una tarjeta SD o cable USB.
Para instalarlo, es posible que debas habilitar la opción de permitir instalaciones desde fuentes desconocidas en la configuración de tu teléfono.

### ¿Es segura de usar?
La app Krux Mobile está diseñada con fines educativos, para aprender sobre Krux y las transacciones desconectadas de Internet en Bitcoin.
Debido a las múltiples vulnerabilidades posibles en los teléfonos inteligentes —como la falta de control sobre el sistema operativo, las bibliotecas o el hardware—, **no se recomienda usar** la app para manejar carteras con ahorros reales **ni claves importantes**.

Para una gestión segura de tus llaves, usa siempre **un dispositivo dedicado exclusivamente** a ese propósito.

24 changes: 12 additions & 12 deletions docs/getting-started/features/QR-transcript-tools.en.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,48 @@
When you export a mnemonic, encrypted mnemonic or a generic text QR code, alternative visualization modes will be available. Swipe left :material-gesture-swipe-left: or right :material-gesture-swipe-right: to change modes, or if your device doesn't have a touchscreen, press the `PAGE` buttons. See our [available transcribe templates](../templates/templates.md).

### Standard Mode
<img src="../../../img/maixpy_m5stickv/standard-qr-code-250.png" align="right" class="m5stickv">
<img src="../../../img/maixpy_amigo/standard-qr-code-300.png" align="right" class="amigo">
<img src="/krux/img/maixpy_m5stickv/standard-qr-code-250.png" align="right" class="m5stickv">
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the change? IMO this could be potentially be problematic depending on developer's machine.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've explained before in our Telegram chat: using those paths would break links in the Spanish version because its URLs include the /es/ prefix. Also the relative paths were messy... if we move a document to a different location would break all the links.

Whether the paths are relative or absolute doesn’t affect how the image is displayed; it will render normally either way, it doesn't depend on developer's machine or our site generate by GitHub actions

<img src="/krux/img/maixpy_amigo/standard-qr-code-300.png" align="right" class="amigo">

This mode is optimized for scanning, the raw QR code will be displayed

<div style="clear: both"></div>

### Lines Mode
<img src="../../../img/maixpy_m5stickv/lines-qr-code-250.png" align="right" class="m5stickv">
<img src="../../../img/maixpy_amigo/lines-qr-code-300.png" align="right" class="amigo">
<img src="/krux/img/maixpy_m5stickv/lines-qr-code-250.png" align="right" class="m5stickv">
<img src="/krux/img/maixpy_amigo/lines-qr-code-300.png" align="right" class="amigo">

If you are good at transcribing things like handwritten text, with this mode one QR code line will be highlighted at a time. Press `ENTER` to highlight the next line.

<div style="clear: both"></div>

### Zoomed Regions Mode
<img src="../../../img/maixpy_m5stickv/zoomed-qr-code-250.png" align="right" class="m5stickv">
<img src="../../../img/maixpy_amigo/zoomed-qr-code-300.png" align="right" class="amigo">
<img src="/krux/img/maixpy_m5stickv/zoomed-qr-code-250.png" align="right" class="m5stickv">
<img src="/krux/img/maixpy_amigo/zoomed-qr-code-300.png" align="right" class="amigo">
Comment on lines +12 to +21
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too


QR codes will be split into regions, of 5x5 or 7x7 "blocks". One QR code region will be shown at a time. Press `ENTER` to display the next region.

<div style="clear: both"></div>

### Highlighted Regions Mode
<img src="../../../img/maixpy_m5stickv/regions-qr-code-250.png" align="right" class="m5stickv">
<img src="../../../img/maixpy_amigo/regions-qr-code-300.png" align="right" class="amigo">
<img src="/krux/img/maixpy_m5stickv/regions-qr-code-250.png" align="right" class="m5stickv">
<img src="/krux/img/maixpy_amigo/regions-qr-code-300.png" align="right" class="amigo">

QR codes will be split into regions, of 5x5 or 7x7 "blocks". One QR code region will be highlighted at a time. Press `ENTER` to highlight the next region.

<div style="clear: both"></div>

### Grided Mode
<img src="../../../img/maixpy_m5stickv/grided-qr-code-250.png" align="right" class="m5stickv">
<img src="../../../img/maixpy_amigo/grided-qr-code-300.png" align="right" class="amigo">
<img src="/krux/img/maixpy_m5stickv/grided-qr-code-250.png" align="right" class="m5stickv">
<img src="/krux/img/maixpy_amigo/grided-qr-code-300.png" align="right" class="amigo">

Grids will be added to a standard QR code. In a dark room, if you place a sheet of paper over the device's screen, you'll notice QR code will be visible and it will be possible to copy it directly from above (tracing). Be careful not to damage your screen with pen and markers, use an insulating plastic tape or film to protect the device when using this method.

<div style="clear: both"></div>

### QR Viewer
<img src="../../../img/maixpy_m5stickv/qr-viewer-250.png" align="right" class="m5stickv">
<img src="../../../img/maixpy_amigo/qr-viewer-300.png" align="right" class="amigo">
<img src="/krux/img/maixpy_m5stickv/qr-viewer-250.png" align="right" class="m5stickv">
<img src="/krux/img/maixpy_amigo/qr-viewer-300.png" align="right" class="amigo">
Comment on lines +36 to +45
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too


Almost every QR code in Krux will also bring up this menu with these extra options: `Toggle Brightness`, `Save QR Image to SD Card` and `Print as QR`. If `Save QR Image to SD Card` shows as disabled it means that the SD card was not detected. To enable `Print as QR` you need to configure your printer driver in [settings](../settings.md#printer).

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/features/encryption/encryption.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ In **Settings -> Encryption Settings**, you can adjust *PBKDF2 Iterations* and *

During encryption, users may be prompted to override their preferences or select a specific version. Most importantly: **the encryption key MUST be strong**. If a KEF envelope is created with a weak key and shared or exposed, it should be assumed to offer **NO protection**, and the secret will be leaked.

<img src="../../../../img/maixpy_m5stickv/load-mnemonic-kef-via-qr-250.png" align="right" class="m5stickv">
<img src="../../../../img/maixpy_amigo/load-mnemonic-kef-via-qr-300.png" align="right" class="amigo">
<img src="/krux/img/maixpy_m5stickv/load-mnemonic-kef-via-qr-250.png" align="right" class="m5stickv">
<img src="/krux/img/maixpy_amigo/load-mnemonic-kef-via-qr-300.png" align="right" class="amigo">
Comment on lines +8 to +9
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too


When Krux detects data resembling a KEF-encrypted envelope, it prompts the user to *"Decrypt?"*, showing the KEF version, envelope ID (or label), and the PBKDF2 iteration count used during creation. To decrypt, the same key (typed or scanned) must be provided. Once unlocked, Krux uses the plaintext within context. If decryption is declined, the raw envelope is used instead—usually resulting in an error, since KEF data is meaningless without decryption.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/features/mnemonic-xor.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ It is an implementation of the XOR ([exclusive OR](https://en.wikipedia.org/wiki

Krux derives a new mnemonic (and therefore a new seed) by performing an XOR operation on the **entropy bytes** of the source mnemonics. The result of this XOR operation is a new set of **entropy bytes**, which is then converted into a new mnemonic - and subsequently, a new seed.

<img src="../../../img/mnemonic_xor.png" align="center">
<img src="/krux/img/mnemonic_xor.png" align="center">
Comment on lines 8 to +9
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too


- Obtain two different mnemonics (A and B) and extract their **entropy bytes**.
- Validate the input entropies to prevent redundant or unsafe operations:
Expand Down
20 changes: 10 additions & 10 deletions docs/getting-started/features/printing/cnc.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ warning-printer.en.txt

Krux engraves any QR code (SeedQR, PSBT, address, XPUB, etc.) on GRBL 1.1 CNC machines — via airgapped SD card or direct TTL serial connection.

<img src="../../../../img/maixpy_amigo/print-qr-printing-300.png" class="amigo">
<img src="../../../../img/maixpy_m5stickv/print-qr-printing-250.png" class="m5stickv">
<img src="/krux/img/maixpy_amigo/print-qr-printing-300.png" class="amigo">
<img src="/krux/img/maixpy_m5stickv/print-qr-printing-250.png" class="m5stickv">

A GRBL g-code simulation on [OpenBuilds CONTROL](https://software.openbuilds.com/):
<video width="506" controls>
<source src="../../../../img/CompactSeedQR_CNC.mp4" type="video/mp4"></source>
<source src="/krux/img/CompactSeedQR_CNC.mp4" type="video/mp4"></source>
</video>

<img src="../../../../img/maixpy_amigo/print-qr-file-prompt-300.png" class="amigo">
<img src="../../../../img/maixpy_m5stickv/print-qr-file-prompt-250.png" class="m5stickv">
<img src="../../../../img/maixpy_amigo/print-qr-grbl-prompt-300.png" class="amigo">
<img src="../../../../img/maixpy_m5stickv/print-qr-grbl-prompt-250.png" class="m5stickv">
<img src="/krux/img/maixpy_amigo/print-qr-file-prompt-300.png" class="amigo">
<img src="/krux/img/maixpy_m5stickv/print-qr-file-prompt-250.png" class="m5stickv">
<img src="/krux/img/maixpy_amigo/print-qr-grbl-prompt-300.png" class="amigo">
<img src="/krux/img/maixpy_m5stickv/print-qr-grbl-prompt-250.png" class="m5stickv">
Comment on lines +9 to +20
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too


After configuring the CNC printer and driver in [settings](../../settings.md/#cnc), any screen that displays a QR code will offer to `Print as QR`. Use this to Carve QR codes into wood/metal, like backups of your mnemonics, xpubs and multisig wallet output descriptor.

Expand All @@ -42,11 +42,11 @@ If the driver is configured as *FilePrinter*, the output will be GRBL g-code in

A 96×96mm QR carved into black-painted wood with 2mm drill-bit (inverted for white):

<img src="../../../../img/96x96-2mm_bit.jpg" style="width: 38%; min-width: 130px;">
<img src="/krux/img/96x96-2mm_bit.jpg" style="width: 38%; min-width: 130px;">

A 50x50mm QR carved into black-painted wood with 2mm drill-bit (inverted for white):

<img src="../../../../img/50x50_2mm_bit.jpg" style="width: 32%; min-width: 120px;">
<img src="/krux/img/50x50_2mm_bit.jpg" style="width: 32%; min-width: 120px;">

Laser etching is also supported. Tested settings and results:

Expand All @@ -69,7 +69,7 @@ Laser etching is also supported. Tested settings and results:

From left to right: 34x34mm at 50%, 21x21mm at 5%, 21x21mm at 50% power laser-etched stainless steel:

<img src="../../../../img/laser_cnc.jpg" style="width: 60%; min-width: 280px;">
<img src="/krux/img/laser_cnc.jpg" style="width: 60%; min-width: 280px;">
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too


----8<----
warning-printed-QR.en.txt
Expand Down
14 changes: 7 additions & 7 deletions docs/getting-started/features/printing/printing.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,24 @@ warning-printer.en.txt

Krux has the ability to print mnemonic backup (Words, Numbers, Tinyseed template; but not Stackbit 1248) and any QR code (SeedQR, signed PSBT, Address, XPUB, Wallet output descriptor, ...) via a locally-connected TTL serial thermal printer. Consult the [parts list](../../../parts.md/#optional-ttl-serial-thermal-printer) page for supported printers.

<img src="../../../../img/maixpy_amigo/print-qr-printing-300.png" class="amigo">
<img src="../../../../img/maixpy_m5stickv/print-qr-printing-250.png" class="m5stickv">
<img src="/krux/img/maixpy_amigo/print-qr-printing-300.png" class="amigo">
<img src="/krux/img/maixpy_m5stickv/print-qr-printing-250.png" class="m5stickv">

<video width="430" controls>
<source src="../../../../img/printing-qr.mp4" type="video/mp4"></source>
<source src="/krux/img/printing-qr.mp4" type="video/mp4"></source>
</video>

<video width="400" controls>
<source src="../../../../img/scanning-printed-qr.mp4" type="video/mp4"></source>
<source src="/krux/img/scanning-printed-qr.mp4" type="video/mp4"></source>
</video>

<video width="480" controls>
<source src="../../../../img/printing-scanning-psbt.mp4" type="video/mp4"></source>
<source src="/krux/img/printing-scanning-psbt.mp4" type="video/mp4"></source>
</video>


<img src="../../../../img/maixpy_m5stickv/print-qr-prompt-250.png" align="right" class="m5stickv">
<img src="../../../../img/maixpy_amigo/print-qr-prompt-300.png" align="right" class="amigo">
<img src="/krux/img/maixpy_m5stickv/print-qr-prompt-250.png" align="right" class="m5stickv">
<img src="/krux/img/maixpy_amigo/print-qr-prompt-300.png" align="right" class="amigo">
Comment on lines +8 to +25
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too


Once a thermal printer and driver have been enabled in [settings](../../settings.md/#thermal), all screens that display a QR code will offer the option to `Print as QR`. Other formats of mnemonic backup will also ask if you want to `Print as QR?`.

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/features/sd-card-update.en.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
### Upgrade via microSD card
Once you've installed Krux firmware on your device via USB, you can either continue updating the device via USB or you can perform upgrades via microSD card to keep the device airgapped.

<img src="../../../img/maixpy_m5stickv/firmware-update-250.png" align="right" class="m5stickv">
<img src="../../../img/maixpy_amigo/firmware-update-300.png" align="right" class="amigo">
<img src="/krux/img/maixpy_m5stickv/firmware-update-250.png" align="right" class="m5stickv">
<img src="/krux/img/maixpy_amigo/firmware-update-300.png" align="right" class="amigo">
Comment on lines +4 to +5
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too


To perform an upgrade, simply copy the [official release](https://github.com/selfcustody/krux/releases) `firmware.bin` and `firmware.bin.sig` files to the root of a FAT32 MBR formatted microSD card, insert the card into your device, and reboot the device. If it detects the new firmware file and is able to verify the signature, you will be prompted to install it. Only official releases are signed.

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/features/tamper-detection.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ The *TC Flash Hash* tool enables you to verify if the device's internal flash me
- **User's Region:** The area used to stored encrypted mnemonics, settings and TC Code. It generates the last set of two words.

<div style="text-align: center;">
<img src="../../../img/maixpy_amigo/tc-flash-hash-300.png" class="amigo" alt="TC Flash Hash amigo">
<img src="../../../img/maixpy_m5stickv/tc-flash-hash-250.png" class="m5stickv" alt="TC Flash Hash m5stickv">
<img src="/krux/img/maixpy_amigo/tc-flash-hash-300.png" class="amigo" alt="TC Flash Hash amigo">
<img src="/krux/img/maixpy_m5stickv/tc-flash-hash-250.png" class="m5stickv" alt="TC Flash Hash m5stickv">
Comment on lines +53 to +54
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too

</div>

*Example: On the image, the red symbol and words 'debate lunar' represent the firmware region, while 'renew great' user's region.*
Expand Down
8 changes: 4 additions & 4 deletions docs/getting-started/features/tinyseed.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
The examples below have been created so that you can test the workflow for scanning both 12 and 24 word mnemonics (the left plate only for a 12 word mnemonic and both plates for 24). The resulting fingerprint from an successful scan is also incldued in the image.

### Tinyseed
![](../../img/tinyseed_binarygrid/tinyseed.jpg)
![](/krux/img/tinyseed_binarygrid/tinyseed.jpg)

### OneKey KeyTag
![](../../img/tinyseed_binarygrid/onekey_keytag.jpg)
![](/krux/img/tinyseed_binarygrid/onekey_keytag.jpg)

### Binary Grid
![](../../img/tinyseed_binarygrid/binarygrid.jpg)
![](/krux/img/tinyseed_binarygrid/binarygrid.jpg)

## Size, Offset and Padding Reference
The general logic for how these are processed is:
Expand All @@ -23,4 +23,4 @@ If you have a different type of grid that you want to use, you will need to edit

You can match the pre-sets for supported key-types to the physical dimensions of the tag as shown below (offset numbers are in 1/10th of a millimeter).

![](../../img/tinyseed_binarygrid/size_reference.jpg)
![](/krux/img/tinyseed_binarygrid/size_reference.jpg)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too

Loading