Commit 07a0dd4f authored by Guillaume Rousse's avatar Guillaume Rousse

more accurate documentation

The script doesn't read configuration at all, usage with same user as web
server is not mandatory, and there is no point at having two different
usage examples, especially if contradictory.
parent 6989f9a7
...@@ -2,17 +2,19 @@ ...@@ -2,17 +2,19 @@
$MAN=<<<PAGE $MAN=<<<PAGE
Name: SWITCHwayf Name: SWITCHwayf
Author: Lukas Haemmerle, SWITCH Author: Lukas Haemmerle, SWITCH
Description: This file is used to dynamically create the list of Description: This script is used to dynamically create the list of
IdPs and SP to be displayed for the WAYF/DS service IdPs and SP to be displayed for the WAYF/DS service
based on the federation metadata. based on the federation metadata.
Configuration parameters are specified in config.php. It is intended to be run periodically, e.g. with a cron
The list of Identity Providers can also be updated
by running the script update-metadata.php
periodically as web server user, e.g. with a cron
entry like: entry like:
5 * * * * /usr/bin/php update-metadata.php > /dev/null 5 * * * * /usr/bin/php update-metadata.php \
--metadata-file /var/cache/shibboleth/metadata.switchaai.xml \
--metadata-idp-file /tmp/IDProvider.metadata.php \
--metadata-sp-file /tmp/SProvider.metadata.php \
> /dev/null
Usage: Usage
-----
php update-metadata.php -help|-h php update-metadata.php -help|-h
php update-metadata.php --metadata-file <file> \ php update-metadata.php --metadata-file <file> \
--metadata-idp-file <file> --metadata-sp-file <file> \ --metadata-idp-file <file> --metadata-sp-file <file> \
...@@ -21,16 +23,8 @@ php update-metadata.php --metadata-url <url> \ ...@@ -21,16 +23,8 @@ php update-metadata.php --metadata-url <url> \
--metadata-idp-file <file> --metadata-sp-file <file> \ --metadata-idp-file <file> --metadata-sp-file <file> \
[--verbose | -v] [--min-sp-count <count>] [--min-idp-count <count>] [--verbose | -v] [--min-sp-count <count>] [--min-idp-count <count>]
Argument Description
Example usage: --------------------
php update-metadata.php \
--metadata-file /var/cache/shibboleth/metadata.switchaai.xml \
--metadata-idp-file /tmp/IDProvider.metadata.php \
--metadata-sp-file /tmp/SProvider.metadata.php
Argument Description
-------------------
--metadata-url <url> SAML2 metadata URL --metadata-url <url> SAML2 metadata URL
--metadata-file <file> SAML2 metadata file --metadata-file <file> SAML2 metadata file
--metadata-idp-file <file> File containing Service Providers --metadata-idp-file <file> File containing Service Providers
...@@ -39,7 +33,7 @@ Argument Description ...@@ -39,7 +33,7 @@ Argument Description
--min-sp-count <count> Minimum expected number of SPs in metadata --min-sp-count <count> Minimum expected number of SPs in metadata
--language <locale> Language locale, e.g. 'en', 'jp', ... --language <locale> Language locale, e.g. 'en', 'jp', ...
--verbose | -v Verbose mode --verbose | -v Verbose mode
--help | -h Print this man page --help | -h Print this man page
PAGE; PAGE;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment