Skip to main content

Quickstart

Overview​

The WSO2 DPDP Accelerator helps you build solutions for India's Digital Personal Data Protection Act, 2023. Built on top of WSO2 Identity Server,Solution provides consent management, grievance handling, consent audit history, and event notifications, along with a Consent Portal for end users and administrators.

This guide sets up the accelerator in a local environment with the default embedded H2 databases, so you can quickly try it out.

Setting up for production?

This quickstart is for local evaluation only. For a production deployment, follow Install and Set Up instead.

Prerequisites​

  1. Java Development Kit: JDK 21.
  2. Environment variables: set JAVA_HOME to the JDK 21 folder and add its bin folder to your PATH.
export JAVA_HOME="<JDK_LOCATION>"
export PATH=$JAVA_HOME/bin:$PATH
java -version

java -version should report version 21.

Install the base product​

Download WSO2 Identity Server 7.3.0 and extract the ZIP.

Install the accelerator​

Download the latest wso2-dpdpiam-accelerator-<version>.zip from the releases page. To build it from source instead, see the repository README.

Extract it, and copy the extracted wso2-dpdpiam-accelerator-<version> directory into the root directory of Identity Server.

The rest of this guide refers to the directories as follows:

DirectoryPlaceholder
Identity Server<IS_HOME>
DPDP Accelerator, inside <IS_HOME><DPDP_ACCELERATOR_HOME>

Apply updates​

The accelerator needs Identity Server at U2 update level 17 or later. A freshly downloaded Identity Server doesn't include the update tool yet, so get it first:

Go to <IS_HOME>/bin and run the setup script. It downloads the update tool that matches your operating system and processor into the same folder:

./update_tool_setup.sh

Then, in the same folder, run the update tool it downloaded:

./wso2update_linux        # ARM64: ./wso2update_linux_arm64

If the tool reports that it updated itself, run the same command again to update Identity Server.

For more information about WSO2 updates and the update tool, see updating WSO2 products.

Configure the accelerator​

Go to <IS_HOME>/<DPDP_ACCELERATOR_HOME>/bin and run the merge script, then the configure script:

./merge.sh
./configure.sh

Start the server​

Go to <IS_HOME>/bin and start Identity Server:

./wso2server.sh

Once the server starts, open the Console at https://localhost:9443/console and sign in with the default administrator account: username admin@wso2.com, password wso2123.

Set up portal users​

To fully try out the accelerator, create users and assign them these roles by following the Configuring Users and Roles

UserRoleWhat they can do in the portal
Portal administratordpdp-consent-adminManage purposes and elements, view and revoke any user's consents, view consent history, manage Event Notifications, and handle all complaints. Use this user to check the portal in the next step.
Data Principaldpdp-consent-userExercise their data protection rights: review the history of their consents, raise and track grievances, and delete their own account.
Data Protection Officerdpdp-consent-dpoView and respond to every complaint in the organization, without access to consents or other administration.

Open https://localhost:9443/consent-portal/ and sign in as the user holding dpdp-consent-admin.

Next steps​

  • Learn through real stories — see how the main features fit together from each participant's point of view
  • Try Out — walk through the catalog, consent lifecycle, complaint, and event flows
  • Install and Set Up — move to a production deployment with an external MySQL or PostgreSQL database