veilstream/veilstream-postgres-proxy repository overview

⁠veilstream Proxy

A PostgreSQL data hygiene proxy that sits between your application and database to obfuscate sensitive data before it reaches your application.

⁠Overview

veilstream Proxy is designed to help you comply with data privacy regulations such as GDPR, HIPAA, and others. It protects sensitive data from unauthorized access by developers, contractors, or other third parties by automatically obfuscating data at the database connection level.

⁠Quick Start

⁠Without API Key (Local Mode)

The proxy can run without an API key using local file-based configuration:

docker pull veilstream/veilstream-postgres-proxy:latest
docker run -d \
  -e DATABASE_URI="postgresql://user:pass@host:5432/dbname" \
  -e ENABLE_ANONYMOUS_USAGE_REPORTS="true" \
  -v /path/to/config:/veilstream \
  -p 5432:5432 \
  -p 8683:8683 \
  veilstream/veilstream-postgres-proxy:latest

⁠With API Key (Managed Mode)

docker pull veilstream/veilstream-postgres-proxy:latest
docker run -d \
  -e DATABASE_URI="postgresql://user:pass@host:5432/dbname" \
  -e VEILSTREAM_API_KEY="your-api-key" \
  -p 5432:5432 \
  -p 8683:8683 \
  veilstream/veilstream-postgres-proxy:latest

⁠Configuration

⁠Required Environment Variables

• DATABASE_URI - PostgreSQL connection string to your source database

⁠Optional Environment Variables

• VEILSTREAM_API_KEY - Your veilstream API key for configuration management. Optional: If not provided, the proxy runs in local file-based configuration mode. Use API key mode for centralized rule management through the veilstream dashboard, or local mode for self-hosted deployments with file-based configuration.
• VEILSTREAM_API_URL - API endpoint (default: https://api.veilstream.com)
• ENABLE_ANONYMOUS_USAGE_REPORTS - Enable anonymous usage statistics reporting (default: false). When set to true, the proxy will periodically send anonymous usage statistics including rule counts (number of conditions and actions per rule) and a SHA256 hash of your database connection URI as a unique identifier. This helps us improve the product and understand usage patterns. All data is anonymized and no sensitive information is transmitted.

⁠Ports

• 5432 - PostgreSQL proxy port (connect your application here)
• 80 - HTTP health check endpoint
• 8683 - Dashboard server (optional)

⁠How It Works

veilstream Proxy intercepts PostgreSQL queries and responses, applying data obfuscation rules configured either through the veilstream API (when using an API key) or via local file-based configuration (when running without an API key). Your application connects to the proxy instead of directly to the database, and the proxy transparently applies data hygiene rules.

⁠Documentation

For detailed documentation, examples, and configuration options, visit:

• GitHub Repository⁠
• veilstream Documentation⁠

⁠Support

For issues, questions, or contributions, please visit our GitHub repository⁠.