Skip to content
CLI to add a good default CORS configuration to CouchDB
JavaScript Shell
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore (#15) - fix CouchDB 2.0 Mar 20, 2016
.jshintrc working! Aug 22, 2014
.travis.yml chore(travis): whitelist greenkeeper branches Mar 7, 2017
LICENSE add license Oct 9, 2015
bin.js (#15) - fix CouchDB 2.0 Mar 20, 2016
index.js (#15) - fix CouchDB 2.0 Mar 20, 2016
package.json chore(package): update dependencies Mar 7, 2017
readme.md docs(readme): add Greenkeeper badge Mar 7, 2017
test.sh (#15) - fix CouchDB 2.0 Mar 20, 2016

readme.md

Add CORS to CouchDB Build Status

Greenkeeper badge

Summary

CouchDB doesn't come with CORS enabled by default. This is a problem for libraries like PouchDB, which depend on being able to access CouchDB no matter what URL it's being served from. This script fixes that.

Usage

You need to have Node.js and NPM installed. Then do:

npm install -g add-cors-to-couchdb
add-cors-to-couchdb

Or if it is a remote database:

add-cors-to-couchdb http://me.iriscouch.com -u myusername -p mypassword
Ubuntu - special instructions

On Ubuntu the default Node.js library is called nodejs instead of node due to a naming conflict. To run on Ubuntu, you'll need to do:

sudo apt-get install nodejs-legacy

What it does

This script will simply add some generic CORS configuration to your CouchDB. You could also do it yourself trivially using curl:

HOST=http://adminname:password@localhost:5984 # or whatever you got

curl -X PUT $HOST/_config/httpd/enable_cors -d '"true"'
curl -X PUT $HOST/_config/cors/origins -d '"*"'
curl -X PUT $HOST/_config/cors/credentials -d '"true"'
curl -X PUT $HOST/_config/cors/methods -d '"GET, PUT, POST, HEAD, DELETE"'
curl -X PUT $HOST/_config/cors/headers -d '"accept, authorization, content-type, origin, referer, x-csrf-token"'

You can always change the configuration later by simply going to http://localhost:5984/_utils/config.html and updating the values. However, these default options are good for getting up and running.

CouchDB 2.0+ instructions

This modules automatically detects CouchDB 2.0 and should do the right thing. But in case you need to configure CORS on a per-node basis, do:

curl -X GET $HOST/_membership

to see the list of available nodes, then do e.g.:

curl -X PUT $HOST/_node/node1@127.0.0.1/_config/httpd/enable_cors -d '"true"'
curl -X PUT $HOST/_node/node1@127.0.0.1/_config/cors/origins -d '"*"'
curl -X PUT $HOST/_node/node1@127.0.0.1/_config/cors/credentials -d '"true"'
curl -X PUT $HOST/_node/node1@127.0.0.1/_config/cors/methods -d '"GET, PUT, POST, HEAD, DELETE"'
curl -X PUT $HOST/_node/node1@127.0.0.1/_config/cors/headers -d '"accept, authorization, content-type, origin, referer, x-csrf-token"'
You can’t perform that action at this time.