From ab6b4cd38f2833f92ed3eec9f32c75ce85f834ee Mon Sep 17 00:00:00 2001
From: peterbolha <xbolha@fi.muni.cz>
Date: Mon, 11 Dec 2023 11:25:19 +0100
Subject: [PATCH] docs: add doc for --basic-oidc-check

---
 README.md | 35 ++++++++++++++++++++++++-----------
 1 file changed, 24 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index d6b36f0..d219faf 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,8 @@ pip install perun.proxy.utils
 There are several extras which are required only for some scripts:
 
 - `[ldap]` for check_ldap and check_ldap_syncrepl
-  - this also requires installing [build prerequisites of the python-ldap library](https://www.python-ldap.org/en/latest/installing.html#build-prerequisites)
+  - this also requires
+    installing [build prerequisites of the python-ldap library](https://www.python-ldap.org/en/latest/installing.html#build-prerequisites)
 - `[postgresql]` for check_pgsql
 
 ## Scripts
@@ -50,24 +51,31 @@ run_probes
 - This script checks whether there are some metadata close to expiration date
 
 - Params:
-  - 1 - url to a page which prints a time when expires the metadata closest to expiration
+  - 1 - url to a page which prints a time when expires the metadata closest to
+    expiration
 
 ### print_docker_versions.py
 
-- This script collects system info, docker engine info and the versions of running containers and then prints it to the stdout in the JSON format
-- A python [docker library](https://pypi.org/project/docker/) is needed to run the script
+- This script collects system info, docker engine info and the versions of running
+  containers and then prints it to the stdout in the JSON format
+- A python [docker library](https://pypi.org/project/docker/) is needed to run the
+  script
 
 - Options:
-  - -e,--exclude NAMES - space delimited string of container names to exclude from the listing
+  - -e,--exclude NAMES - space delimited string of container names to exclude from the
+    listing
 
 ### run_version_script.py
 
-- This scripts runs the print_docker_version.py script on the given machines. The collected versions are then printed as a MD table to the stdout
+- This scripts runs the print_docker_version.py script on the given machines. The
+  collected versions are then printed as a MD table to the stdout
 
 - Options:
-  - -e,--exclude NAMES - space delimited string of container names to exclude from the listing
+  - -e,--exclude NAMES - space delimited string of container names to exclude from the
+    listing
 - Params:
-  - 1... - machines to run the script on in the form of user@adress, the user needs root privileges to execute the script
+  - 1... - machines to run the script on in the form of user@adress, the user needs
+    root privileges to execute the script
 
 ## Nagios probes
 
@@ -84,7 +92,8 @@ Tested options:
 - replication_lag
 - replset_state
 
-(some possible options may not work since there are constructs which are not supported by the latest mongodb versions)
+(some possible options may not work since there are constructs which are not supported
+by the latest mongodb versions)
 
 For usage instructions, run:
 
@@ -96,7 +105,10 @@ check_mongodb --help
 
 SAML authentication check compatible with SimpleSAMLphp and mitreID.
 
-For usage instructions, run:
+Basic OIDC check can be triggered by adding `--basic-oidc-check` switch. This checks
+for `state` and `code` parameters in the result url after a log in attempt.
+
+For more usage instructions, run:
 
 ```sh
 check_saml --help
@@ -115,7 +127,8 @@ python3 check_saml.py
 
 ### check_user_logins.py
 
-Check users which login in repeatedly more often than a specified threshold (logins per seconds).
+Check users which login in repeatedly more often than a specified threshold (logins per
+seconds).
 
 For usage instructions, run:
 
-- 
GitLab