Skip to content

Latest commit

 

History

History
101 lines (62 loc) · 3.49 KB

README.md

File metadata and controls

101 lines (62 loc) · 3.49 KB
Raw

CiviCRM Anonymizer

This extension is intended to anonymize your database, so you can share your CiviCRM DB more readily.

--

Moved!

Hello,

I have moved the project space for org.civicrm.contrib.anonymize to CiviCRM's Gitlab. This includes both the issue tracking and support, and merge requests.

The new URL is: https://lab.civicrm.org/xurizaemon/org.civicrm.contrib.anonymize

All issues have been migrated to: https://lab.civicrm.org/xurizaemon/org.civicrm.contrib.anonymize/issues

If you do not already have an account on CiviCRM's Gitlab, you can create an account by registering on https://civicrm.org/user

See #17 for discussion.

Thank you!

Terms of use

  • You're responsible for your data.
  • You're welcome to use this tool.
  • Don't do anything wrong-headed.
  • Contributions and input are welcome.

Do not install in production

This extension will ruin your production dataset if you use it there. Don't even install it on your live site.

No guarantee or warranty

There is no guarantee or warranty with this extension. If you've made a custom field which includes identifying or sensitive data then you cannot expect this extension to fully anonymize your DB. Sensitive data includes: credit cards, social security IDs, resumes, profile submissions. You need to be your own data expert here.

Contributions and complaints

  • Contributions are welcome via the GitHub project page. You know what to do. Bug reports are contributions.
  • Complaints are welcome! A NZD 150 processing fee is required in advance. Send NZD$150 to my PayPal account and I'll be in touch.

A note on the above

That was a little joke. If you want to participate in any way to making open source better, join us!

Installation

There's no release yet, which means you need to clone the git repo and then use composer install before the new API calls will work.

How to use

Congratulations, you made it past the pseudolegal boilerplate! Sorry if that freaked you out.

Examples below use cv, but you can of course use any CiviCRM API interface you prefer: drush, wp-cli, civicrm/api/explorer ...

Bulk anonymization

This command will anonymize the entire database, based on default settings.

cv api Database.anonymize

This next command will print all the SQL queries that would run, but it won't run them. If you like, you can pipe this output to mysql or redirect it to a file for running later.

cv api Database.anonymize --out=none dry-run=1

Here's a slower method of updating Individual contacts for the entire DB:

cv api -I Contact.get limit=0 contact_type=Individual | while read CID ; do cv api Contact.anonymize locale=en_NZ id=$CID ; done

Piecemeal anonymization

Anonymize a single contact

Use the Contact.anonymize API to anonymize a contact. Identify the target contact by id, eg

cv api Contact.anonymize id=1234

Anonymize an email or address

If you anonymize the related contact, this will happen automatically, but you can directly anonymize these entities also. The id here is the Email or Address id, not the parent entity.

cv api Email.anonymize id=12345

Locales

Some Anonymise methods accept a locale, so you can generate names and addresses that match your demographic.

cv api Contact.anonymize id=1234 locale=fr_FR