Commit 9dfae529 authored by haemmer's avatar haemmer

Text improvements

parent ee6a2425
......@@ -10,8 +10,8 @@ Bug reports/feature requests: https://forge.switch.ch/redmine/projects/wayf/issu
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
This file contains important information relevant to this release and general
information.
This file contains important information for this release of SWITCHwayf,
including the installation and update instructions.
-------------------------------------------------------------------------------
Requirements:
......@@ -25,6 +25,10 @@ Requirements:
* $WAYFLogFile (default '/var/log/apache2/wayf.log')
-------------------------------------------------------------------------------
Download:
The latest release can be downloaded from:
https://forge.switch.ch/redmine/projects/wayf/files
Installation:
1. Unpack the SWITCHwayf_binary ${VERSION}_${DATE}.zip ZIP archive into a
directory on a host where Apache or IIS is installed.
......@@ -93,6 +97,13 @@ a2enmod headers
will automatically be able to detect whether it receives a Shibboleth
authentication request or a Discovery Service request.
Subversion access:
Check out the latest SWITHCHwayf code with:
svn co https://subversion.switch.ch/svn/general/aai/SWITCHwayf/
Although the code in the Subversion should be always executable, it should be considered unstable and not be used for production environments without prior testing.
-------------------------------------------------------------------------------
General Update Instructions:
......@@ -102,8 +113,8 @@ General Update Instructions:
parent directory where the current version is deployed.
3. Unzip the archive in the current deployment directory #DD#,
e.g. with the command 'unzip -d #DD# SWITCHwayf_x.y_YYYYMMDD.zip '
This step will overwrite some existing files. Files whose name starts
with 'custom-' will not be overwritten.
This step will overwrite all files except those whose names start
with 'custom-'.
Alternatively, create a new directory, move the ZIP archive in that directory,
unzip it and then copy the config.php and all custom-.* files from the
current SWITCHwayf installation over to the new directory.
......@@ -122,7 +133,8 @@ Updates from versions before 1.17.2
A new configuration option $supportContactEmail was introduced to provide
the user a support contact address in case of errors. Please add a line
like the following to the SWITCHwayf configuration file config.php:
$supportContactEmail = 'your-support-contact@your.organisation.org'
$supportContactEmail = 'your-support-contact@your.organisation.org';
If not set, the default address support-contact@example.org will be used.
Updates from versions before 1.15
......@@ -149,6 +161,7 @@ Update from versions before 1.8:
-------------------------------------------------------------------------------
Security Notes:
The Discovery Service protocol as defined in
http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-idp-discovery.pdf
states that the protocol creates opportunities for phishing attacks as do all
......@@ -176,7 +189,7 @@ elements for many Service Providers.
Troubleshooting:
Generally, if there is an error or an exception, the WAYF will log it to syslog.
In case there is a problem and you see only a white page without any output,
In case there is a problem and only a white page without any output is displayed,
open config.php in a text editor, go to the bottom of the file and set:
$developmentMode = true;
......@@ -187,5 +200,5 @@ This should output PHP warning messages which are otherwise supressed.
Documentation:
Consult the DOC file in the same directly like this file for further information
Consult the DOC file in the same directly as this file for further information
on configuring and customizing the SWITCHwayf.
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