From 03e122c72cd15630622072c021ddc71669c03a62 Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Fri, 18 Nov 2022 09:29:46 +0200 Subject: [PATCH 1/9] docs: docker installation --- docs/admin/install/docker.md | 88 ++++++++++++++++++ .../install/vm-install/quick-start-install.md | 93 ------------------- mkdocs.yml | 3 +- 3 files changed, 89 insertions(+), 95 deletions(-) create mode 100644 docs/admin/install/docker.md delete mode 100644 docs/admin/install/vm-install/quick-start-install.md diff --git a/docs/admin/install/docker.md b/docs/admin/install/docker.md new file mode 100644 index 00000000000..54d5e59258c --- /dev/null +++ b/docs/admin/install/docker.md @@ -0,0 +1,88 @@ +!!! Warning + **This image is for testing and development purposes only. Use Janssen [helm charts](../charts) for production setups.** + +## Overview + +Docker monolith image packaging for Janssen. This image packs janssen services including the auth-server, config-api, fido2, and scim. + +## Pre-requisites + +- [Docker](https://docs.docker.com/install) +- [Docker compose](https://docs.docker.com/compose/install/) + + +## Environment Variables + +Installation depends on a set of environment variables. These environment variables can be set to customize installation as per the need. If not set, the installer uses default values. + +| ENV | Description | Default | +|-------------------------|--------------------------------------------------|--------------------------------------------------| +| `CN_HOSTNAME` | Hostname to install janssen with. | `demoexample.jans.io` | +| `CN_ADMIN_PASS` | Password of the admin user. | `1t5Fin3#security` | +| `CN_ORG_NAME` | Organization name. Used for ssl cert generation. | `Janssen` | +| `CN_EMAIL` | Email. Used for ssl cert generation. | `support@jans.io` | +| `CN_CITY` | City. Used for ssl cert generation. | `Austin` | +| `CN_STATE` | State. Used for ssl cert generation | `TX` | +| `CN_COUNTRY` | Country. Used for ssl cert generation. | `US` | +| `CN_INSTALL_LDAP` | **NOT SUPPORRTED YET** | `false` | +| `CN_INSTALL_CONFIG_API` | Installs the Config API service. | `true` | +| `CN_INSTALL_SCIM` | Installs the SCIM API service. | `true` | +| `CN_INSTALL_FIDO2` | Installs the FIDO2 API service. | `true` | +| `MYSQL_DATABASE` | MySQL jans database. | `jans` | +| `MYSQL_USER` | MySQL database user. | `jans` | +| `MYSQL_PASSWORD` | MySQL database user password. | `1t5Fin3#security` | +| `MYSQL_HOST` | MySQL host. | `mysql` which is the docker compose service name | + + +## How to run + +Download the compose file + +```bash + +wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml +``` + +This docker compose file run two containers, the janssen monolith container and mysql container. + +```bash +docker compose -f jans-mysql-compose.yml up -d +``` + +To see the containers running + +```bash + +docker ps +``` + +## Configure + +```bash +docker ps #List the containers running. Copy the container name of monolith jans + +docker exec -ti bash #This opens a bash terminal in the running container + +/opt/jans/jans-cli/config-cli.py #configure config-cli + +/opt/jans/jans-cli/scim-cli.py #configure scim +``` + +## Access endpoints externally + +Add to your `/etc/hosts` file the ip domain record which should be the ip of the instance docker is installed at and the domain used in the env above `CN_HOSTNAME`. + +```bash +# For-example +172.22.0.3 demoexample.jans.io +``` + +After adding the record you can hit endpoints such as https://demoexample.jans.io/.well-known/openid-configuration + +## Clean up + +Remove setup and volumes + +``` +docker compose -f jans-mysql-compose.yml down && rm -rf jans-* +``` diff --git a/docs/admin/install/vm-install/quick-start-install.md b/docs/admin/install/vm-install/quick-start-install.md deleted file mode 100644 index 0dff2cc72fc..00000000000 --- a/docs/admin/install/vm-install/quick-start-install.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -tags: -- administration -- installation -- quick-start -- docker ---- - -# Docker Based Quick Start Installation - -The quickest way to get a Janssen Server up and running is to install a Docker container-based fully featured Janssen Server. - -!!! Note - - This method of installation is suitable only for testing, development, or feature exploration purposes. Not for production deployments. - -## System Requirements - -System should meet [minimum VM system requirements](vm-requirements.md) - -## Install - -Run the command given below to start the installation. - -Installation depends on a [set of environment variables](https://github.com/JanssenProject/jans/tree/main/docker-jans-monolith#environment-variables). -These environment variables can be set to customize installation as per the need. If not set, the installer uses default values. - -```bash -wget https://raw.githubusercontent.com/JanssenProject/jans/main/automation/startjanssenmonolithdemo.sh && chmod u+x startjanssenmonolithdemo.sh && sudo bash startjanssenmonolithdemo.sh demoexample.jans.io MYSQL -``` - -At the end of the process, following messages will confirm that the Janssen server and related services are up and running in respective Docker containers. - -``` -[+] Running 3/3 - ⠿ Network docker-jans-monolith_cloud_bridge Created 0.0s - ⠿ Container docker-jans-monolith-mysql-1 Started 0.6s - ⠿ Container docker-jans-monolith-jans-1 Started 0.9s - -Waiting for the Janssen server to come up. Depending on the resources it may take 3-5 mins for the services to be up. -Testing openid-configuration endpoint.. -``` - -As can be seen, the install script also accesses the well-known endpoints to varify that Janssen Server is responsive. - -## Verify Installation By Accessing Standard Endpoints - - -To access Janssen Server standard endpoints from outside of the Docker container, systems `/etc/hosts` file needs to be updated. Open the file and add the IP domain record which should be the IP of the instance docker is installed. And the domain used in the env above `CN_HOSTNAME`. - -```bash -# For-example -172.22.0.3 demoexample.jans.io -``` - -After adding the record, hit the standard endpoints such as - -``` -https://demoexample.jans.io/.well-known/openid-configuration -``` - -## Configure Janssen Server - -Access the Docker container shell using: - -```bash -docker exec -ti docker-jans-monolith-jans-1 bash -``` - -And then use CLI tools to configure Janssen Server as needed. - -```bash -/opt/jans/jans-cli/config-cli.py -#or -/opt/jans/jans-cli/scim-cli.py -``` - -## Uninstall / Remove the Janssen Server - -This docker based installation uses `docker compose` under the hood to create containers. Hence to uninstalling Janssen server involves invoking `docker compose` with appropriate yml file. Run command below to stop and remove containers. - -``` -docker compose -f /tmp/jans/docker-jans-monolith/jans-mysql-compose.yml down && rm -rf jans-* -``` - -Console messages like below confirms the successful removal. - -``` -[+] Running 3/3 - ⠿ Container docker-jans-monolith-jans-1 Removed 10.5s - ⠿ Container docker-jans-monolith-mysql-1 Removed 0.9s - ⠿ Network docker-jans-monolith_cloud_bridge Removed 0.1s -``` diff --git a/mkdocs.yml b/mkdocs.yml index da779caf344..ae349bb2662 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -139,11 +139,9 @@ nav: - 'Passwordless Authentication': 'admin/planning/passwordless-auth.md' - 'Machine-to-Machine Authentication': 'admin/planning/machine-to-machine.md' - 'Installation': - - 'admin/install/README.md' - 'VM Installation': - 'admin/install/vm-install/README.md' - 'VM Requirements': 'admin/install/vm-install/vm-requirements.md' - - 'Docker Quick Start': 'admin/install/vm-install/quick-start-install.md' - 'Ubuntu': 'admin/install/vm-install/ubuntu.md' - 'RHEL': 'admin/install/vm-install/rhel.md' - 'Suse': 'admin/install/vm-install/suse.md' @@ -158,6 +156,7 @@ nav: - 'Microsoft Azure AKS': 'admin/install/helm-install/microsoft-azure.md' # - 'Red Hat Open Shift': 'admin/install/helm-install/red-hat-open-shift.md' - 'Using Rancher Marketplace': 'admin/install/helm-install/rancher.md' + - 'Docker Installation': 'admin/install/docker.md' - 'Setup Instructions': 'admin/install/setup.md' - 'FAQ': 'admin/install/install-faq.md' - 'Kubernetes Operation Guide': From 2255f5166442b7e4be91314f4877a5b51c1a5c38 Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Mon, 21 Nov 2022 20:56:03 +0200 Subject: [PATCH 2/9] docs: add quick-start page --- .../install/docker-install/quick-start.md | 92 +++++++++++++++++++ mkdocs.yml | 6 +- 2 files changed, 96 insertions(+), 2 deletions(-) create mode 100644 docs/admin/install/docker-install/quick-start.md diff --git a/docs/admin/install/docker-install/quick-start.md b/docs/admin/install/docker-install/quick-start.md new file mode 100644 index 00000000000..37cab8612cf --- /dev/null +++ b/docs/admin/install/docker-install/quick-start.md @@ -0,0 +1,92 @@ +--- +tags: +- administration +- installation +- quick-start +- docker +--- + +!!! Warning + **This image is for testing and development purposes only. Use Janssen [helm charts](../charts) for production setups.** + +## Overview + +The quickest way to get a Janssen Server up and running is to install a Docker container-based fully featured Janssen Server. + +## System Requirements + +System should meet [minimum VM system requirements](vm-requirements.md) + +## Install + +Installation depends on a [set of environment variables](https://github.com/JanssenProject/jans/tree/main/docker-jans-monolith#environment-variables). +These environment variables can be set to customize installation as per the need. If not set, the installer uses default values. + +Run this command to start the installation: + +```bash +wget https://raw.githubusercontent.com/JanssenProject/jans/main/automation/startjanssenmonolithdemo.sh && chmod u+x startjanssenmonolithdemo.sh && sudo bash startjanssenmonolithdemo.sh demoexample.jans.io MYSQL +``` + +Console messages like below confirms the successful installation: + +``` +[+] Running 3/3 + ⠿ Network docker-jans-monolith_cloud_bridge Created 0.0s + ⠿ Container docker-jans-monolith-mysql-1 Started 0.6s + ⠿ Container docker-jans-monolith-jans-1 Started 0.9s + +Waiting for the Janssen server to come up. Depending on the resources it may take 3-5 mins for the services to be up. +Testing openid-configuration endpoint.. +``` + +As can be seen, the install script also accesses the well-known endpoints to varify that Janssen Server is responsive. + +## Verify Installation By Accessing Standard Endpoints + + +To access Janssen Server standard endpoints from outside of the Docker container, systems `/etc/hosts` file needs to be updated. Open the file and add the IP domain record which should be the IP of the instance docker is installed. And the domain used in the env above `CN_HOSTNAME`. + +```bash +# For-example +172.22.0.3 demoexample.jans.io +``` + +After adding the record, hit the standard endpoints such as + +``` +https://demoexample.jans.io/.well-known/openid-configuration +``` + +## Configure Janssen Server + +Access the Docker container shell using: + +```bash +docker exec -ti docker-jans-monolith-jans-1 bash +``` + +And then use CLI tools to configure Janssen Server as needed. + +```bash +/opt/jans/jans-cli/config-cli.py +#or +/opt/jans/jans-cli/scim-cli.py +``` + +## Uninstall / Remove the Janssen Server + +This docker based installation uses `docker compose` under the hood to create containers. Hence uninstalling Janssen server involves invoking `docker compose` with appropriate yml file. Run command below to stop and remove containers. + +``` +docker compose -f /tmp/jans/docker-jans-monolith/jans-mysql-compose.yml down && rm -rf jans-* +``` + +Console messages like below confirms the successful removal: + +``` +[+] Running 3/3 + ⠿ Container docker-jans-monolith-jans-1 Removed 10.5s + ⠿ Container docker-jans-monolith-mysql-1 Removed 0.9s + ⠿ Network docker-jans-monolith_cloud_bridge Removed 0.1s +``` diff --git a/mkdocs.yml b/mkdocs.yml index ae349bb2662..467fe91633f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -147,6 +147,9 @@ nav: - 'Suse': 'admin/install/vm-install/suse.md' # - 'FIPS DISA STIG': 'admin/install/vm-install/disa-stig.md' - 'Dynamic Download': 'admin/install/vm-install/dynamic-download.md' + - 'Docker Installation': + - 'Quick Start': 'admin/install/docker-install/quick-start.md' + - 'Docker compose': 'admin/install/docker-install/compose.md' - 'Helm Deployments': - 'admin/install/helm-install/README.md' - 'Local Kubernetes Cluster': 'admin/install/helm-install/local.md' @@ -155,8 +158,7 @@ nav: # - 'Digital Ocean DOK': 'admin/install/helm-install/digitalocean-dok.md' - 'Microsoft Azure AKS': 'admin/install/helm-install/microsoft-azure.md' # - 'Red Hat Open Shift': 'admin/install/helm-install/red-hat-open-shift.md' - - 'Using Rancher Marketplace': 'admin/install/helm-install/rancher.md' - - 'Docker Installation': 'admin/install/docker.md' + - 'Using Rancher Marketplace': 'admin/install/helm-install/rancher.md' - 'Setup Instructions': 'admin/install/setup.md' - 'FAQ': 'admin/install/install-faq.md' - 'Kubernetes Operation Guide': From e85d102cddedfb11aa0eebb8c12e9b63507982e0 Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Mon, 21 Nov 2022 20:57:02 +0200 Subject: [PATCH 3/9] docs: readme.md and compose,md made identical --- docker-jans-monolith/README.md | 66 +++++++++++-------- .../{docker.md => docker-install/compose.md} | 10 ++- 2 files changed, 48 insertions(+), 28 deletions(-) rename docs/admin/install/{docker.md => docker-install/compose.md} (97%) diff --git a/docker-jans-monolith/README.md b/docker-jans-monolith/README.md index baf78d7f7d8..f04e815c066 100644 --- a/docker-jans-monolith/README.md +++ b/docker-jans-monolith/README.md @@ -1,17 +1,27 @@ -# Overview +--- +tags: +- administration +- installation +- quick-start +- docker +--- -**This image is for testing and development purposes only! Use Janssen [helm charts](../charts) for production setups** +!!! Warning + **This image is for testing and development purposes only. Use Janssen [helm charts](../charts) for production setups.** -Docker monolith image packaging for Janssen.This image packs janssen services including, the auth-server, config-api, fido2, and scim. +## Overview -## Versions +Docker monolith image packaging for Janssen. This image packs janssen services including the auth-server, config-api, fido2, and scim. + +## Pre-requisites + +- [Docker](https://docs.docker.com/install) +- [Docker compose](https://docs.docker.com/compose/install/) -See [Releases](https://github.com/JanssenProject/docker-jans-monolith/releases) for stable versions. This image should never be used in production. -For bleeding-edge/unstable version, use `janssenproject/monolith:1.0.4_dev`. ## Environment Variables -The following environment variables are supported by the container: +Installation depends on a set of environment variables. These environment variables can be set to customize installation as per the need. If not set, the installer uses default values. | ENV | Description | Default | |-------------------------|--------------------------------------------------|--------------------------------------------------| @@ -32,35 +42,38 @@ The following environment variables are supported by the container: | `MYSQL_HOST` | MySQL host. | `mysql` which is the docker compose service name | -## Pre-requisites +## How to run -- [Docker](https://docs.docker.com/install). Docker compose should be installed by default with Docker. +Download the compose file -## How to run +```bash + +wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml +``` + +This docker compose file run two containers, the janssen monolith container and mysql container. ```bash docker compose -f jans-mysql-compose.yml up -d ``` -## Clean up +To see the containers running -Remove setup and volumes +```bash -``` -docker compose -f jans-mysql-compose.yml down && rm -rf jans-* +docker ps ``` -## Test +## Configure Janssen Server ```bash -docker exec -ti docker-jans-monolith-jans-1 bash -``` +docker ps #List the containers running. Copy the container name of monolith jans -Run -```bash -/opt/jans/jans-cli/config-cli.py -#or -/opt/jans/jans-cli/scim-cli.py +docker exec -ti bash #This opens a bash terminal in the running container + +/opt/jans/jans-cli/config-cli.py #configure config-cli + +/opt/jans/jans-cli/scim-cli.py #configure scim ``` ## Access endpoints externally @@ -74,11 +87,10 @@ Add to your `/etc/hosts` file the ip domain record which should be the ip of the After adding the record you can hit endpoints such as https://demoexample.jans.io/.well-known/openid-configuration -## Quick start +## Clean up -Grab a fresh ubuntu 22.04 lts VM and run: +Remove setup and volumes -```bash -wget https://raw.githubusercontent.com/JanssenProject/jans/main/automation/startjanssenmonolithdemo.sh && chmod u+x startjanssenmonolithdemo.sh && sudo bash startjanssenmonolithdemo.sh demoexample.jans.io MYSQL ``` - +docker compose -f jans-mysql-compose.yml down && rm -rf jans-* +``` diff --git a/docs/admin/install/docker.md b/docs/admin/install/docker-install/compose.md similarity index 97% rename from docs/admin/install/docker.md rename to docs/admin/install/docker-install/compose.md index 54d5e59258c..f04e815c066 100644 --- a/docs/admin/install/docker.md +++ b/docs/admin/install/docker-install/compose.md @@ -1,3 +1,11 @@ +--- +tags: +- administration +- installation +- quick-start +- docker +--- + !!! Warning **This image is for testing and development purposes only. Use Janssen [helm charts](../charts) for production setups.** @@ -56,7 +64,7 @@ To see the containers running docker ps ``` -## Configure +## Configure Janssen Server ```bash docker ps #List the containers running. Copy the container name of monolith jans From 00f20c147d8601403bf97652105939fcdc6def04 Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Mon, 21 Nov 2022 21:08:00 +0200 Subject: [PATCH 4/9] docs: adjust warning as per github pages syntex --- docker-jans-monolith/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docker-jans-monolith/README.md b/docker-jans-monolith/README.md index f04e815c066..e15243840bf 100644 --- a/docker-jans-monolith/README.md +++ b/docker-jans-monolith/README.md @@ -6,8 +6,8 @@ tags: - docker --- -!!! Warning - **This image is for testing and development purposes only. Use Janssen [helm charts](../charts) for production setups.** +> **Warning** +> This image is for testing and development purposes only. Use Janssen [helm charts](../charts) for production setups. ## Overview From c3ca69ccf38fb4a1fe618a48b481475d540bd78a Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Tue, 22 Nov 2022 16:29:29 +0200 Subject: [PATCH 5/9] docs: replace docker with docker compose --- docker-jans-monolith/README.md | 2 +- docs/admin/install/docker-install/compose.md | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docker-jans-monolith/README.md b/docker-jans-monolith/README.md index e15243840bf..7d91e229a1b 100644 --- a/docker-jans-monolith/README.md +++ b/docker-jans-monolith/README.md @@ -3,7 +3,7 @@ tags: - administration - installation - quick-start -- docker +- docker compose --- > **Warning** diff --git a/docs/admin/install/docker-install/compose.md b/docs/admin/install/docker-install/compose.md index f04e815c066..b963f538546 100644 --- a/docs/admin/install/docker-install/compose.md +++ b/docs/admin/install/docker-install/compose.md @@ -3,7 +3,7 @@ tags: - administration - installation - quick-start -- docker +- docker compose --- !!! Warning @@ -61,15 +61,14 @@ To see the containers running ```bash -docker ps +docker compose -f jans-mysql-compose.yml ps ``` ## Configure Janssen Server ```bash -docker ps #List the containers running. Copy the container name of monolith jans -docker exec -ti bash #This opens a bash terminal in the running container +docker compose -f jans-mysql-compose.yml exec jans sh #This opens a bash terminal in the running container /opt/jans/jans-cli/config-cli.py #configure config-cli From d8c43409088024f16c359221a5b058b71bc278f5 Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Tue, 22 Nov 2022 19:29:11 +0200 Subject: [PATCH 6/9] docs: github page identical to compose page --- docker-jans-monolith/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docker-jans-monolith/README.md b/docker-jans-monolith/README.md index 7d91e229a1b..c841d5df891 100644 --- a/docker-jans-monolith/README.md +++ b/docker-jans-monolith/README.md @@ -61,15 +61,14 @@ To see the containers running ```bash -docker ps +docker compose -f jans-mysql-compose.yml ps ``` ## Configure Janssen Server ```bash -docker ps #List the containers running. Copy the container name of monolith jans -docker exec -ti bash #This opens a bash terminal in the running container +docker compose -f jans-mysql-compose.yml exec jans sh #This opens a bash terminal in the running container /opt/jans/jans-cli/config-cli.py #configure config-cli From 896641e4f89cfdcbbac09a8a5d567b4eafbcd479 Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Tue, 22 Nov 2022 21:24:42 +0200 Subject: [PATCH 7/9] docs: remove yml file deletion --- docker-jans-monolith/README.md | 2 +- docs/admin/install/docker-install/compose.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docker-jans-monolith/README.md b/docker-jans-monolith/README.md index c841d5df891..f99cb133f9d 100644 --- a/docker-jans-monolith/README.md +++ b/docker-jans-monolith/README.md @@ -91,5 +91,5 @@ After adding the record you can hit endpoints such as https://demoexample.jans.i Remove setup and volumes ``` -docker compose -f jans-mysql-compose.yml down && rm -rf jans-* +docker compose -f jans-mysql-compose.yml down ``` diff --git a/docs/admin/install/docker-install/compose.md b/docs/admin/install/docker-install/compose.md index b963f538546..fc2e4fd3d3b 100644 --- a/docs/admin/install/docker-install/compose.md +++ b/docs/admin/install/docker-install/compose.md @@ -91,5 +91,5 @@ After adding the record you can hit endpoints such as https://demoexample.jans.i Remove setup and volumes ``` -docker compose -f jans-mysql-compose.yml down && rm -rf jans-* +docker compose -f jans-mysql-compose.yml down ``` From 07608d1042681d43d5d983f127b6eb47d844803e Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Wed, 23 Nov 2022 19:38:40 +0200 Subject: [PATCH 8/9] docs: fix --- docker-jans-monolith/README.md | 12 ++++++------ docs/admin/install/docker-install/compose.md | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docker-jans-monolith/README.md b/docker-jans-monolith/README.md index f99cb133f9d..33205c2f127 100644 --- a/docker-jans-monolith/README.md +++ b/docker-jans-monolith/README.md @@ -7,7 +7,7 @@ tags: --- > **Warning** -> This image is for testing and development purposes only. Use Janssen [helm charts](../charts) for production setups. +> This image is for testing and development purposes only. Use Janssen [helm charts](https://github.com/JanssenProject/jans/tree/main/charts/janssen) for production setups. ## Overview @@ -21,7 +21,7 @@ Docker monolith image packaging for Janssen. This image packs janssen services i ## Environment Variables -Installation depends on a set of environment variables. These environment variables can be set to customize installation as per the need. If not set, the installer uses default values. +Installation depends on the set of environment variables shown below. These environment variables can be set to customize installation as per the need. If not set, the installer uses default values. | ENV | Description | Default | |-------------------------|--------------------------------------------------|--------------------------------------------------| @@ -51,13 +51,13 @@ Download the compose file wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml ``` -This docker compose file run two containers, the janssen monolith container and mysql container. +This docker compose file runs two containers, the janssen monolith container and mysql container. ```bash docker compose -f jans-mysql-compose.yml up -d ``` -To see the containers running +To view the containers running ```bash @@ -70,9 +70,9 @@ docker compose -f jans-mysql-compose.yml ps docker compose -f jans-mysql-compose.yml exec jans sh #This opens a bash terminal in the running container -/opt/jans/jans-cli/config-cli.py #configure config-cli +/opt/jans/jans-cli/config-cli.py #configure using the config-cli -/opt/jans/jans-cli/scim-cli.py #configure scim +/opt/jans/jans-cli/scim-cli.py #configure using the scim-cli ``` ## Access endpoints externally diff --git a/docs/admin/install/docker-install/compose.md b/docs/admin/install/docker-install/compose.md index fc2e4fd3d3b..758cdfbc04b 100644 --- a/docs/admin/install/docker-install/compose.md +++ b/docs/admin/install/docker-install/compose.md @@ -21,7 +21,7 @@ Docker monolith image packaging for Janssen. This image packs janssen services i ## Environment Variables -Installation depends on a set of environment variables. These environment variables can be set to customize installation as per the need. If not set, the installer uses default values. +Installation depends on the set of environment variables shown below. These environment variables can be set to customize installation as per the need. If not set, the installer uses default values. | ENV | Description | Default | |-------------------------|--------------------------------------------------|--------------------------------------------------| @@ -51,13 +51,13 @@ Download the compose file wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml ``` -This docker compose file run two containers, the janssen monolith container and mysql container. +This docker compose file runs two containers, the janssen monolith container and mysql container. ```bash docker compose -f jans-mysql-compose.yml up -d ``` -To see the containers running +To view the containers running ```bash @@ -70,9 +70,9 @@ docker compose -f jans-mysql-compose.yml ps docker compose -f jans-mysql-compose.yml exec jans sh #This opens a bash terminal in the running container -/opt/jans/jans-cli/config-cli.py #configure config-cli +/opt/jans/jans-cli/config-cli.py #configure using the config-cli -/opt/jans/jans-cli/scim-cli.py #configure scim +/opt/jans/jans-cli/scim-cli.py #configure using the scim-cli ``` ## Access endpoints externally From a99b839f9bf3f97873f149bc86fd806141bb867e Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Wed, 23 Nov 2022 19:55:03 +0200 Subject: [PATCH 9/9] docs: fix helm chart url --- docs/admin/install/docker-install/compose.md | 2 +- docs/admin/install/docker-install/quick-start.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/admin/install/docker-install/compose.md b/docs/admin/install/docker-install/compose.md index 758cdfbc04b..5e421beec66 100644 --- a/docs/admin/install/docker-install/compose.md +++ b/docs/admin/install/docker-install/compose.md @@ -7,7 +7,7 @@ tags: --- !!! Warning - **This image is for testing and development purposes only. Use Janssen [helm charts](../charts) for production setups.** + **This image is for testing and development purposes only. Use Janssen [helm charts](https://github.com/JanssenProject/jans/tree/main/charts/janssen) for production setups.** ## Overview diff --git a/docs/admin/install/docker-install/quick-start.md b/docs/admin/install/docker-install/quick-start.md index 37cab8612cf..3da84807414 100644 --- a/docs/admin/install/docker-install/quick-start.md +++ b/docs/admin/install/docker-install/quick-start.md @@ -7,7 +7,7 @@ tags: --- !!! Warning - **This image is for testing and development purposes only. Use Janssen [helm charts](../charts) for production setups.** + **This image is for testing and development purposes only. Use Janssen [helm charts](https://github.com/JanssenProject/jans/tree/main/charts/janssen) for production setups.** ## Overview