The script comes with a set of install/uninstall command.
You can uninstall
ShARPE from your existing
IdP and restore the
IdP to the state prior to installation of
ShARPE. A full descriptions of various uninstallation commands are:
- ant clean-all
- removes all compiled class in SHIB_SRC as well as ShARPE in SHIB_SRC
- ant clean
- removes only compiled class in SHIB_SRC
- ant clean-install
- removes ALL IDP_HOME and IDP_WEBAPP + SHARPE_WEBAPP + AUTOGRAPH_WEBAPP
- ant uninstall
- removes traces of ShARPE from IDP_HOME + SHARPE_WEBAPP + AUTOGRAPH_WEBAPP. This also ask user if backups are necessary and re-installation of IdP without ShARPE included
To remove
ShARPE, it is recommended to execute:
- ant uninstall
- ant clean-all
One of the uninstallation option is to re-install the
IdP, which simply means:
- if re-installation of IdP is required, then the IDP_WEBAPP will be redeployed without any of ShARPE files
- if re-installation of IdP is not required, then the IDP_WEBAPP is left alone and you need to modify web.xml located at IDP_WEBAPP/WEB-INF folder as specified below.
Re-installation of IDP_WEBAPP doesn't pose any harm to your
IdP, unless you manually had modified IDP_WEBAPP. It is therefore recommended to re-install
IdP during
ShARPE uninstallation step.
Post Uninstall
Lifecycle of
IdP +
ShARPE:
- IdP installed, no ShARPE installed
- ShARPE is installed
- make backup of configuration (idp.xml, resolver*.xml, arps) to SHIB_HOME/etc/sharpe-backup
- It is decided ShARPE to be uninstalled
- make backup of configuration (idp.xml, resolver*.xml, arps, crosswalks, spdescriptions) to SHIB_HOME/etc/sharpe-backup2
- wipe off the configuration files from SHIB_HOME/etc
- restore the backup files done in step 2.a into their original location
To Restore IdP to state prior ShARPE
- No need to do anything. (Un)Installation script will revert IdP back to its original state
- Note that any manual modification performed on idp.xml that is NOT part of ShARPE (i.e. some configuration irrelevant to ShARPE) after installation of ShARPE will not be restored. You need to re-apply such modifications after uninstallation step finishes. You can refer to your modified configuration files in SHIB_HOME/etc/sharpe-backup2
- if you choose not to re-install IdP during ShARPE uninstallation process, then you need to make sure IDP_WEBAPP/WEB-INF/web.xml has correct content (i.e. change edu.internet2.middleware.shibboleth.idp.MAMSIdPResponder back to edu.internet2.middleware.shibboleth.idp.IdPResponder).
To check original configuration files
ShARPE modifies the following files: resolver.ldap.xml,
ARPs, mappings. In order to revert it to original state, you need to either uninstall
ShARPE or perform manual restore. Backups are stored in $SHIB_HOME/etc/sharpe-backup
--
BrucLiong - 30 May 2006
to top