Other Articles

How to install Data Explorer?

Support > Data Explorer

8 January, 2026

Overview

Once installed, Data Explorer can scan your databases and identify sensitive information quickly, showing you what data needs protection as part of your compliance process.

This helps you find and classify personal data so it's properly protected and you have the records you need for audits and compliance reviews.

Prerequisites

  • You have access to your organization’s server where Data Explorer will be installed.
  • You have permission to install applications on the server (sudo access).
  • You have access to your organization’s Kawach Admin account.
  • You have valid database credentials (user ID and password) for the databases you want to scan.
  • The databases are accessible from the server where Data Explorer will be installed.

What Data Explorer Accesses

Data Explorer operates in a read-only scanning mode. It does not modify database contents, schemas, or configurations.

Once installed and configured, Data Explorer can:

  • Scan database tables and columns for sensitive data
  • Identify and classify Personally Identifiable Information (PII)
  • Detect data types including:
  • Name
  • Email address
  • Date of birth
  • Phone number
  • PAN (Permanent Account Number)
  • Aadhaar number
  • Race or ethnic origin
  • Genetic data
  • Health data
  • Geo-location data
  • Social Security Number (SSN)
  • Assess risk levels (High, Medium, Low) for identified data
  • Apply system-generated PII tags for compliance tracking

Steps to Set Up Data Explorer

  • Download the Data Explorer

    You can download the Data Explorer tool from:

    • Your Kawach Admin account under Privacy Management → Data Governance → Data Catalogue → Explorer Instructions
    • From the Instruction page, copy the scanner token.

Data Explorer – Installation & Setup Guide

Server Requirements

  • Linux server
  • sudo access
  • Database credentials (MySQL / PostgreSQL / SQL Server / MongoDB, etc.)
  • Scanner token from the Kawach Instructions page

Step 1: Download the Package

Download the data_explorer.tar.gz package provided by Kawach.

Step 2: Extract the Package 

tar -xzf data_explorer<version_number>.tar.gz

Step 3: Navigate to the Extracted Directory 

cd data_explorer_package

Step 4: Run the Installer 

sudo ./install.sh

Step 5: Configure the Application

During installation:

  1. Configuration File

    • If config.yaml does not exist, it will be automatically created from config.yaml.example.
    • When prompted, edit the configuration file.

    Update the following based on your environment:

    • Database host
    • Database port
    • Database name
    • Database username
    • Database password
    • Number of parallel database scans (adjust based on available RAM)

    Supported databases include:

    • MySQL
    • PostgreSQL
    • SQL Server
    • MongoDB

    Save and exit.

  2. Scanner Token Setup

    • The installer will ask for a scanner token.
    • Copy the token from the Kawach instruction page. (Privacy Management → Data Governance → Data Catalogue → Explorer Instructions )
    • Paste it when prompted and press Enter.

Step 6: Background Service & Scheduling

  • Data Explorer runs as a systemd service.
  • A systemd timer is configured automatically.
    • First scan runs 5 minutes after system boot.
    • Recurring scans run every 7 days.
  • No manual intervention is required.

Useful Commands

  • Edit configuration: 
    nano /path/to/data_explorer/config.yaml
  • Run a manual scan: 
    sudo systemctl start data-explorer.service
  • Check scan timer status: 
    sudo systemctl status data-explorer.timer
  • View logs: 
    sudo journalctl -u data-explorer.service -f

After the Setup

Once scanning is complete:

  • Sensitive data findings appear in Kawach → Privacy Management → Data Governance → Data Catalogue
  • Each data element is tagged with:
    • Data Type (Name, Email, PAN, Aadhaar, Genetic Data, etc.)
    • Risk Level (High / Medium / Low)
    • PII Tag (System-generated)
  • Users can review and edit detected data classifications directly in Kawach.

Troubleshooting

  • Connection issues

    Verify database credentials, ensure the server can reach the database host, and confirm the database user has read permissions.

  • Nano editor not found

    Use an alternative editor:
    vi config.yaml or vim config.yaml