Skip to content

Commit

Permalink
deploy: 831954d
Browse files Browse the repository at this point in the history
  • Loading branch information
odudex committed Nov 29, 2024
1 parent a3c886c commit b626859
Show file tree
Hide file tree
Showing 18 changed files with 61 additions and 1,565 deletions.
2 changes: 1 addition & 1 deletion getting-started/features/encrypted-mnemonics/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1587,7 +1587,7 @@ <h2 id="encrypted-qr-codes-data-and-parsing">Encrypted QR Codes Data and Parsing
</ul>
<h2 id="considerations">Considerations<a class="headerlink" href="#considerations" title="Permanent link">&para;</a></h2>
<p>Storage of encrypted mnemonics on the device or SD cards are meant for convenience only and should not be considered a form of backup. Always make a physical backup of your keys that is independent from electronic devices and test recovering your wallet from this backup before you send funds to it.</p>
<p>Remember that the stored encrypted mnemonic is protected by the key you defined to encrypt it. If the defined <a href="https://www.hivesystems.com/blog/are-your-passwords-in-the-green">key is weak</a>, your encrypted mnemonic will not be protected. If you have stored a mnemonic with funds in the device's internal flash memory using a <a href="https://www.hivesystems.com/blog/are-your-passwords-in-the-green">weak key</a>, the best way to undo this is to <a href="../tools/#wipe-device">wipe the device</a>.</p>
<p>Remember that the stored encrypted mnemonic is protected by the key you defined to encrypt it. If the defined <a href="https://www.hivesystems.com/blog/are-your-passwords-in-the-green">key is weak</a>, your encrypted mnemonic will not be protected. If you have stored a mnemonic with funds in the device's internal flash memory using a <a href="https://www.hivesystems.com/blog/are-your-passwords-in-the-green">weak key</a>, the best way to undo this is to <a href="../tools/#erase-users-data">erase user's data</a>.</p>



Expand Down
2 changes: 1 addition & 1 deletion getting-started/features/sd-card-update/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1467,7 +1467,7 @@ <h3 id="upgrade-via-microsd-card">Upgrade via microSD card<a class="headerlink"
<p>Once you've installed the initial firmware on your device via USB, you can either continue updating the device by flashing via USB or you can perform upgrades via microSD card to keep the device airgapped.</p>
<p>To perform an upgrade, simply copy the <a href="https://github.com/selfcustody/krux/releases">official release</a> <code>firmware.bin</code> and <code>firmware.bin.sig</code> files to the root of a FAT-32 / 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.</p>
<p>Once installation is complete, eject the microSD card and delete the firmware files before reinserting and rebooting. Otherwise you will be prompted to install it again.</p>
<p>We cannot guarantee that a microSD card is compatible and will work in your device; you'll need to test it on the device to be sure, read the <a href="troubleshooting.md/#why-isnt-krux-detecting-my-microsd-card-or-presenting-an-error">Troubleshooting</a> for more info.
<p>We cannot guarantee that a microSD card is compatible and will work in your device; you'll need to test it on the device to be sure, read the <a href="/krux/troubleshooting/#why-isnt-krux-detecting-my-microsd-card-or-presenting-an-error">Troubleshooting</a> for more info.
Only official releases are signed and can be installed via microSD card.</p>


Expand Down
2 changes: 1 addition & 1 deletion getting-started/features/tamper-detection/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1644,7 +1644,7 @@ <h3 id="recommendations">Recommendations<a class="headerlink" href="#recommendat
<p><strong>Learn Verification Tools:</strong> Familiarize yourself with verification methods and tools to maintain control over your device's security.</p>
</li>
<li>
<p><strong>Build from Source:</strong> Consider building the firmware from source code and verifying its reproducibility for maximum assurance.</p>
<p><strong>Build from Source:</strong> Consider building the firmware from source code and verifying its <a href="../../installing/from-source/#reproducibility">reproducibility</a> for maximum assurance.</p>
</li>
<li>
<p><strong>Use SD Card for Updates:</strong> After the initial flash through USB, perform subsequent updates via the SD card. This keeps your device air-gapped and allows the existing firmware to verify new updates before installation.</p>
Expand Down
1 change: 0 additions & 1 deletion getting-started/installing/from-gui/debian-like/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1530,7 +1530,6 @@ <h2 id="install">Install<a class="headerlink" href="#install" title="Permanent l
<p>It will warn you that your system user was added to <code>dialout</code> group and maybe you need to reboot
to activate the <code>sudoless</code> flash procedure.</p>
<h2 id="after-install">After install<a class="headerlink" href="#after-install" title="Permanent link">&para;</a></h2>
<p>Once installed, you can proceed to <a href="/krux/getting-started/installing/from-gui/usage">firmware installation</a>. </p>



Expand Down
1 change: 0 additions & 1 deletion getting-started/installing/from-gui/fedora-like/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1548,7 +1548,6 @@ <h3 id="other-redhat-based-distros">Other RedHat based distros:<a class="headerl
<p>It will warn you that your system user was added to <code>dialout</code> group and maybe you need to reboot
to activate the <code>sudoless</code> flash procedure.</p>
<h2 id="after-install">After install<a class="headerlink" href="#after-install" title="Permanent link">&para;</a></h2>
<p>Once installed, you can proceed to <a href="/krux/getting-started/installing/from-gui/usage">firmware installation</a>. </p>



Expand Down
1 change: 0 additions & 1 deletion getting-started/installing/from-gui/macos-arm64/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1529,7 +1529,6 @@ <h2 id="install">Install<a class="headerlink" href="#install" title="Permanent l
step before flashing.</p>
</blockquote>
<h2 id="after-install">After install<a class="headerlink" href="#after-install" title="Permanent link">&para;</a></h2>
<p>Once installed, you can proceed to <a href="/krux/getting-started/installing/from-gui/usage">firmware installation</a>. </p>



Expand Down
1 change: 0 additions & 1 deletion getting-started/installing/from-gui/macos-intel/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1529,7 +1529,6 @@ <h2 id="install">Install<a class="headerlink" href="#install" title="Permanent l
step before flashing.</p>
</blockquote>
<h2 id="after-install">After install<a class="headerlink" href="#after-install" title="Permanent link">&para;</a></h2>
<p>Once installed, you can proceed to <a href="/krux/getting-started/installing/from-gui/usage">firmware installation</a>. </p>



Expand Down
2 changes: 1 addition & 1 deletion getting-started/installing/from-gui/usage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1908,7 +1908,7 @@ <h4 id="verification">Verification<a class="headerlink" href="#verification" tit
<h4 id="unzip">Unzip<a class="headerlink" href="#unzip" title="Permanent link">&para;</a></h4>
<p>Now you will be able to select if you do a flash process or need to do an airgap process:</p>
<p><img width="640" src="/krux/img/krux-installer/unzip.png" alt="KruxInstaller unzip" /></p>
<p>Click on <a href="#flash">Flash with</a> to install via USB or <a href="#air-gapped-update-with">Air-gapped update with</a> to perform upgrades via a SD card.</p>
<p>Click on <a href="#flash-with">Flash with</a> to install via USB or <a href="#air-gapped-update-with">Air-gapped update with</a> to perform upgrades via a SD card.</p>
<h4 id="flash-with">Flash with<a class="headerlink" href="#flash-with" title="Permanent link">&para;</a></h4>
<p>When flash starts, it will warn you to <strong>not disconnect the device until the process is complete</strong>.
You'll be able to see the flash progress:</p>
Expand Down
1 change: 0 additions & 1 deletion getting-started/installing/from-gui/windows/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1554,7 +1554,6 @@ <h2 id="install">Install<a class="headerlink" href="#install" title="Permanent l
<p>Follow the installer's instructions to complete the installation. At the end, click on
"Create desktop icon":</p>
<h2 id="after-install">After install<a class="headerlink" href="#after-install" title="Permanent link">&para;</a></h2>
<p>Once installed, you can proceed to <a href="/krux/getting-started/installing/from-gui/usage">firmware installation</a>. </p>



Expand Down
11 changes: 10 additions & 1 deletion getting-started/installing/from-pre-built-release/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1566,8 +1566,17 @@ <h3 id="verify-the-files">Verify the files<a class="headerlink" href="#verify-th
<li>The <em>signature file</em> <code>krux-v24.11.1.zip.sig</code> can be verified with the <a href="https://github.com/selfcustody/krux/blob/main/selfcustody.pem"><code>selfcustody.pem</code> public key</a> found in the root of the krux repository.</li>
</ol>
<p>You can either do this manually or with the <code>krux</code> shell script, which contains helper commands for this:
<div class="highlight"><pre><span></span><code>./krux<span class="w"> </span>sha256<span class="w"> </span>krux-v24.11.1.zip
<div class="highlight"><pre><span></span><code><span class="c1">### Using krux script ###</span>
<span class="c1"># Hash checksum</span>
./krux<span class="w"> </span>sha256<span class="w"> </span>krux-v24.11.1.zip
<span class="c1"># Signature</span>
./krux<span class="w"> </span>verify<span class="w"> </span>krux-v24.11.1.zip<span class="w"> </span>selfcustody.pem

<span class="c1">### Manually ###</span>
<span class="c1"># Hash checksum</span>
sha256sum<span class="w"> </span>krux-v24.11.1.zip.sha256.txt<span class="w"> </span>-c
<span class="c1">#Signature</span>
openssl<span class="w"> </span>sha256<span class="w"> </span>&lt;krux-v24.11.1.zip<span class="w"> </span>-binary<span class="w"> </span><span class="p">|</span><span class="w"> </span>openssl<span class="w"> </span>pkeyutl<span class="w"> </span>-verify<span class="w"> </span>-pubin<span class="w"> </span>-inkey<span class="w"> </span>selfcustody.pem<span class="w"> </span>-sigfile<span class="w"> </span>krux-v24.11.1.zip.sig
</code></pre></div></p>
<p>On Mac you may need to install <code>coreutils</code> to be able to use <code>sha256sum</code>
<div class="highlight"><pre><span></span><code>brew install coreutils
Expand Down
12 changes: 8 additions & 4 deletions getting-started/installing/from-source/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1593,16 +1593,20 @@ <h3 id="build-the-firmware-linux-or-wsl">Build the firmware (Linux or WSL)<a cla
Failed to clone ...
</code></pre></div></p>
<h4 id="reproducibility">Reproducibility<a class="headerlink" href="#reproducibility" title="Permanent link">&para;</a></h4>
<p>If you build from the <code>main</code> branch of the source code, you should be able to reproduce the build process used to generate the last release binaries and obtain exact copies of the <code>firmware.bin</code> and <code>kboot.kfpkg</code> files, with matching hash checksums.</p>
<p>To extract and verify the firmware.bin contained in kboot.kfpkg, you can use the following command:</p>
<p>If you build from the <code>main</code> branch of the source code, you should be able to reproduce the build process used to generate the latest release binaries and obtain exactly the same copies of the <code>firmware.bin</code> and <code>kboot.kfpkg</code> files, with matching hash checksums (to check for an older version, use the <code>tag</code> instead).</p>
<p>To check, use the compiled files for the target device. Each command should output the same hash for the two provided files:
<div class="highlight"><pre><span></span><code>sha256sum<span class="w"> </span>build/firmware.bin<span class="w"> </span>krux-v24.11.1/maixpy_DEVICE/firmware.bin
sha256sum<span class="w"> </span>build/kboot.kfpkg<span class="w"> </span>krux-v24.11.1/maixpy_DEVICE/kboot.kfpkg
</code></pre></div></p>
<p>If you want to extract and verify the <code>firmware.bin</code>file contained in <code>kboot.kfpkg</code>, use the following:</p>
<div class="highlight"><pre><span></span><code>unzip<span class="w"> </span>kboot.kfpkg<span class="w"> </span>-d<span class="w"> </span>./kboot/
</code></pre></div>
<h3 id="flash-the-firmware-onto-the-device">Flash the firmware onto the device<a class="headerlink" href="#flash-the-firmware-onto-the-device" title="Permanent link">&para;</a></h3>
<p>Connect the device to your computer via USB (for Maix Amigo, make sure you’re using bottom port), power it on, and run the following, replacing <code>DEVICE</code> with either <code>m5stickv</code>, <code>amigo</code>, <code>bit</code>, <code>cube</code>, <code>dock</code> or <code>yahboom</code>:
<div class="highlight"><pre><span></span><code><span class="c1"># build firmware for DEVICE</span>
<div class="highlight"><pre><span></span><code><span class="c1"># flash firmware to DEVICE</span>
./krux<span class="w"> </span>flash<span class="w"> </span>maixpy_DEVICE
</code></pre></div>
If the flashing fails try one of the following common solutions listed on FAQ</p>
If flashing fails try reading <a href="../../../troubleshooting/">Troubleshooting</a></p>
<p>When the flashing process completes, you should see the Krux logo:</p>
<p><img src="/krux/img/maixpy_amigo/logo-150.png">
<img src="/krux/img/maixpy_m5stickv/logo-125.png"></p>
Expand Down
2 changes: 1 addition & 1 deletion parts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1766,7 +1766,7 @@ <h2 id="other-parts">Other Parts<a class="headerlink" href="#other-parts" title=
<h3 id="usb-c-or-micro-usb-charge-cable">USB-C or Micro USB Charge Cable<a class="headerlink" href="#usb-c-or-micro-usb-charge-cable" title="Permanent link">&para;</a></h3>
<p>This will come with the device. It will be necessary to power, charge the device (if it has battery) and to initially flash the firmware.</p>
<h3 id="optional-microsd-card">(Optional) MicroSD Card<a class="headerlink" href="#optional-microsd-card" title="Permanent link">&para;</a></h3>
<p>We cannot guarantee that a microSD card is compatible and will work in your device; you'll need to test it on the device to be sure, read the <a href="../troubleshooting/#why-isnt-krux-detecting-my-microsd-card-or-presenting-an-error">Troubleshooting</a> for more info.
<p>We cannot guarantee that a microSD card is compatible and will work in your device; you'll need to test it on the device to be sure, read the <a href="/krux/troubleshooting/#why-isnt-krux-detecting-my-microsd-card-or-presenting-an-error">Troubleshooting</a> for more info.
Yahboom will come with a compatible 32G card. The size of the SD card isn't important; anything over a few megabytes will be plenty.</p>
<h3 id="optional-ttl-serial-thermal-printer">(Optional) TTL Serial Thermal Printer<a class="headerlink" href="#optional-ttl-serial-thermal-printer" title="Permanent link">&para;</a></h3>
<p><strong>Warning/Disclaimer</strong>: This feature is intended for individuals with experience in electronics tinkering and soldering.</p>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit b626859

Please sign in to comment.