stabrise/pdf-redaction-api repository overview

⁠PDF Redaction API: Self-Hosted & Secure Document Masking

Automate PII (Personally Identifiable Information) removal from PDF documents with a high-performance, self-hosted REST API. No data ever leaves your server.

The PDF Redaction API is a containerized solution designed for developers who need to protect sensitive data while maintaining total control over document privacy. It is ideal for GDPR, HIPAA, and CCPA compliance.

⁠🚀 Key Features

• Automated Sensitive Data Detection: Remove emails, credit card numbers, tax IDs (DNI/NIE), and phone numbers automatically.
• Deep Search & Custom Rules: Use predefined and custom rules.
• Total Data Privacy: Unlike cloud-based APIs, this Docker image runs on your infrastructure (on-premise). Your documents are never uploaded to the cloud.
• RESTful Architecture: Simple JSON-based API integration with any language (Python, JS, Go, PHP, etc.).

⁠🛠 Quick Start

⁠🚀 Instant Install self-hosted PDF Redaction API

• Option A (curl):

  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/StabRise/pdf-redaction-api/main/install.sh)"
  

  Copy

• Option B (wget):

  /bin/bash -c "$(wget -qO- https://raw.githubusercontent.com/StabRise/pdf-redaction-api/main/install.sh)"
  

  Copy

⁠Docker

To run the PDF Redaction API on your VPS using Docker, use the following command:

docker run -d -p 8002:8002 \
  -e PDF_REDACTION_API_LICENSE=your_key_here \
  stabrise/pdf-redaction-api:latest

⁠Docker Compose (Recommended)

For a professional setup with a persistent volume (best for your VPS setup):

services:
  pdf-api:
    image: stabrise/pdf-redaction-api:latest
    restart: unless-stopped
    ports:
      - "8002:8002"
    environment:
      - PDF_REDACTION_API_LICENSE=${PDF_REDACTION_API_LICENSE}

⁠📖 API Usage Example

Once the container is running, you can redact a document by sending a POST request to /redact:

curl -X POST http://localhost:8002/api/anonymize/pdf/ \
  -H "Content-Type: multipart/form-data" \
  -F "[email protected]"

For full documentation, visit: PDF Redaction API Docs⁠

⁠🔒 Security & Compliance

This image is designed for high-security environments:

• GDPR/CCPA Ready: Keep data inside your jurisdiction.
• Stateless Processing: Documents are processed in memory or temp volumes and are not stored permanently by the API.
• Resource Efficient: Optimized for VPS deployments with low memory overhead.

⁠💳 License

A valid license key is required to start the service. You can obtain a free trial or a commercial license at pdf-redaction.com⁠.