This topic lists out the steps required to configure and run the password recovery sample web application with the WSO2 Identity Server.
Prerequisites
- WSO2 Identity Server 5.1.0 or a later version installed - This can be downloaded from the WSO2 Identity Server product page and installed by following the instructions in the Installing the Product topic.
- Apache Tomcat 6 - To deploy the sample web application.
- InfoRecoverySample - This can be checked out from here. Follow these instructions to check out the folder.
Configuring the sample
- Do the following configuration changes to the
<SAMPLE_HOME>/src/main/webapp/WEB-INF/web.xml
file.Specify the
carbonServerUrl
as the URL of the Identity Server. The following is an example.<context-param> <param-name>carbonServerUrl</param-name> <param-value>https://localhost:9443/</param-value> </context-param>
Specify the credentials to access Identity Server with admin privileges for
accessUsername
andaccessPassword
. The following is an example with the default WSO2 Identity Server credentials used.<context-param> <param-name>accessUsername</param-name> <param-value>admin</param-value> </context-param> <context-param> <param-name>accessPassword</param-name> <param-value>admin</param-value> </context-param>
Specify the trustStore absolute resource path for
trustStorePath
. The following example specifies the path to wso2carbon.jks of the Identity Server.<context-param> <param-name>trustStorePath</param-name> <param-value>[IS_HOME]/repository/resources/security/wso2carbon.jks</param-value> </context-param>
If you are deploying the sample in Apache Tomcat, enable the SSL configuration in the
<TOMCAT_HOME>/conf/server.xml
file.<Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" keystoreFile="[IS_HOME]/repository/resources/security/wso2carbon.jks" keystorePass="wso2carbon" />
* [IS_HOME] should be replaced with the correct installation directory for identity server.
Configure the email confirmation links in the the
<IS_HOME>/repository/conf/email/email-admin-config.xml
file and the attributes in the<IS_HOME>/repository/conf/security/identity-mgt.properties
file. The configurations you make in these files depend on what you want to achieve. The following configurations provide information on what needs to be configured based on your scenario.Recovering accounts using notification or secret question - Refer to the topic on password recovery with notification for a sample email template and the attributes needed in the
identity-mgt.properties
file.Self sign-up and account confirmation - Refer to the topic on Self Sign Up and Account Confirmation for a sample email template and the attributes needed in the
identity-mgt.properties
file.- Creating Users using the Ask Password Option - Refer to the topic on Creating Users using the Ask Password Option for a sample email template and the attributes needed in the
identity-mgt.properties
file.
To run the sample app you can build the sample using Apache Maven.
Building the sample using Apache Maven
Before building the sample, ensure that you have followed the instructions in the configuration steps above.
Build the sample using Apache Maven by navigating to the sample's location in the command line and running the following command.
mvn clean install
When building the sample, the Java source code of the project is compiled into class files and packaged into .jar files. The dependencies listed in the project are located in bins so that Tomcat can find and load them. Once the build process is complete, a
targets
folder is created that has the .war file.- Copy the .war file that is generated to the
<TOMCAT_HOME>/webapps
folder. - Start Apache Tomcat.