OpenRedaction Documentation

Welcome to the OpenRedaction documentation. OpenRedaction is an open-source PII (Personally Identifiable Information) detection and redaction library built on regex-first patterns.

What is OpenRedaction?

OpenRedaction is a regex-first PII redaction engine that:

Detects PII using 500+ tested regex patterns
Redacts sensitive data with configurable strategies
Context-aware with proximity rules and confidence scoring
Self-hostable for complete privacy and control
Open source and free to use

Quick Start

npm install openredaction

import { OpenRedaction } from 'openredaction';
 
const redactor = new OpenRedaction();
const text = "My name is John Doe and my email is john@example.com";
const result = await redactor.detect(text);
console.log(result.redacted);

Key Features

Regex-first detection - Transparent, deterministic, and fast
Context-aware - Proximity rules and multi-pass detection
Self-hostable - Run entirely on your infrastructure
Privacy-first - No data leaves your environment by default
GDPR/HIPAA/CCPA ready - Built for compliance

Next Steps

Getting Started - Install and configure OpenRedaction
Tutorials - Real-world use cases and step-by-step guides
Examples - Code examples and use cases
Self Hosting - Deploy on your own infrastructure
Security & Compliance - Security practices and compliance information
Changelog - Version history and release notes

Resources

Getting Started