-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix:jans-cli add new pages and enhance structure
- Loading branch information
1 parent
4b6ab89
commit e609676
Showing
9 changed files
with
247 additions
and
195 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
jans-cli-tui/docs/docs/getting_started/installation/dynamic-download.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Install Janssen Server using Dynamic Download | ||
|
|
||
| Dynamic download installs the latest development version of Janssen Server. This installation method is suitable for setting up development environments. | ||
|
|
||
| ## System Requirements | ||
|
|
||
| System should meet [minimum VM system requirements](vm-requirements.md) | ||
|
|
||
| ## Supported Linux Distributions | ||
| - Enterprise Linux 8 (CentOS 8 and Red Hat 8) | ||
| - Ubuntu 20 | ||
| - SUSE 15 | ||
|
|
||
| ## Installation Steps | ||
|
|
||
| 1. Download installer | ||
| ``` | ||
| curl https://raw.githubusercontent.com/JanssenProject/jans/main/jans-linux-setup/jans_setup/install.py > install.py | ||
| ``` | ||
|
|
||
| 2. Execute installer | ||
| ``` | ||
| python3 install.py | ||
| ``` | ||
|
|
||
| 3. Uninstalling Janssen Server | ||
| ``` | ||
| python3 install.py -uninstall | ||
| ``` |
30 changes: 30 additions & 0 deletions
30
jans-cli-tui/docs/docs/getting_started/installation/rhel.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Install Janssen Server using Enterprise Linux Package | ||
|
|
||
| ## Supported versions | ||
| - Red Hat 8 | ||
| - CentOS 8 | ||
|
|
||
| !!! note | ||
| SELinux should be disabled | ||
|
|
||
| ## System Requirements | ||
|
|
||
| System should meet [minimum VM system requirements](vm-requirements.md) | ||
|
|
||
| ## Installation Steps | ||
|
|
||
| ``` | ||
| yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm | ||
| ``` | ||
| ``` | ||
| yum module enable mod_auth_openidc | ||
| ``` | ||
| ``` | ||
| yum install curl | ||
| ``` | ||
| ``` | ||
| 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) | ||
| ``` | ||
| ``` | ||
| sudo python3 /opt/jans/jans-setup/setup.py | ||
| ``` |
23 changes: 23 additions & 0 deletions
23
jans-cli-tui/docs/docs/getting_started/installation/suse.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Install Janssen Server using SUSE Linux Package | ||
|
|
||
| ## Supported versions | ||
| - SUSE 15 | ||
|
|
||
| !!! note | ||
| SELinux should be disabled | ||
|
|
||
| ## System Requirements | ||
|
|
||
| System should meet [minimum VM system requirements](vm-requirements.md) | ||
|
|
||
| ## Installation Steps | ||
|
|
||
| ``` | ||
| zypper install curl | ||
| ``` | ||
| ``` | ||
| 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) | ||
| ``` | ||
| ``` | ||
| sudo python3 /opt/jans/jans-setup/setup.py | ||
| ``` |
26 changes: 26 additions & 0 deletions
26
jans-cli-tui/docs/docs/getting_started/installation/ubuntu.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Install Janssen Server using Ubuntu Linux Package | ||
|
|
||
| ## Supported Versions | ||
| - Ubuntu 20.04 | ||
|
|
||
| !!! note | ||
| SELinux should be disabled | ||
|
|
||
| ## System Requirements | ||
|
|
||
| System should meet [minimum VM system requirements](vm-requirements.md) | ||
|
|
||
| ## Installation Steps | ||
|
|
||
| ``` | ||
| apt install wget curl | ||
| ``` | ||
| ``` | ||
| wget http:$(curl -s -L https://api.github.com/repos/JanssenProject/jans/releases/latest | egrep -o '/.*ubuntu20.04_amd64.deb' | head -n 1) -O /tmp/jans.ubuntu20.04_amd64.deb | ||
| ``` | ||
| ``` | ||
| apt install -y /tmp/jans.ubuntu20.04_amd64.deb | ||
| ``` | ||
| ``` | ||
| sudo python3 /opt/jans/jans-setup/setup.py | ||
| ``` |
8 changes: 8 additions & 0 deletions
8
jans-cli-tui/docs/docs/getting_started/installation/vm-requirements.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # VM System Requirements | ||
|
|
||
| Janssen Server needs below-mentioned minimal resources on VM. | ||
|
|
||
| ## System Requirements | ||
| - 4 GB RAM | ||
| - 2 CPU | ||
| - 20 GB Disk |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
|
|
||
| ## Janssen Modules | ||
|
|
||
| Janssen is not a big monolith--it's a lot of services working together. Whether you deploy Janssen to a Kubernetes cluster, or you are a developer running everything on one server, it's important to understand the different parts. | ||
|
|
||
| 1. **[jans-auth-server](/gluu-4/docs/plugins/oauth/oauth/)**: This component is the OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing. | ||
|
|
||
| 1. **[jans-fido2](/gluu-4/docs/plugins/fido/fido/)**: This component provides the server side endpoints to enroll and validate devices that use FIDO. It provides both FIDO U2F (register, authenticate) and FIDO 2 (attestation, assertion) endpoints. This service must be internet facing. | ||
|
|
||
| 1. **[jans-config-api](/gluu-4/docs/plugins/config_api/config_api/)**: The API to configure the auth-server and other components is consolidated in this component. This service should not be Internet-facing. | ||
|
|
||
| 1. **[jans-scim](/gluu-4/docs/plugins/scim/scim/)**: [SCIM](http://www.simplecloud.info/) is JSON/REST API to manage user data. Use it to add, edit and update user information. This service should not be Internet facing. | ||
|
|
||
| 1. **[jans-cli](jans-cli)**: This module is a command line interface for configuring the Janssen software, providing both interactive and simple single line | ||
| options for configuration. | ||
|
|
||
| 1. **[jans-client-api](/gluu-4/docs/plugins/client_api/client_api/)**: Middleware API to help application developers call an OAuth, OpenID or UMA server. You may wonder why this is necessary. It makes it easier for client developers to use OpenID signing and encryption features, without becoming crypto experts. This API provides some high level endpoints to do some of the heavy lifting. | ||
|
|
||
| 1. **[jans-core](jans-core)**: This library has code that is shared across several janssen projects. You will most likely need this project when you build other Janssen components. | ||
|
|
||
| 1. **[jans-orm](jans-orm)**: This is the library for persistence and caching implemenations in Janssen. Currently LDAP and Couchbase are supported. RDBMS is coming soon. | ||
|
|
||
| 1. **[Agama](agama)**: Agama module offers an alternative way to build authentication flows in Janssen Server. With Agama, flows are coded in a DSL (domain specific language) designed for the sole purpose of writing web flows. |
Oops, something went wrong.