Skip to content

Commit

Permalink
changed the message 'verify-its-authenticity' to 'verify the authenti…
Browse files Browse the repository at this point in the history
…city'

fixed link of 'More about wallet attributes'
  • Loading branch information
qlrd committed Sep 3, 2024
1 parent 70a90d5 commit 569bd12
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 34 deletions.
4 changes: 2 additions & 2 deletions docs/getting-started/installing/from-gui/debian-like.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* [`{{latest_installer_deb}}.sha256.txt`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_deb}}.sha256.txt)
* [`{{latest_installer_deb}}.sig`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_deb}}.sig)

## Verify it's integrity
## Verify the integrity

----8<----
verify-the-integrity-explain.en.txt
Expand All @@ -14,7 +14,7 @@ verify-the-integrity-explain.en.txt
sha256sum --check ./{{latest_installer_deb}}.sha256.txt
```

## Verify it's authenticity
## Verify the authenticity

----8<----
verify-the-signature-explain.en.txt
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/installing/from-gui/fedora-like.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* [`{{latest_installer_rpm}}.sha256.txt`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_rpm}}.sha256.txt)
* [`{{latest_installer_rpm}}.sig`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_rpm}}.sig)

## Verify it's integrity
## Verify the integrity

----8<----
verify-the-integrity-explain.en.txt
Expand All @@ -14,7 +14,7 @@ verify-the-integrity-explain.en.txt
sha256sum --check ./{{latest_installer_rpm}}.sha256.txt
```

## Verify it's authenticity
## Verify the authenticity

----8<----
verify-the-signature-explain.en.txt
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/installing/from-gui/macos-intel.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* [`{{latest_installer_mac_intel}}.sha256.txt`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_mac_intel}}.sha256.txt)
* [`{{latest_installer_mac_intel}}.sig`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_mac_intel}}.sig)

## Verify it's integrity
## Verify the integrity

----8<----
verify-the-integrity-explain.en.txt
Expand All @@ -14,7 +14,7 @@ verify-the-integrity-explain.en.txt
sha256sum --check ./{{latest_installer_mac_intel}}.sha256.txt
```

## Verify it's authenticity
## Verify the authenticity

----8<----
verify-the-signature-explain.en.txt
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ For this installation, we'll use the `.deb` sources:
* [`{{latest_installer_deb}}.sha256.txt`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_deb}}.sha256.txt)
* [`{{latest_installer_deb}}.sig`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_deb}}.sig)

## Verify it's integrity
## Verify the integrity

----8<----
verify-the-integrity-explain.en.txt
Expand All @@ -16,7 +16,7 @@ verify-the-integrity-explain.en.txt
sha256sum --check ./{{latest_installer_deb}}.sha256.txt
```

## Verify it's authenticity
## Verify the authenticity

----8<----
verify-the-signature-explain.en.txt
Expand Down Expand Up @@ -49,10 +49,10 @@ To do this you'll need two tools:
ar xv {{latest_installer_deb}}
```

- Extract the `data.tar.xz` contents:
- Extract the `data.tar.zst` contents:

```bash
bsdtar -xvf data.tar.xz
bsdtar -xvf data.tar.zst
```

The binary will be located at `./usr/local/bin/krux-installer`.
34 changes: 17 additions & 17 deletions docs/getting-started/installing/from-gui/usage.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ operational systems. In the rest, the procedures will be similar.
When executing the Krux Installer, you will be presented with a menu of 4 enabled buttons and
two disabled buttons:

<img src="/krux/img/krux-installer/main.png" alt="KruxInstaller Main Menu" />
<img width="640" src="/krux/img/krux-installer/main.png" alt="KruxInstaller Main Menu" />

* Enabled buttons:
* `Version`: select a firmware version;
Expand All @@ -31,7 +31,7 @@ two disabled buttons:
At startup, the application will setup it to the latest one, `{{latest_krux}}`. But you can select
even a beta release or older versions:

<img src="/krux/img/krux-installer/select_version_menu.png" alt="KruxInstaller Select Version Menu" />
<img width="640" src="/krux/img/krux-installer/select_version_menu.png" alt="KruxInstaller Select Version Menu" />

* Click in the button that show the text `Version: {{latest_krux}}`;

Expand All @@ -43,13 +43,13 @@ even a beta release or older versions:

After choose `odudex/krux_binaries`, you'll be warned with a message:

<img src="/krux/img/krux-installer/warn_beta.png" alt="KruxInstaller warning beta version" />
<img width="640" src="/krux/img/krux-installer/warn_beta.png" alt="KruxInstaller warning beta version" />

#### Older versions

* We put this option in case you have any interest in the history of firmware development;

<img src="/krux/img/krux-installer/select_old_version_menu.png" alt="KruxInstaller Select Old Version Menu" />
<img width="640" src="/krux/img/krux-installer/select_old_version_menu.png" alt="KruxInstaller Select Old Version Menu" />

* Each version supports one device or the other;

Expand All @@ -68,7 +68,7 @@ After choose `odudex/krux_binaries`, you'll be warned with a message:

Here you can configure some of the specifics of krux firmare, like:

<img src="/krux/img/krux-installer/app_settings.png" alt="KruxInstaller App settings Menu" />
<img width="640" src="/krux/img/krux-installer/app_settings.png" alt="KruxInstaller App settings Menu" />

* Where you'll save downloaded assets;

Expand All @@ -79,7 +79,7 @@ Here you can configure some of the specifics of krux firmare, like:
##### Flash baudrate
The flash baudrate is how quickly the firmware will be written to the device.

<img src="/krux/img/krux-installer/baudrate.png" alt="KruxInstaller baudrate" />
<img width="640" src="/krux/img/krux-installer/baudrate.png" alt="KruxInstaller baudrate" />

But not any value can be used. The valid ones are: 9600, 19200, 28800, 38400, 57600, 76800, 115200,
230400, 460800, 576000, 921600, 1500000.
Expand All @@ -88,7 +88,7 @@ But not any value can be used. The valid ones are: 9600, 19200, 28800, 38400, 57

At startup, **krux-installer** recognize the locale used in your system. If your language isn't supported, it will defaults to `en_US`.

<img src="/krux/img/krux-installer/locale_menu.png" alt="KruxInstaller locale menu" />
<img width="640" src="/krux/img/krux-installer/locale_menu.png" alt="KruxInstaller locale menu" />


### Select Device
Expand All @@ -99,7 +99,7 @@ on which the firmware will be written.

First, select the device we want to flash. After that the menu will shown three items:

<img src="/krux/img/krux-installer/select_device.png" alt="Select Device Menu" />
<img width="640" src="/krux/img/krux-installer/select_device.png" alt="Select Device Menu" />

Note that some devices may be disabled if they are not supported by the chosen version

Expand Down Expand Up @@ -131,7 +131,7 @@ Once you choose the device and version, it enables the "flash device" button. It
If you already downloaded assets, you'll be warned about this and will be offered the possibility
to download again or continue without downloading:

<img src="/krux/img/krux-installer/warn_already_downloaded.png" alt="KruxInstaller already downloaded" />
<img width="640" src="/krux/img/krux-installer/warn_already_downloaded.png" alt="KruxInstaller already downloaded" />

#### Download

Expand All @@ -147,13 +147,13 @@ Krux-installer download can download four assets for official releases or one fo

* Download the `selfcustody.pem` file containing a public key certificate, signed by `odudex`;

<img src="/krux/img/krux-installer/download_assets.png" alt="KruxInstaller downloading assets" />
<img width="640" src="/krux/img/krux-installer/download_assets.png" alt="KruxInstaller downloading assets" />

##### Beta releases

* A `kfpkg` file containing the specific firmware for choosen device;

<img src="/krux/img/krux-installer/verification.png" alt="KruxInstaller downloading assets" />
<img width="640" src="/krux/img/krux-installer/download_beta.png" alt="KruxInstaller downloading kboot.kfpkg" />

#### Verification

Expand All @@ -162,26 +162,26 @@ Krux-installer download can download four assets for official releases or one fo
* Authenticity verification check if the `zip` file was really signed by `odudex`, using
the `zip.sig` and `selfcustody.pem`.

<img src="/krux/img/krux-installer/verification.png" alt="KruxInstaller verification process" />
<img width="640" src="/krux/img/krux-installer/verification.png" alt="KruxInstaller verification process" />


#### Unzip

Now you will be able to select if you do a flash process or need to do an airgap process (soon):

<img src="/krux/img/krux-installer/unzip.png" alt="KruxInstaller unzip" />
<img width="640" src="/krux/img/krux-installer/unzip.png" alt="KruxInstaller unzip" />

#### Flash

When flash starts, it will warn you to **not disconnect the device until the process is complete**.
You'll be able to see the flash progress:

<img src="/krux/img/krux-installer/flash.png" alt="KruxInstaller unzip" />
<img width="640" src="/krux/img/krux-installer/flash.png" alt="KruxInstaller unzip" />
> ⚠️ TIP: You must connect and turn on your device **before click extract and flashing starts!**.
As well a done icon:

<img src="/krux/img/krux-installer/flash_done.png" alt="KruxInstaller unzip" />
<img width="640" src="/krux/img/krux-installer/flash_done.png" alt="KruxInstaller unzip" />

> ⚠️ TIP:
----8<----
Expand All @@ -200,7 +200,7 @@ This is two step process:

Before the wipe starts, it will show to you a message:

<img src="/krux/img/krux-installer/wipe_warn.png" alt="Wipe Warning" />
<img width="640" src="/krux/img/krux-installer/wipe_warn.png" alt="Wipe Warning" />
> ⚠️ TIP: It's useful when your device is not working or for security reasons.
To use Krux again, you'll need to re-flash the firmware.

Expand All @@ -209,7 +209,7 @@ To use Krux again, you'll need to re-flash the firmware.
Once the process starts, the screen will appear frozen and a spinner will keep moving.
When it's done, you can scroll down you will see a `check` icon.

<img src="/krux/img/krux-installer/wipe.png" alt="Wipe Warning" />
<img width="640" src="/krux/img/krux-installer/wipe.png" alt="Wipe Warning" />
> ⚠️ TIP: Do not unplug or poweroff your device or computer. Wait until the process finishes.
## Tips after install
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/installing/from-gui/windows.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* [`{{latest_installer_win}}.sha256.txt`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_win}}.sha256.txt)
* [`{{latest_installer_win}}.sig`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_win}}.sig)

## Verify it's integrity
## Verify the integrity

----8<----
verify-the-integrity-explain.en.txt
Expand All @@ -14,7 +14,7 @@ verify-the-integrity-explain.en.txt
(Get-FileHash '.\{{latest_installer_win}}').Hash -eq (Get-Content '.\{{latest_installer_win}}')
```

## Verify it's authenticity
## Verify the authenticity

* You'll need have [GPG](https://gnupg.org/) installed;
* We recommend installing [GPG4Win](https://www.gpg4win.org/).
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/usage/navigating-the-main-menu.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Don't forget to verify the resulting fingerprint in the status bar to ensure you
<img src="../../../img/maixpy_m5stickv/wallet-customization-options-125.png" align="right">
<img src="../../../img/maixpy_amigo/wallet-customization-options-150.png" align="right">

Here you are presented to the exact same customization options you have while loading a key and wallet. You can change the Network, Single/Multisig, Script Type and Account. [More about wallet attributes](./loading-a-mnemonic.md/#attributes)
Here you are presented to the exact same customization options you have while loading a key and wallet. You can change the Network, Single/Multisig, Script Type and Account. [More about wallet attributes](./loading-a-mnemonic.md/#confirm-wallet-attributes)

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

Expand Down Expand Up @@ -270,4 +270,4 @@ This feature is used to sign Krux releases, airgapped, using a Krux device.

Coordinators like Sparrow and Specter offer the possibility to sign messages at a Bitcoin receive address, allowing you to attest ownership of that address. Krux will detect if the message is of this type and present a similar workflow for signing. The main difference is that the address will be displayed along with the raw message, and since the message is signed with a derived address instead of the master public key, Krux won't offer the option to export the raw public key after the signature.

<div style="clear: both"></div>
<div style="clear: both"></div>
2 changes: 1 addition & 1 deletion docs/snippets/after-install-installer.en.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Once installed, you can proceed to [firmware installation](./usage.en.md).
Once installed, you can proceed to [firmware installation](/krux/gettings-started/installing/from-gui/usage.en.md).
2 changes: 1 addition & 1 deletion docs/snippets/tips-after-install.en.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
Prefer a different language? Krux has support for multiple languages. Once at the start screen, go to `Settings`, followed by `Locale`, and select the locale you wish to use.

### Upgrade via microSD card
Once you've installed the initial firmware on your device via USB, you can either continue updating the device by flashing or you can perform upgrades [via microSD](../features/sd-card-update.md) card to keep the device airgapped.
Once you've installed the initial firmware on your device via USB, you can either continue updating the device by flashing or you can perform upgrades [via microSD](/krux/getting-started/features/sd-card-update/) card to keep the device airgapped.
2 changes: 1 addition & 1 deletion docs/snippets/verify-the-signature-trust-tip.en.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> 🛡️ TIP: If you followed the steps presented in [authenticity section](#verify-its-authenticity),
> 🛡️ TIP: If you followed the steps presented in [authenticity section](#verify-the-authenticity),
you already have the assurance that the software is from a verified and genuine software publisher.
This will also help establish a chain of trust when you perform the firmware verification
step before flashing.

0 comments on commit 569bd12

Please sign in to comment.