Commit 692bf062 authored by haemmer's avatar haemmer

Improved documentation

parent 9bb8efc4
......@@ -24,32 +24,37 @@ necessary for such releases.
SWITCHwayf Changes and Version History:
1.18 - Removed as many SWITCH-specific graphics and texts as possible.
1.18 - Changed default SessionInitiator of the Embedded WAYF to
/Login because this has been the default SessionInitiator in
Shibboleth for quite some time now.
- Corrected viewport meta tag separator of default header as suggested
by Andrew Sokolov from Saint Petersburg State University
- Removed as many SWITCH-specific graphics and texts as possible.
- Introduced configuration options to allow easier customization.
- Fixed a few small bugs
- Added some optimizations to the drop-down list search-as-you type
feature
Complete list: https://forge.switch.ch/redmine/projects/wayf/versions/62
- Some small styling changes/CSS improvements
Issues: https://forge.switch.ch/redmine/projects/wayf/versions/62
Please read the specific update instructions in the README file, as some
new configuration options were introduced that should be revised.
1.17.2
- Changed default SessionInitiator to /Login because this has been
the default SessionInitiator in Shibboleth for quite some time now.
- Corrected viewport meta tag separator of default header as suggested
by Andrew Sokolov from Saint Petersburg State University
1.17.1 Release date: 14. June 2012
- Fixed a bug occuring when wayf_sp_samlDSURL contains GET arguments
Bug reported with a patch by Takeshi Nishimura from NII (Japan)
- Fixed typo in configuration otpion useImprovedDropDownList
- Added Javascripts required for improved drop down list
Issues: https://forge.switch.ch/redmine/projects/wayf/versions/55
1.17 Release date: 18. May 2012
- Added CSS styles for mobile view
- Embedded WAYF now reads 'entityID' and 'return' GET arguments.
They get precedence over the values configured for the Embedded WAYF.
- Embedded WAYF logged in message now contains a link to target URL
Issues: https://forge.switch.ch/redmine/projects/wayf/versions/45
1.16 Release date: 19. January 2012
- Added an improved version of the drop down list to the WAYF
......@@ -67,6 +72,8 @@ SWITCHwayf Changes and Version History:
- Added Keywords property to format of IDP entries to allow users to
search Identity Providers using a keyword.
Issues: https://forge.switch.ch/redmine/projects/wayf/versions/40
1.15 Release date: 21. October 2011
- A default and custom CSS file can now be used
- Graphical design now is based new SWITCH harmos elements
......@@ -87,11 +94,15 @@ SWITCHwayf Changes and Version History:
specification when it comes to the return parameter. This parameter
is optional in case the DS knows the SP Discovery URL.
Reported by Tom Scavo.
Issues: https://forge.switch.ch/redmine/projects/wayf/versions/26
1.14.3 Release date: 4. March 2011
- Fixed a race condition. Thanks go to Robert Basch from MIT for
reporting the issue and providing a patch.
Issues: https://forge.switch.ch/redmine/projects/wayf/versions/32
1.14.2 Release date: 15. December 2010
- IDProvider.conf.php and config.php are not overwritten anymore by upgrades
- Logging to syslog now works properly and is more consistent
......@@ -102,6 +113,8 @@ SWITCHwayf Changes and Version History:
submitting a patch.
- Improved installation instructions
Issues: https://forge.switch.ch/redmine/projects/wayf/versions/25
1.14.1 Release date: 12. November 2010
- Fixed an encoding bug that affected non-ASCII characters in
JavaScripts. Thanks to Prof. Kazutsuna Yamaji for reporting this issue.
......@@ -114,6 +127,9 @@ SWITCHwayf Changes and Version History:
to false due to some concerns regarding phishing attacks
- Added proper copyright statements to all source code files
Issues: https://forge.switch.ch/redmine/projects/wayf/versions/21
1.14 Release date: 9. November 2010
- Added the configuration option wayf_force_remember_for_session to
the Embedded WAYF on request of Wolgang Lierz. This
......@@ -137,6 +153,9 @@ SWITCHwayf Changes and Version History:
submitting patches.
- Fixed a bug where hidden IdPs would still be shown in Embedded WAYF
Issues: https://forge.switch.ch/redmine/projects/wayf/versions/17
The revision history of older versions, can be found on the SWITCHwayf web page:
https://forge.switch.ch/redmine/projects/wayf/wiki/Changes
......
......@@ -37,8 +37,8 @@ Installation:
- Copy the file config.dist.php and name it config.php
This is the main configuration file of the SWITCHwayf
- Copy the file IDProvider.conf.dist.php and name it IDProvider.conf.php
This file contains the list of Identity Providers that you configure
by hand
This file contains the list of Identity Providers that that can be
configured by hand
3. Make sure that permissions for the files:
- SProvider.metadata.php
......@@ -122,9 +122,18 @@ General Update Instructions:
current SWITCHwayf installation over to the new directory.
4. Have a look at config.dist.php and compare this file with your current
config.php in order to identify new configuration options.
Also compare your custom-.* files to the default-.* files that might have
## Since version 1.18 the script 'update-config.php' can be used to
## merge an existing configuration (from config.php) with the default
## configuration (config.dist.php) into a new configuration file
## (config.new.php). This allows easily getting a clean configuration file
## while keeping the current settings. Run the script with:
## php update-config.php
## Ensure that the user has the necessary write privileges to create
Also compare the custom-.* files to the default-.* files that might have
changed. Some features like the improved drop-down list require the WAYF
to load additional javascripts. If your custom header file is missing these,
to load additional javascripts. If a custom header file is missing these,
the feature will not work.
-------------------------------------------------------------------------------
......@@ -141,7 +150,7 @@ Updates from versions before 1.18
- $helpURL
- $privacyURL
Have a look at config.dist.php in section "4. Appearance Settings" for a
Have a look at config.dist.php in section "5. Appearance Settings" for a
description on these settings. Then make sure to add them to config.php
with your own values (or empty strings to ignore them). Otherwise, default
values will be set.
......
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