From 40acfb44e6f60f7ebe7573613292a1f8eb9da86b Mon Sep 17 00:00:00 2001 From: Dhaval D <343411+ossdhaval@users.noreply.github.com> Date: Mon, 28 Nov 2022 13:42:58 +0530 Subject: [PATCH] docs: improve vm install instructions (#3091) * docs: add sha check instructions for rhel * docs: add sha check instructions for suse --- docs/admin/install/vm-install/rhel.md | 33 ++++++++++++++++++++++--- docs/admin/install/vm-install/suse.md | 33 +++++++++++++++++++++---- docs/admin/install/vm-install/ubuntu.md | 31 +++++++++++++++++------ 3 files changed, 81 insertions(+), 16 deletions(-) diff --git a/docs/admin/install/vm-install/rhel.md b/docs/admin/install/vm-install/rhel.md index 6435da43d9c..b317101c933 100644 --- a/docs/admin/install/vm-install/rhel.md +++ b/docs/admin/install/vm-install/rhel.md @@ -17,11 +17,38 @@ Before you install, check the [VM system requirements](vm-requirements.md). ## Install the Package -!!! note - `curl` is required to run the command below + +- Download the latest release package from the Github Janssen Project + [Releases](https://github.com/JanssenProject/jans/releases) + +``` +wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-el8.x86_64.rpm -P ~/ +``` + +- Verify integrity of the downloaded package using published `sha256sum`. + + Download `sha256sum` file for the package + + ```shell + wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-el8.x86_64.rpm.sha256sum -P ~/ + ``` + + Check the hash if it is matching. + + ```shell + sha256sum -c jans-1.0.4-el8.x86_64.rpm.sha256sum + ``` + + Output similar to below should confirm the integrity of the downloaded package. + + ```text + : OK + ``` + +- Install the package ``` -yum install -y https:$(curl -s -L https://api.github.com/repos/JanssenProject/jans/releases/latest | egrep -o '/.*el8.x86_64.rpm' | head -n 1) +yum install ~/jans-1.0.4-el8.x86_64.rpm ``` ## Run the setup script diff --git a/docs/admin/install/vm-install/suse.md b/docs/admin/install/vm-install/suse.md index dc419f51627..a3d83162822 100644 --- a/docs/admin/install/vm-install/suse.md +++ b/docs/admin/install/vm-install/suse.md @@ -19,14 +19,37 @@ Before you install, check the [VM system requirements](vm-requirements.md). ## Install the Package -Download the latest package from the Github Janssen Project -[Releases](https://github.com/JanssenProject/jans/releases) +- Download the latest release package from the Github Janssen Project + [Releases](https://github.com/JanssenProject/jans/releases) -!!! note - `curl` is required to run the command below +``` +wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-suse15.x86_64.rpm -P ~/ +``` + +- Verify integrity of the downloaded package using published `sha256sum`. + + Download `sha256sum` file for the package + + ```shell + wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-suse15.x86_64.rpm.sha256sum -P ~/ + ``` + + Check the hash if it is matching. + + ```shell + sha256sum -c jans-1.0.4-suse15.x86_64.rpm.sha256sum + ``` + + Output similar to below should confirm the integrity of the downloaded package. + + ```text + : OK + ``` + +- Install the package ``` -zypper --no-gpg-checks install -y https:$(curl -s -L https://api.github.com/repos/JanssenProject/jans/releases/latest | egrep -o '/.*suse15.x86_64.rpm' | head -n 1) +zypper install ~/jans-1.0.4-suse15.x86_64.rpm ``` ## Run the setup script diff --git a/docs/admin/install/vm-install/ubuntu.md b/docs/admin/install/vm-install/ubuntu.md index f92b21c6646..962dabad81f 100644 --- a/docs/admin/install/vm-install/ubuntu.md +++ b/docs/admin/install/vm-install/ubuntu.md @@ -15,22 +15,37 @@ Before you install, check the [VM system requirements](vm-requirements.md). ## Install the Package -Download the latest package from the Github Janssen Project +- Download the latest release package from the Github Janssen Project [Releases](https://github.com/JanssenProject/jans/releases) -!!! note - `curl` and `wget` are required to run the command below which -strips the version number from the package, you also might need to install python3. - - ``` -wget http:$(curl -s -L https://api.github.com/repos/JanssenProject/jans/releases/latest | egrep -o '/.*ubuntu20.04_amd64.deb' | head -n 1) -O ~/jans.ubuntu20.04_amd64.deb +wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans_1.0.4.ubuntu20.04_amd64.deb -P ~/ ``` +- Verify integrity of the downloaded package by verifying published `sha256sum`. + + Download `sha256sum` file for the package + + ```shell + wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans_1.0.4.ubuntu20.04_amd64.deb.sha256sum -P ~/ + ``` + + Check the hash if it is matching. + + ```shell + sha256sum -c jans_1.0.4.ubuntu20.04_amd64.deb.sha256sum + ``` + + Output similar to below should confirm the integrity of the downloaded package. + + ```text + : OK + ``` + - Install the package ``` -apt install -y ~/jans.ubuntu20.04_amd64.deb +apt install -y ~/jans_1.0.4.ubuntu20.04_amd64.deb ``` ## Run the setup script