Skip to content

About

Self-hosted, distributed privacy platform that automates personal data removal through pluggable broker modules. Features zero-knowledge identity vaults, multi-tenant consortium ILS routing, distributed queue workers, and sandboxed plugin extensibility.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

19 stars

Watchers

0 watching

Forks

Latest commit

 

History

648 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

OpenOptOut Logo
OpenOptOut

Open-source personal data removal pipeline. Automated opt-out submission, confirmation tracking, and continuous defense against quiet data-broker re-listings.

License: AGPL v3 Data Brokers WCAG 2.2 AAA Languages

OpenOptOut is a free, self-hostable privacy automation platform built for two audiences from the same codebase:

  • Families — Single system with role-based access so parents can manage their children's data and spouses can coordinate removals together.
  • Institutions (libraries, schools, credit unions, non-profits) — White-label branding, SSO/LDAP/SIP2 authentication, patron self-service, PostgreSQL for scale, database encryption, and privacy reporting.

Our Mission: OpenOptOut is a stopgap. Having to hunt down brokers and beg for your own data is proof of a broken system. You should own your personal records by default. Read our full mission statement and library advocacy notes in docs/about/mission.md.


Features

  • 🛡️ Encrypted Identity Vault — Store all name variants, aliases, emails, phone numbers, and addresses in a zero-knowledge, encrypted vault.
  • 🔍 Automated Broker Discovery — Scan broker databases to pinpoint where your personal listings appear before filing removals.
  • ⚡ Pluggable Removal Engine — Execute opt-outs via declarative specs or sandboxed gRPC plugins with corporate parent-company batching.
  • 📬 Email Confirmation Tracking — Monitor a dedicated inbox via OAuth 2.0 or IMAP to match and verify incoming broker removal confirmations automatically.
  • 🔄 Continuous Re-Check Defense — Automatically re-verify and re-submit requests on a scheduled cadence so brokers cannot quietly re-list you.
  • 🏛️ Built for Scale & Institutions — Multi-branch partitioning with SIP2/ILS library card login, OIDC/SAML 2.0 SSO, distributed Redis priority workers, and PostgreSQL.
  • ♿ WCAG 2.2 AAA Accessible — High-contrast themes, dynamic font scaling (100%–150%), reduced motion safety, skip links, and full keyboard/screen-reader support.
  • 🔒 Defense-in-Depth Security — SQLCipher full-database encryption, Fernet field-level encryption, ephemeral memory zeroization, and container sandboxing.

Preview

Family Dashboard Identity Vault
Dashboard Identity Vault
Status overview across all family members Store name variants, addresses, phones, emails

Quick Start

Docker Compose (Recommended)

Docker Compose is the recommended deployment method. It provides strong defense-in-depth isolation, including CIS Docker Benchmark-hardened read-only root filesystems, unprivileged container execution (UID 1000), scoped ephemeral RAM tmpfs mounts for browser automation profiles, resource and PID ceilings, and sandboxed socket proxy mediation.

# 1. Clone repository
git clone https://github.com/rlnunez/OpenOptOut.git openoptout
cd openoptout

# 2. Create environment file
cp .env.example .env
chmod 600 .env

# 3. Start containers
docker compose up -d

# 4. Open http://localhost in your browser
#    The first registered user automatically becomes the Super Admin and enters the Setup Wizard.

Upon first sign-in, the Setup Wizard presents a top-level mode switch:

  • Express Setup: Zero-touch defaults for home users (SQLite, local/managed HTTPS, deferred email).
  • Advanced Setup: Granular control (PostgreSQL, custom reverse proxies, mail transports, branding).

The master SECRET_KEY is showcased with masked verification, 1-click clipboard copy, and an interactive entropy mixer for custom randomness.

For real production deployments accessible over a network, always enable HTTPS before inviting users. See docs/admin/https.md.

Automated One-Line Install

For an automated setup script that detects your environment and configures keys:

curl -fsSL https://raw.githubusercontent.com/rlnunez/OpenOptOut/main/install.sh | sh -s -- --docker
  • Uses Docker Compose when passed --docker (recommended for container isolation).
  • Falls back to a native bare-metal install (systemd + nginx, no containers) on Debian/Ubuntu systems without Docker via | sh -s -- --native.
  • Safe to re-run: updates an existing checkout without overwriting .env configuration. Run install.sh --help for all options.

Hardware Sizing

OpenOptOut uses Playwright Firefox for memory hygiene and zero-disk-leak automation:

  • Family / Small Community (Standalone): 1 vCPU, 1 GB RAM (2 GB recommended), 10 GB disk, 512 MB tmpfs.
  • Library / Institutional Worker Node (4 slots): 2–4 vCPU, 2–4 GB RAM, 15–30 GB disk, 1 GB tmpfs.

For empirical benchmark data, multi-slot scaling profiles, and capacity formulas, see docs/admin/hardware-sizing.md.


Documentation

OpenOptOut documentation is organized by reader audience and powered by MkDocs:


Community & Contributing

We welcome community contributions, particularly:

  • Security & Architectural Reviews — Review our sandboxing, cryptography, and auth architecture (see CONTRIBUTING.md).
  • Broker Selectors & Plugins — Map new broker form selectors or build gRPC plugins to expand coverage (see broker-plugins/README.md).
  • Accessibility Enhancements — Verify workflows with screen readers and assistive devices (see ACCESSIBILITY.md).
  • Bug Reports & Test Cases — Help strengthen reliability across platforms.

All community members and contributors are expected to uphold our CODE_OF_CONDUCT.md.


License & Disclaimer

GNU Affero General Public License v3.0 (AGPL-3.0). Copyright © 2026 Robert Nunez.

You are free to use, study, modify, and self-host this software. If you run a modified version as a network service, you must make your modified source code available to users of that service. See LICENSE for the complete license terms.

OpenOptOut builds on the work of volunteers and other open-source projects. See CREDITS.md for who they are and how their work is used.

Disclaimer: OpenOptOut submits opt-out requests on your behalf but cannot guarantee compliance from third-party data brokers. Re-check your listings periodically. OpenOptOut is not a legal service and does not provide legal advice.

About

Self-hosted, distributed privacy platform that automates personal data removal through pluggable broker modules. Features zero-knowledge identity vaults, multi-tenant consortium ILS routing, distributed queue workers, and sandboxed plugin extensibility.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

19 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages