Make it easier to use other replication services within the storage service - SIDP-242
[java-idp.git] / doc / README.txt
1 Welcome to Internet2's Shibboleth
2
3 Shibboleth is a federated web authentication and attribute exchange system
4 based on SAML developed by Internet2 and MACE.
5
6 Shibboleth is licensed under the Apache 2.0 license which is provided in the
7 LICENSE.txt file.
8
9 Shibboleth Project Site:
10 http://shibboleth.internet2.edu/
11
12 Shibboleth Documentation Site:
13 https://spaces.internet2.edu/display/SHIB2/Home
14
15 Source and binary distributions
16 http://shibboleth.internet2.edu/downloads
17
18 Bug Tracker:
19 https://bugs.internet2.edu/jira
20
21 Upgrading 
22 ====================
23
24 from 2.0.0 to 2.1.0
25 -------------------
26 The following configuration changes must be made to upgrade from 2.0.0 to 2.1.0
27 - in internal.xml replace 'org.opensaml.util.storage.MapBasedStorageService' with 
28   'edu.internet2.middleware.shibboleth.common.util.EventingMapBasedStorageService'
29   as the value for the class attribute of bean 'shibboleth.StorageService' (line 82 in the
30   default configuration file)
31   
32 - in service.xml add the service 'shibboleth.StorageService' to the whitespace delimited 
33   list of services already present in the service, shibboleth.ServiceServletContextAttributeExporter
34   (service definition starts at line 57 in the default configuration file)
35
36 - in internal.xml, replace the string 'org.apache.velocity.runtime.resource.loader.StringResourceLoader' 
37   with 'edu.internet2.middleware.shibboleth.common.util.StringResourceLoader' (this is located at line 
38   41 in the default configuration file)