Replicating Production Data Locally

How to copy data from an instance to a local CouchDB database and app

Sometimes there will be a production problem that you need to dig into locally to solve. This guide explains how to:

  • Copy the data from an instance to a local CouchDB database
  • Run a local webapp instance with that data

First, a note about data safety

Production data is medical data. It’s HIV statuses and pregnancies. It’s important, and it’s not yours. If you’re downloading it, do so on an encrypted drive and delete it once you’re done with it.

Step 1: Get the data

First thing is to get the data onto your local CouchDB. It’s advisable to create a new DB for this, so that you have a fresh untouched collection of data that isn’t mixed in with anything you have locally.

Small production instances

If there isn’t much data you can replicate the entire DB locally. You can initiate this either from your local Fauxton, or from the command line. You must use an administrator username and password for this at both the source and destination.

For Fauxton, navigate to http://localhost:5984/_utils/#/replication/_create For command line, see:

Note that replication may stall on one document, and you may end up with your local DB having one less document than the source. This is due to how our URLs are setup: the replicator gets confused and considers login (ie https://url/login) to be a document. You can safely ignore this difference - you’re good to go once your destination database has one less document than the source.

Large production instances

If the instance is too large to replicate locally (or you are too impatient), you can replicate the data accessible to a single user. This process downloads a user’s data into a browser and then copies that data into a CouchDB database.

  1. Open Firefox and navigate to about:config. Set security.csp.enable to false to disable Content Security Policies.
  2. Navigate to the instance and login as the user with the data you want. (If you want more data, like an entire district, you could consider logging in as a new user with a contact document at your desired place in the contact hierarchy. But that is an exercise for the reader)
  3. Wait for the data to replicate. You know this is done once the app lets you interact with it. (If you want to get the user’s data before purging, consider disabling purging. Another exercise for the reader)
  4. Make sure your local CouchDB has CORS enabled: Consider using add-cors-to-couchdb or its recommended settings.
  5. Allow your CouchDB to be accessible via https. One way is to run ngrok http PORT. The PORT (5984 by default) can be found in database configuration using fauxton under the chttpd section. This will make your CouchDB accessible via a url like
  6. Open the console in Firefox and run await PouchDB.replicate('medic-user-XXX', '');. Here XXX is the name you logged in as, and YYY is the name of a database in which to store the data.
    • Note: If you get 401s make sure that: your CouchDB credentials are right; and you don’t have a local session in the same browser already (session cookies can take precedence over basic auth); and if you’re running CouchDB in Docker you have exposed both 5984 and 5986 to localhost.
  7. Wait for the replication to complete. In Fauxton you should see the database YYY with the same number of documents reported during the user’s initial replication.
  8. Log out of the instance and clear your data from the developer console (Application -> Clear storage).
  9. Navigate to about:config. Set security.csp.enable to true to re-enable Content Security Policies.

Regardless, do this too

To log in as a specific prod user you need to also copy them from the prod _users database into your own local _users database. The simplest way to do this is to just open the DB in Fauxton, find the document and copy it on your clipboard, then create a new document in your local _users DB and paste it in, deleting the _rev property.

You could also use this opportunity to change the password to something easier to work with locally. To do this, add a password property into the document with the password you want in plain text. CouchDB will convert this to a properly hashed password on save.

Step 2, run it locally

First you need to decide if you need a local development environment (unless you already have one, in which case you might as well use it), or are happy to just use Horticulturalist.

A local development environment will be useful to you if:

  • You want to change code locally
  • You want to see useful, non-minified stack traces, or otherwise browse / step through non-minified code in the browser
  • You want to deploy a version of the code older than 2.14.0, as they are not available in Horticulturalist’s repos.

Option 1, local development environment

If you don’t already have a local dev env, follow the instructions on the development setup instructions.

Then you need to:

  1. Push the code you want to run via COUCH_URL=http://your:admin@localhost:5984/YYY npm run build-dev.
  2. Start API and Sentinel by running COUCH_URL=http://your:admin@localhost:5984/YYY node api/server.

Once you’ve done all of that you should be able to log in with your user.

Option 2, horticulturalist

Follow the instructions on the horticulturalist repo to get it installed. Then:

  1. Make sure that the medic DB doesn’t exist, so that you have a fresh database.
  2. Replicate your local PROD DB into a new medic database using the Fauxton console.
  3. Run horti --local --bootstrap=XXX, where XXX is the version you want to use (maybe the same one as production?)

You should now be able to log in as that user locally!

CHT Applications > Quick Guides > Performance > Replication

Settings for downloading copies of data onto a user’s device.

Last modified 21.08.2023: feat: remove grunt (c38caa1d)