Skip to content

Commit

Permalink
Improved VM Install docs (#2721)
Browse files Browse the repository at this point in the history 
Made some small improvements
  • Loading branch information
@nynymike
nynymike authored Oct 25, 2022
1 parent cc0020e commit 4591e70
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 87 deletions.
76 changes: 32 additions & 44 deletions docs/admin/install/vm-install/rhel.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,81 +4,69 @@ tags:
- installation
- vm
- RHEL
- RedHat
- CentOS
---

# Install Janssen Server using Enterprise Linux Package
# Ubuntu Janssen Installation

Before you install, check the [VM system requirements](vm-requirements.md).

## Supported versions
- Red Hat 8
- Red Hat Enterprise Linus 8 (RHEL 8)
- CentOS 8

!!! note
[SELinux](https://wiki.ubuntu.com/SELinux) should be disabled

## System Requirements

System should meet [minimum VM system requirements](vm-requirements.md)

## Prerequisites

- System should be registered and attached with Red Hat. This is required to run commands that install packages like `mod_auth_openidc`
- Install Extra Packages for Enterprise Linux (EPEL)

```
yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
```

- `curl` should be instlled. This can be easily installed using the command below

```
yum install curl
```

## Install

- Enable the `mod_auth_openidc` module
## Install the Package

```
yum module enable mod_auth_openidc
```

- Download and Install the Janssen Server Linux package
!!! note
`curl` is required to run the command below

```
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)
```

- Initiate the setup process using the command below. The setup process will prompt for user for inputs.
## Run the setup script

- Run the setup script in interactive mode:

```
sudo python3 /opt/jans/jans-setup/setup.py
```

The installer should confirm successful installation with a message similar to the one shown below:
The installer should confirm successful installation with a message similar
to the one shown below:

![](../../../assets/image-jans-install-success.png)

See more detailed [instructions](setup-script.md) on the setup script if you're
confused how to answer any of the questions, for details about command line
arguments, or you would prefer to use a properties file instead of
interactive mode.

## Verify the Installation

After the successful completion of setup process, [verify the system health](../install-faq.md#after-installation-how-do-i-verify-that-the-janssen-server-is-up-and-running).

### Uninstall Janssen Server
### Red Hat / Centos Un-installation

Removing Janssen is a two step process:

Use the command below to uninstall the Janssen server
1. Delete files installed by Janssen
1. Remove and purge the `jans` package

```commandline
* Use the command below to uninstall the Janssen server

```
python3 /opt/jans/jans-setup/install.py -uninstall
```

Console output like below will confirm the successful uninstallation of the Janssen Server

```text
```
This process is irreversible.
You will lose all data related to Janssen Server.
Are you sure to uninstall Janssen Server? [yes/N] yes
Uninstalling Jannsen Server...
Expand Down Expand Up @@ -109,13 +97,13 @@ Removing /etc/apache2/sites-available/https_jans.conf
```

### Remove the linux package
* Remove the linux package

Use the command below to remove and purge `jans` package

```text
```
yum remove jans.x86_64
```

Successful removal will remove the Janssen Server package along with the removal of all the unused dependencies.

Successful removal will remove the Janssen Server package along with
the removal of all the unused dependencies.
50 changes: 25 additions & 25 deletions docs/admin/install/vm-install/suse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,44 +5,45 @@ tags:
- vm
- SUSE
- SLES
- Tumbleweed
---

# Install Janssen Server using the SUSE Linux Enterprise Server (SLES) Package
# SUSE Janssen Installation

Before you install, check the [VM system requirements](vm-requirements.md).

Janssen Server can be installed using the Linux package for SLES

## Supported versions
- SUSE Linux Enterprise Server (SLES) 15
- openSUSE Leap 15.4
- openSUSE Tumbleweed (non-production)

!!! note
[SELinux](https://wiki.ubuntu.com/SELinux) should be disabled

## System Requirements

System should meet [minimum VM system requirements](vm-requirements.md)
## Install the Package

## Prerequisites
Download the latest package from the Github Janssen Project
[Releases](https://github.com/JanssenProject/jans/releases)

- `curl` should be installed. This can be easily installed using the command below

```
zypper install curl
```

## Install

- Download and install package from the Janssen Project site using the command below
!!! note
`curl` is required to run the command below

```
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)
```

- Initiate the setup process using the command below. The setup process will prompt for user for inputs.
## Run the setup script

- Run the setup script in interactive mode:

```
python3 /opt/jans/jans-setup/setup.py
```

See more detailed [instructions](setup-script.md) on the setup script if you're
confused how to answer any of the questions, for details about command line
arguments, or you would prefer to use a properties file instead of
interactive mode.


## Verify the Installation

After the successful completion of setup process, [verify the system health](../install-faq.md#after-installation-how-do-i-verify-that-the-janssen-server-is-up-and-running).
Expand All @@ -54,22 +55,21 @@ Uninstall process involves two steps
1. Uninstall Janssen Server
2. Remove and purge the `jans` package

### Uninstall Janssen Server

Use the command below to uninstall the Janssen server

```commandline
```
python3 /opt/jans/jans-setup/install.py -uninstall
```

Console output like below will confirm the successful uninstallation of the Janssen Server
You'll see the following confirmation:

```text
```
This process is irreversible.
You will lose all data related to Janssen Server.
Are you sure to uninstall Janssen Server? [yes/N] yes
Uninstalling Jannsen Server...
Expand Down Expand Up @@ -98,4 +98,4 @@ Executing rm -r -f /opt/dist
Removing /etc/apache2/sites-enabled/https_jans.conf
Removing /etc/apache2/sites-available/https_jans.conf
```
```
29 changes: 11 additions & 18 deletions docs/admin/install/vm-install/ubuntu.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,33 @@ tags:
- ubuntu
---

# Install Janssen on Ubuntu

Janssen Server can be installed using the Linux package for Ubuntu. You can
check Github for the latest [Releases](https://github.com/JanssenProject/jans/releases)
# Ubuntu Janssen Installation

Before you install, check the [VM system requirements](vm-requirements.md).


## Supported Versions
- Ubuntu 20.04

## Install the bits
## Install the Package

- `curl` and `wget` are required if you run the command below. If you don't
have these already installed, run:
Download the latest package from the Github Janssen Project
[Releases](https://github.com/JanssenProject/jans/releases)

```
apt install curl wget
```

- Download the installer from the Janssen Project site using the command below
!!! note
`curl` and `wget` are required to run the command below which
strips the version number from the package.

```
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
```

- Unpack/install the installer package
- Install the package

```
apt install -y ~/jans.ubuntu20.04_amd64.deb
```


## Run the setup script

- Run the setup script in interactive mode:
Expand All @@ -55,7 +50,7 @@ interactive mode.

After the successful completion of setup process, [verify the system health](../install-faq.md#after-installation-how-do-i-verify-that-the-janssen-server-is-up-and-running).

# Uninstall Janssen
# Ubuntu Janssen Un-Installation

Removing Janssen is a two step process:

Expand Down Expand Up @@ -90,7 +85,6 @@ Stopping jans-auth
Removing /etc/default/jans-client-api
Stopping jans-client-api
Stopping OpenDj Server
sh: 1: /opt/opendj/bin/stop-ds: not found
Executing rm -r -f /etc/certs
Executing rm -r -f /etc/jans
Executing rm -r -f /opt/jans
Expand All @@ -103,10 +97,9 @@ Executing rm -r -f /opt/opendj
Executing rm -r -f /opt/dist
Removing /etc/apache2/sites-enabled/https_jans.conf
Removing /etc/apache2/sites-available/https_jans.conf
```

The use the command below to remove and purge the `jans` package
The command below removes and purges the `jans` package

```
apt-get --purge remove jans
Expand Down

0 comments on commit 4591e70

Please sign in to comment.