Skip to content

Commit

Permalink
Merge pull request #450 from qlrd/develop
Browse files Browse the repository at this point in the history
update docs for installing-from-gui section
  • Loading branch information
odudex authored Sep 3, 2024
2 parents 1b03495 + 569bd12 commit 8166a9e
Show file tree
Hide file tree
Showing 39 changed files with 592 additions and 214 deletions.
203 changes: 0 additions & 203 deletions docs/getting-started/installing/from-gui.en.md

This file was deleted.

56 changes: 56 additions & 0 deletions docs/getting-started/installing/from-gui/debian-like.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# :material-debian: Download assets

* [`{{latest_installer_deb}}`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_deb}})
* [`{{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 the integrity

----8<----
verify-the-integrity-explain.en.txt
----8<----

```bash
sha256sum --check ./{{latest_installer_deb}}.sha256.txt
```

## Verify the authenticity

----8<----
verify-the-signature-explain.en.txt
----8<----

```bash
gpg --verify ./{{latest_installer_deb}}.sig
```

----8<----
verify-the-signature-tip.en.txt
----8<----

## Install

**krux-installer** isn't available on Debian or Ubuntu repositories.
Therefore, only the `apt-get install` command will not work.
To install, it'll be necessary two steps:

- Install the .deb package itself:

```bash
sudo dpkg -i {{latest_installer_deb}}
```

- Update the installed package:

```bash
sudo apt-get install -f {{latest_installer_deb}}
```

It will warn you that your system user was added to `dialout` group and maybe you need to reboot
to activate the `sudoless` flash procedure.

## After install

----8<----
after-install-installer.en.md
----8<----
54 changes: 54 additions & 0 deletions docs/getting-started/installing/from-gui/fedora-like.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# :material-fedora: Download assets

* [`{{latest_installer_rpm}}`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_rpm}})
* [`{{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 the integrity

----8<----
verify-the-integrity-explain.en.txt
----8<----

```bash
sha256sum --check ./{{latest_installer_rpm}}.sha256.txt
```

## Verify the authenticity

----8<----
verify-the-signature-explain.en.txt
----8<----

```bash
gpg --verify ./{{latest_installer_rpm}}.sig
```

----8<----
verify-the-signature-tip.en.txt
----8<----

## Install

**krux-installer** isn't available on Fedora or RedHat repositories. You'll need to add it manually:

### Fedora

```bash
sudo dnf install {{latest_installer_rpm}}
```

### Other RedHat based distros:

```bash
sudo yum localinstall {{latest_installer_rpm}}
```
It will warn you that your system user was added to `dialout` group and maybe you need to reboot
to activate the `sudoless` flash procedure.

## After install

----8<----
after-install-installer.en.md
----8<----
15 changes: 15 additions & 0 deletions docs/getting-started/installing/from-gui/index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
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:

> ⚠️ WARNING: Krux-Installer latest version is in it's alpha version. Maybe you can experience
> bugs or don't like something. If it is the case, please submit a
[issue](https://github.com/selfcustody/krux-installer/issues).

- [:material-microsoft-windows: Windows](./windows.en.md)
- [:material-apple: MacOS Intel](./macos-intel.en.md)
- [:material-apple: MacOS M1/M2/M3](./macos-arm64.en.md)
- [:material-debian: Debian and like](./debian-like.en.md)
- [:material-fedora: Fedora and like](./fedora-like.en.md)
- [:material-linux: Other linux distros](./other-linux-distro.en.md)

41 changes: 41 additions & 0 deletions docs/getting-started/installing/from-gui/macos-arm64.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# :material-apple: Download assets

* [`{{latest_installer_mac_arm}}`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_mac_arm}})
* [`{{latest_installer_mac_arm}}.sha256.txt`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_mac_arm}}.sha256.txt)
* [`{{latest_installer_mac_arm}}.sig`](https://github.com/selfcustody/krux-installer/releases/download/{{latest_installer}}/{{latest_installer_mac_arm}}.sig)

## Verify the integrity

----8<----
verify-the-integrity-explain.en.txt
----8<----

```bash
sha256sum --check ./{{latest_installer_mac_arm}}.sha256.txt
```

## Verify the authenticity

----8<----
verify-the-signature-explain.en.txt
----8<----

```bash
gpg --verify ./{{latest_installer_mac_arm}}.sig
```

----8<----
verify-the-signature-tip.en.txt
----8<----

## Install

----8<----
install-installer-macos.en.txt
----8<----

## After install

----8<----
after-install-installer.en.md
----8<----
Loading

0 comments on commit 8166a9e

Please sign in to comment.