From 70a90d50f890e91ee1f7e747a9fb45c495d13f36 Mon Sep 17 00:00:00 2001 From: qlrd Date: Thu, 29 Aug 2024 18:36:50 -0300 Subject: [PATCH 1/2] update docs for installing-from-gui section --- .../getting-started/installing/from-gui.en.md | 203 ---------------- .../installing/from-gui/debian-like.en.md | 56 +++++ .../installing/from-gui/fedora-like.en.md | 54 +++++ .../installing/from-gui/index.en.md | 15 ++ .../installing/from-gui/macos-arm64.en.md | 41 ++++ .../installing/from-gui/macos-intel.en.md | 41 ++++ .../from-gui/other-linux-distro.en.md | 58 +++++ .../installing/from-gui/usage.en.md | 219 ++++++++++++++++++ .../installing/from-gui/windows.en.md | 53 +++++ docs/getting-started/installing/index.en.md | 4 +- docs/img/krux-installer/app_settings.png | Bin 0 -> 77895 bytes docs/img/krux-installer/baudrate.png | Bin 0 -> 143396 bytes docs/img/krux-installer/dmg_volume.png | Bin 0 -> 131689 bytes docs/img/krux-installer/download_assets.png | Bin 0 -> 201488 bytes docs/img/krux-installer/flash.png | Bin 0 -> 339268 bytes docs/img/krux-installer/flash_done.png | Bin 0 -> 348703 bytes docs/img/krux-installer/locale_menu.png | Bin 0 -> 194939 bytes docs/img/krux-installer/main.png | Bin 10616 -> 268759 bytes docs/img/krux-installer/main2.png | Bin 20617 -> 0 bytes docs/img/krux-installer/select_device.png | Bin 23051 -> 219803 bytes docs/img/krux-installer/select_flash.png | Bin 32477 -> 0 bytes .../select_old_version_menu.png | Bin 0 -> 257119 bytes .../krux-installer/select_version_menu.png | Bin 17560 -> 206465 bytes docs/img/krux-installer/unzip.png | Bin 0 -> 211159 bytes docs/img/krux-installer/verification.png | Bin 0 -> 370817 bytes .../warn_already_downloaded.png | Bin 0 -> 303096 bytes docs/img/krux-installer/warn_beta.png | Bin 0 -> 212951 bytes docs/img/krux-installer/wipe.png | Bin 0 -> 319883 bytes docs/img/krux-installer/wipe_warn.png | Bin 28692 -> 265155 bytes docs/snippets/after-install-installer.en.md | 1 + docs/snippets/flash-krux-logo.en.txt | 6 +- docs/snippets/install-installer-macos.en.txt | 17 ++ docs/snippets/tips-after-install.en.txt | 2 +- .../verify-the-integrity-explain.en.txt | 1 + .../verify-the-signature-explain.en.txt | 7 + docs/snippets/verify-the-signature-tip.en.txt | 2 + .../verify-the-signature-trust-tip.en.txt | 4 + mkdocs.yml | 18 +- 38 files changed, 590 insertions(+), 212 deletions(-) delete mode 100644 docs/getting-started/installing/from-gui.en.md create mode 100644 docs/getting-started/installing/from-gui/debian-like.en.md create mode 100644 docs/getting-started/installing/from-gui/fedora-like.en.md create mode 100644 docs/getting-started/installing/from-gui/index.en.md create mode 100644 docs/getting-started/installing/from-gui/macos-arm64.en.md create mode 100644 docs/getting-started/installing/from-gui/macos-intel.en.md create mode 100644 docs/getting-started/installing/from-gui/other-linux-distro.en.md create mode 100644 docs/getting-started/installing/from-gui/usage.en.md create mode 100644 docs/getting-started/installing/from-gui/windows.en.md create mode 100644 docs/img/krux-installer/app_settings.png create mode 100644 docs/img/krux-installer/baudrate.png create mode 100644 docs/img/krux-installer/dmg_volume.png create mode 100644 docs/img/krux-installer/download_assets.png create mode 100644 docs/img/krux-installer/flash.png create mode 100644 docs/img/krux-installer/flash_done.png create mode 100644 docs/img/krux-installer/locale_menu.png delete mode 100644 docs/img/krux-installer/main2.png delete mode 100644 docs/img/krux-installer/select_flash.png create mode 100644 docs/img/krux-installer/select_old_version_menu.png create mode 100644 docs/img/krux-installer/unzip.png create mode 100644 docs/img/krux-installer/verification.png create mode 100644 docs/img/krux-installer/warn_already_downloaded.png create mode 100644 docs/img/krux-installer/warn_beta.png create mode 100644 docs/img/krux-installer/wipe.png create mode 100644 docs/snippets/after-install-installer.en.md create mode 100644 docs/snippets/install-installer-macos.en.txt create mode 100644 docs/snippets/verify-the-integrity-explain.en.txt create mode 100644 docs/snippets/verify-the-signature-explain.en.txt create mode 100644 docs/snippets/verify-the-signature-tip.en.txt create mode 100644 docs/snippets/verify-the-signature-trust-tip.en.txt diff --git a/docs/getting-started/installing/from-gui.en.md b/docs/getting-started/installing/from-gui.en.md deleted file mode 100644 index d0d15cec2..000000000 --- a/docs/getting-started/installing/from-gui.en.md +++ /dev/null @@ -1,203 +0,0 @@ -You can install Krux (both official or beta releases) onto your K210-based device using our -official desktop application, [KruxInstaller](https://github.com/selfcustody/krux-installer), -available for Linux and Windows. - -### Download -Download the installer by choosing the right asset for your operating system from our -[Github releases page](https://github.com/selfcustody/krux-installer/releases): - -| **Operational System** | **File** | -|------------------------------------------------------------|:------------------------------------------:| -| Windows | `{{latest_installer_underline}}.exe` | -| Debian-based: Ubuntu, PopOS, etc... | `{{latest_installer_underline}}_amd64.deb` | -| RedHat-based: Fedora, etc... | `{{latest_installer}}.x86_64.rpm` | -| Any linux distribution | `{{latest_installer}}.AppImage` | -| Package for Archlinux on [AUR](https://aur.archlinux.org/).| `krux-installer-bin` | - -### Verify files -If you trust the project developers, you can skip to [install](#install): - -> ⚠️ TIP: This step helps detect if any unauthorized modifications were made between github and your local computer. - -#### Integrity - - - - - - - - - - - - - - - - - - - - - - - - - -
SystemCommands
Windows (powershell) - ```pwsh - # Compare this output: - (Get-FileHash '{{latest_installer_underline}}.exe').Hash - - # With this: - Get-Content '{{latest_installer_underline}}.exe.sha256.txt' - ``` -
Debian-based - ```bash - sha256sum --check ./{{latest_installer_underline}}_amd64.deb.sha256.txt - ``` -
RedHat-based - ```bash - sha256txt --check ./{{latest_installer}}.x86_64.rpm.sha256.txt - ``` -
Any Linux distribution - ```bash - sha256sum --check ./{{latest_installer}}.AppImage.sha256.txt - ``` -
- -#### Authenticity -You will need have [GPG](https://gnupg.org/) installed. Most Linux already have this, but on Windows we recommend installing [GPG4Win](https://www.gpg4win.org/). - -Once installed, run this command to retrieve the developer's key: - -```bash -gpg --keyserver hkps://keys.openpgp.org --recv-keys B4281DDDFBBD207BFA4113138974C90299326322 -``` - -Then you can verify: - -| System | Command | -|------------------------|-------------------------------------------------------| -| Windows (powershell) | `gpg --verify {{latest_installer_underline}}.exe.sig` | -| Debian-based | `gpg --verify ./{{latest_installer_underline}}_amd64.deb.sig` | -| RedHat-based | `gpg --verify ./{{latest_installer}}.x86_64.rpm.sig` | -| Any Linux distribution | `gpg --verify ./{{latest_installer}}.AppImage.sig` | - -> ⚠️ TIP: If the verification was successful, you may get a message similar to: `Good signature from "qlrddev "` - -### Install -Each system require different steps to install: - - - - - - - - - - - - - - - - - - - - - - - - - - -
SystemSteps
Windows -
    -
  • The {{latest_installer_underline}}.exe is a NSIS installer;
    • -
  • The first time you run the .exe file the system will ask you to trust the application;
    • -
  • See windows section below for more information
    • -
Debian-based -
    -
  • Install with dpkg: sudo dpkg -i {{latest_installer_underline}}_amd64.deb;
    • -
  • Update it with apt-get: sudo apt-get install -f {{latest_installer_underline}}_amd64.deb.
    • -
-
RedHat-based -
    -
  • Fedora: sudo dnf install {{latest_installer}}.x86_64.rpm;
    • -
  • Other RedHat based distros: sudo yum localinstall {{latest_installer}}.x86_64.rpm.
    • -
-
Any Linux distribution -
    -
  • Place the {{latest_installer}}.AppImage where you want;
    • -
  • Modify permision to execute: chmod +x {{latest_installer}}.AppImage;
    • -
  • Run it: ./{{latest_installer}}.AppImage.
    • -
-
- -#### Windows -On Windows, you'll be faced with a blue window saying "Windows protected your PC". This occurs because -we don't have a [code signing certificate](https://signmycode.com/resources/how-to-sign-an-exe-or-windows-application), -Click on "More info" and allow the execution. Follow the installer's instructions to complete the installation. - -> 🛡️ TIP: If you followed the steps presented in [authenticity](#authenticity), you already -have the assurance that the software is from a verified and genuine software publisher - -Windows protected your computer - -### Usage - -#### Main Menu -When executing the Krux Installer, you will be presented with a menu of two items: - -KruxInstaller Main Menu - - -#### Select Device -First, select the device we want to flash. After that the menu will shown three items: - -Select Device Menu with choosen device - - Menu with three items - -#### Select Version -This option allows you to select the latest official version or the latest beta version on our github. If the connection works, you will see the following screen: - -Select version menu - -| **Version** | **Name** |**Advantages** | **Disadvantages** | -|-------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------| -| Official | `selfcustody/krux/releases/tag/* ` |