diff --git a/README.md b/README.md index 721cd0ae7f736ca01e6adf478528c0dcca960802..6944ba781af0a4f559c8c812febfea9ff6713863 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ The tool uses following status for IdPs: * Apache Server + WSGI * Python 3 (tested with v3.9.1, v3.10.4) -* Selenim + Google Chrome Web Brower (tested with v91.0.4472.164, v100.0.4896.127) +* Selenium + Google Chrome Web Brower (tested with v91.0.4472.164, v100.0.4896.127) * Chromedriver (tested with v91.0.4472.101, v100.0.4896.60) * Git * PHP @@ -260,7 +260,7 @@ After the initial download, it is recommended that you occasionally go through t * `source $HOME/.bash_profile` -3. Configure ECCS cron job for the local user: +3. Configure the cron job that runs the ECCS script: * `crontab -e` ```bash @@ -269,6 +269,12 @@ After the initial download, it is recommended that you occasionally go through t 0 4 * * * /bin/bash $HOME/eccs/cleanAndRunEccs.sh > $HOME/eccs/logs/eccs-cron.log 2>&1 ``` + The script takes about 2 hours to check 4666 IDPs, so its execution is suggested in the early morning,before the users start using the tool. + The `eccs-cron.log` file will contains: + * The execution time of the entire ECCS script + * Each failed IdP checked again and its result + * The result of the entire ECCS script executed + ### Execute * `cd $HOME/eccs` @@ -325,7 +331,7 @@ After the initial download, it is recommended that you occasionally go through t * `sudo chgrp apache $HOME ; sudo apache g+rx $HOME` (Apache needs permission to access the $HOME dir) * `sudo systemctl restart httpd.service` -3. Restart API WSGI server each day to update the datetime: +3. Restart API WSGI server each day before the ECCS script: * `crontab -e` ```bash @@ -334,6 +340,8 @@ After the initial download, it is recommended that you occasionally go through t 0 3 * * * /usr/bin/touch $HOME/eccs/eccs.ini ``` + This cron job must be executed prior to the ECCS script because it updates the date to the current day. + ### Utility To perform a restart after an API change use the following command: @@ -399,6 +407,10 @@ To clean the ECCS results from files older than last 7 days use (modify it on yo 0 10 * * * /bin/bash $HOME/eccs/clean7daysOldFiles.sh > $HOME/eccs/logs/clean7daysOldFiles.log 2>&1 ``` + This cron job is useful to reduce the considered days selectable on the ECCS Web GUI. + + It is suggested to configure it after the execution of ECCS script to get the hoped result + ## Utility for developers ### ECCS API Development Server