agrueneberg / Vacuum

A CouchApp that makes a CouchDB database read-only for readers and anonymous users.

Vacuum

Vacuum is a CouchApp that makes a CouchDB database read-only for readers and anonymous users.

Example

Replication

To prevent Vacuum from making a replicated database read-only, use filtered replication:

curl\
  -X POST\
  -H "Content-Type:application/json"\
  -d "{\"source\":\"http://<some_host>/<some_vacuum_db>\",\
       \"target\":\"http://localhost:5984/<your_db>\",\
       \"filter\":\"vacuum/rw\"}"\
  http://localhost:5984/_replicate

Installation

Clone this repository and use CouchApp to push Vacuum to <your_host>/<your_db>:

git clone https://github.com/agrueneberg/Vacuum.git
couchapp push Vacuum/ http://<your_host>/<your_db>

Alternatively, replicate an existing deployment of Vacuum to <your_host>/<your_db> using curl:

curl\
  -X POST\
  -H "Content-Type:application/json"\
  -d "{\"source\":\"https://couchdb.gutpassfilter.de/vacuum\",\
       \"target\":\"http://<your_host>/<your_db>\"}"\
  http://localhost:5984/_replicate