diff --git a/docs/getting-started/installing/from-gui/usage.en.md b/docs/getting-started/installing/from-gui/usage.en.md index 94ca1a41..0edfcf38 100644 --- a/docs/getting-started/installing/from-gui/usage.en.md +++ b/docs/getting-started/installing/from-gui/usage.en.md @@ -118,7 +118,12 @@ Once you choose the device and version, it enables the "flash device" button. It * Unzip the correct firmware; - * The flash itself; + * Flash: + + * The flash itself via USB; + + * Air-gapped update via microSD; + * For beta releases: @@ -153,8 +158,6 @@ Krux-installer download can download four assets for official releases or one fo * A `kfpkg` file containing the specific firmware for choosen device; -KruxInstaller downloading kboot.kfpkg - #### Verification * Integrity verification compares the computed hash of `zip` against thei provided `zip.sha256.txt`; @@ -167,11 +170,13 @@ the `zip.sig` and `selfcustody.pem`. #### Unzip -Now you will be able to select if you do a flash process or need to do an airgap process (soon): +Now you will be able to select if you do a flash process or need to do an airgap process: KruxInstaller unzip -#### Flash +Click on [Flash with](#flash) to install via USB or [Air-gapped update with](#air-gapped-update-with) to perform upgrades via a microSD card. + +#### Flash with 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: @@ -188,6 +193,30 @@ As well a done icon: flash-krux-logo.en.txt ----8<---- +#### Air-gapped update with + +Once you've installed the initial firmware on your device via USB, you can perform upgrades via microSD card to keep the device airgapped. + +KruxInstaller unzip +> ⚠️ Click on "Air-gapped update with" + +Once the `firmware.bin` and `firmware.bin.sig` are extracted, you'll see a warning message. + +KruxInstaller warn airgap + +Insert the microSD and click "Proceed" to installer detect the microSD card. + +KruxInstaller warn airgap +> ⚠️ If you one microSD, the screen will be turned on a big button. If you have more removable drives, both microSD and drives will be listed + +Click on desired removable drive to copy both `firmware.bin` and `firmware.bin.sig`. The first is the krux firmware itself and the second +is a file that assert both firmware's integrity and authenticity. + +Now you can compare the firmware's hash computed by installer with the firmware's hash computed by the device. + +KruxInstaller warn airgap +> ⚠️ Once files are copied, remove the microSD from computer, connect to device and compare the hashes + ### Wipe device This is two step process: diff --git a/docs/img/krux-installer/airgap_done.png b/docs/img/krux-installer/airgap_done.png new file mode 100644 index 00000000..e7b0fe35 Binary files /dev/null and b/docs/img/krux-installer/airgap_done.png differ diff --git a/docs/img/krux-installer/app_settings.png b/docs/img/krux-installer/app_settings.png index 629c7c63..b5f89764 100644 Binary files a/docs/img/krux-installer/app_settings.png and b/docs/img/krux-installer/app_settings.png differ diff --git a/docs/img/krux-installer/dmg_volume.png b/docs/img/krux-installer/dmg_volume.png index c90fb66a..8707f902 100644 Binary files a/docs/img/krux-installer/dmg_volume.png and b/docs/img/krux-installer/dmg_volume.png differ diff --git a/docs/img/krux-installer/download_assets.png b/docs/img/krux-installer/download_assets.png index 01049ba0..f2abbd4a 100644 Binary files a/docs/img/krux-installer/download_assets.png and b/docs/img/krux-installer/download_assets.png differ diff --git a/docs/img/krux-installer/list_drivers.png b/docs/img/krux-installer/list_drivers.png new file mode 100644 index 00000000..65a59c23 Binary files /dev/null and b/docs/img/krux-installer/list_drivers.png differ diff --git a/docs/img/krux-installer/unzip.png b/docs/img/krux-installer/unzip.png index 7f2195a6..020e19db 100644 Binary files a/docs/img/krux-installer/unzip.png and b/docs/img/krux-installer/unzip.png differ diff --git a/docs/img/krux-installer/verification.png b/docs/img/krux-installer/verification.png index 08e95ed5..ed4d0751 100644 Binary files a/docs/img/krux-installer/verification.png and b/docs/img/krux-installer/verification.png differ diff --git a/docs/img/krux-installer/warn_airgap.png b/docs/img/krux-installer/warn_airgap.png new file mode 100644 index 00000000..4e66d7a8 Binary files /dev/null and b/docs/img/krux-installer/warn_airgap.png differ diff --git a/mkdocs.yml b/mkdocs.yml index f070d0f2..07dab066 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,12 +52,12 @@ docs_dir: docs site_dir: public extra: latest_krux: krux-v24.09.1 - latest_installer: v0.0.20-alpha-3 - latest_installer_rpm: krux-installer-0.0.20_alpha_3-1.x86_64.rpm - latest_installer_deb: krux-installer_0.0.20-alpha-3_amd64.deb - latest_installer_win: krux-installer_v0.0.20-alpha-3.Setup.exe - latest_installer_mac_arm: krux-installer_0.0.20-alpha-3_arm64.dmg - latest_installer_mac_intel: krux-installer_0.0.20-alpha-3_x86_64.dmg + latest_installer: v0.0.20-beta + latest_installer_rpm: krux-installer-0.0.20_beta-1.x86_64.rpm + latest_installer_deb: krux-installer_0.0.20-beta_amd64.deb + latest_installer_win: krux-installer_v0.0.20-beta.Setup.exe + latest_installer_mac_arm: krux-installer_0.0.20-beta_arm64.dmg + latest_installer_mac_intel: krux-installer_0.0.20-beta_x86_64.dmg social: - icon: fontawesome/solid/bullhorn link: https://bitcointalk.org/index.php?topic=5489022.0