diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 589eb53b0..8b482e910 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -219,18 +219,15 @@ These scripts, along with the provided configuration files, serve as guidelines > - To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. - Modify the following default certificate parameters as needed. - - ``` - export OSSL_COUNTRY_NAME="XC" - export OSSL_STATE_NAME="Test State" - export OSSL_LOCALITY_NAME="TEST" - export OSSL_ORGANIZATION_NAME="WHO" - export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" - export OSSL_COMMON_NAME="NationXC_TNP - ``` - - +``` +export OSSL_COUNTRY_NAME="XC" +export OSSL_STATE_NAME="Test State" +export OSSL_LOCALITY_NAME="TEST" +export OSSL_ORGANIZATION_NAME="WHO" +export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" +export OSSL_COMMON_NAME="NationXC_TNP +``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. @@ -242,42 +239,39 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat 2.Set the required environment variables. - - ``` - $env:OSSL_COUNTRY_NAME="XC" - $env:OSSL_STATE_NAME="Test State" - $env:OSSL_LOCALITY_NAME="TEST" - $env:OSSL_ORGANIZATION_NAME="WHO" - $env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" - $env:OSSL_COMMON_NAME="NationXC_TNP" - ``` - +``` +$env:OSSL_COUNTRY_NAME="XC" +$env:OSSL_STATE_NAME="Test State" +$env:OSSL_LOCALITY_NAME="TEST" +$env:OSSL_ORGANIZATION_NAME="WHO" +$env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" +$env:OSSL_COMMON_NAME="NationXC_TNP" +``` + > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. Please note that you need to have [OpenSSL installed](https://slproweb.com/products/Win32OpenSSL.html) (e.g. Win64 OpenSSL v3.3.0 Light) and added to your PATH environment variable. Also you may need allow the execution by setting an execution policy. - ``` - Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process - ``` +``` +Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process +``` **How to Run Script :** - Once you execute the script. It will generate all certificates and keys in a subfolder named by current datetime. - **Notes**: While execution of "gen_all_certs.sh" script on **Unix/Linux Operating System,** Please provide script argument "DN_template.cnf" file which consists of country related information to generate all required certificates (TLS,SCA,UP) - - - ``` - **For Mac/Linux/Unix** - cd scripts/certgen - ./gen_all_certs.sh DN_template.cnf - zsh ./gen_all_certs.sh DN_template.cnf ## If you are using Ubuntu OS +``` +**For Mac/Linux/Unix** +cd scripts/certgen +./gen_all_certs.sh DN_template.cnf ## Provide DN_template.cnf file as a script argument. +zsh ./gen_all_certs.sh DN_template.cnf ## Use this if you are using Zsh on your Ubuntu system. - **For Windows:** - cd scripts/certgen - ./gen_all_certs.ps1 - ``` +**For Windows:** +cd scripts/certgen +./gen_all_certs.ps1 +``` This setup generates all required certificates (TLS, SCA, UP) and keys in a timestamped subfolder, based on the configuration specified in DN_template.cnf for Unix/Linux and the environment variables set in the current PowerShell session for Windows.