Skip to content

Commit

Permalink
docs: improve vm install instructions (#3091)
Browse files Browse the repository at this point in the history
* docs: add sha check instructions for rhel

* docs: add sha check instructions for suse
  • Loading branch information
ossdhaval authored Nov 28, 2022
1 parent a2461ee commit 40acfb4
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 16 deletions.
33 changes: 30 additions & 3 deletions docs/admin/install/vm-install/rhel.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<package-name>: 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
Expand Down
33 changes: 28 additions & 5 deletions docs/admin/install/vm-install/suse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<package-name>: 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
Expand Down
31 changes: 23 additions & 8 deletions docs/admin/install/vm-install/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<package-name>: 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
Expand Down

0 comments on commit 40acfb4

Please sign in to comment.