├── .gitignore ├── .jshintrc ├── .travis.yml ├── LICENSE ├── bin.js ├── index.js ├── package.json ├── readme.md └── test.sh /.gitignore: -------------------------------------------------------------------------------- 1 | ### Node template 2 | # Logs 3 | logs 4 | *.log 5 | npm-debug.log* 6 | 7 | # Runtime data 8 | pids 9 | *.pid 10 | *.seed 11 | 12 | # Directory for instrumented libs generated by jscoverage/JSCover 13 | lib-cov 14 | 15 | # Coverage directory used by tools like istanbul 16 | coverage 17 | 18 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 19 | .grunt 20 | 21 | # node-waf configuration 22 | .lock-wscript 23 | 24 | # Compiled binary addons (http://nodejs.org/api/addons.html) 25 | build/Release 26 | 27 | # Dependency directory 28 | # https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git 29 | node_modules 30 | 31 | # Created by .ignore support plugin (hsz.mobi) -------------------------------------------------------------------------------- /.jshintrc: -------------------------------------------------------------------------------- 1 | { 2 | "maxlen": 80, 3 | "curly": true, 4 | "eqeqeq": true, 5 | "immed": true, 6 | "newcap": true, 7 | "noarg": true, 8 | "sub": true, 9 | "undef": true, 10 | "unused": "vars", 11 | "eqnull": true, 12 | "browser": true, 13 | "node": true, 14 | "strict": true, 15 | "trailing": true, 16 | "globalstrict": true, 17 | "globals": { 18 | "PouchDB": true, 19 | "should": true 20 | }, 21 | "white": true, 22 | "indent": 2, 23 | "forin": true, 24 | "predef": [ 25 | "describe", 26 | "it", 27 | "after", 28 | "beforeEach", 29 | "afterEach", 30 | "testUtils", 31 | "emit" 32 | ] 33 | } 34 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | 3 | node_js: 4 | - "stable" 5 | 6 | services: 7 | - docker 8 | 9 | git: 10 | depth: 30 11 | 12 | sudo: 13 | false 14 | 15 | before_install: 16 | 17 | # Install CouchDB Stable 18 | - docker run -d -p 3000:5984 klaemo/couchdb:1.6.1 19 | 20 | # Install CouchDB Master 21 | - docker run -d -p 3001:5984 klaemo/couchdb:2.0-dev --with-haproxy --with-admin-party-please -n 1 22 | 23 | # get the assert.sh framework 24 | - wget https://raw.github.com/lehmannro/assert.sh/v1.1/assert.sh 25 | 26 | - sleep 10 27 | 28 | before_script: 29 | - "export DISPLAY=:99.0" 30 | - "sh -e /etc/init.d/xvfb start" 31 | 32 | script: 33 | - "./test.sh" 34 | 35 | branches: 36 | only: 37 | - master 38 | - /^greenkeeper/.*$/ 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /bin.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 'use strict'; 3 | var addCorsToCouch = require('./'); 4 | var yargs = require('yargs') 5 | .alias('p', 'password') 6 | .describe('p', 'your password') 7 | .alias('u', 'username') 8 | .describe('u', 'your username') 9 | .alias('h', 'help') 10 | .describe('h', 'this help') 11 | .version(require('./package.json').version, 'v') 12 | .alias('v', 'version') 13 | .usage('\nUsage:\n $0 [url] [options]') 14 | .example('$0', 'update couch at http://127.0.0.1:5984') 15 | .example('$0 http://example.com -u username -p password', 'update with auth'); 16 | var argv = yargs.argv; 17 | if (argv.h) { 18 | yargs.showHelp(); 19 | return process.exit(0); 20 | } 21 | 22 | var auth; 23 | if (argv.p && argv.u) { 24 | auth = argv.u + ':' + argv.p; 25 | } 26 | var url = argv._[0] || 'http://127.0.0.1:5984'; 27 | addCorsToCouch(url, auth).then(function () { 28 | console.log('success'); 29 | process.exit(0); 30 | }).catch(function (err) { 31 | console.log(err); 32 | process.exit(1); 33 | }); -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var fetch = require('node-fetch'); 3 | var url = require('url'); 4 | var Promise = require('lie'); 5 | 6 | var requests = [ 7 | { 8 | path: '/_config/httpd/enable_cors', 9 | value: '"true"' 10 | }, 11 | { 12 | path: '/_config/cors/origins', 13 | value: '"*"' 14 | }, 15 | { 16 | path: '/_config/cors/credentials', 17 | value: '"true"' 18 | }, 19 | { 20 | path: '/_config/cors/methods', 21 | value: '"GET, PUT, POST, HEAD, DELETE"' 22 | }, 23 | { 24 | path: '/_config/cors/headers', 25 | value: '"accept, authorization, content-type, origin, referer, x-csrf-token"' 26 | } 27 | ]; 28 | 29 | function formatUrl(baseUrl, auth, path) { 30 | var urlObject = url.parse(baseUrl + path); 31 | 32 | if (auth) { 33 | urlObject.auth = auth; 34 | } 35 | 36 | return url.format(urlObject); 37 | } 38 | 39 | function updateConfig(urlString, value) { 40 | return fetch(urlString, {method: 'PUT', body: value}).then(function (resp) { 41 | if (resp.status === 200) { 42 | return; 43 | } 44 | return resp.text().then(function (text) { 45 | throw new Error('status ' + resp.status + ' ' + text); 46 | }); 47 | }); 48 | } 49 | 50 | function doCouch1(baseUrl, auth) { 51 | return Promise.all(requests.map(function (req) { 52 | var urlString = formatUrl(baseUrl, auth, req.path); 53 | return updateConfig(urlString, req.value); 54 | })); 55 | } 56 | 57 | function doCouch2(baseUrl, auth, membershipResp) { 58 | // do the Couch1 logic for all cluster_nodes 59 | // see https://github.com/klaemo/docker-couchdb/issues/42#issuecomment-169610897 60 | return membershipResp.json().then(function (members) { 61 | return Promise.all(members.cluster_nodes.map(function (node) { 62 | return Promise.all(requests.map(function (req) { 63 | var path = '/_node/' + node + '/' + req.path; 64 | var urlString = formatUrl(baseUrl, auth, path); 65 | return updateConfig(urlString, req.value); 66 | })); 67 | })); 68 | }); 69 | } 70 | 71 | function addCors(baseUrl, auth) { 72 | // check if we're dealing with couch 1 or couch 2 73 | var urlString = formatUrl(baseUrl, auth, '/_membership'); 74 | return fetch(urlString).then(function (resp) { 75 | if (resp.status !== 200) { 76 | return doCouch1(baseUrl, auth); 77 | } else { 78 | return doCouch2(baseUrl, auth, resp); 79 | } 80 | }); 81 | } 82 | module.exports = addCors; -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "add-cors-to-couchdb", 3 | "version": "0.0.6", 4 | "description": "add CORS to couchdb", 5 | "main": "index.js", 6 | "repository": { 7 | "type": "git", 8 | "url": "git://github.com/pouchdb/add-cors-to-couchdb.git" 9 | }, 10 | "keywords": [ 11 | "cors", 12 | "couchdb", 13 | "pouchdb" 14 | ], 15 | "author": "Calvin W. Metcalf", 16 | "license": "Apache-2.0", 17 | "bugs": { 18 | "url": "https://github.com/pouchdb/add-cors-to-couchdb/issues" 19 | }, 20 | "homepage": "https://github.com/pouchdb/add-cors-to-couchdb", 21 | "dependencies": { 22 | "lie": "^3.0.2", 23 | "node-fetch": "^1.4.0", 24 | "yargs": "^7.0.1" 25 | }, 26 | "bin": "./bin.js", 27 | "files": [ 28 | "bin.js", 29 | "index.js" 30 | ] 31 | } 32 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | Add CORS to CouchDB [![Build Status](https://travis-ci.org/pouchdb/add-cors-to-couchdb.svg?branch=master)](https://travis-ci.org/pouchdb/add-cors-to-couchdb) 2 | ==== 3 | 4 | [![Greenkeeper badge](https://badges.greenkeeper.io/pouchdb/add-cors-to-couchdb.svg)](https://greenkeeper.io/) 5 | 6 | #### Summary 7 | 8 | CouchDB doesn't come with [CORS](https://en.wikipedia.org/wiki/Cross-Origin_Resource_Sharing) enabled by default. This is a problem for libraries like [PouchDB](http://pouchdb.com), which depend on being able to access CouchDB no matter what URL it's being served from. This script fixes that. 9 | 10 | #### Usage 11 | 12 | You need to have [Node.js and NPM](https://nodejs.org) installed. Then do: 13 | 14 | ``` 15 | npm install -g add-cors-to-couchdb 16 | add-cors-to-couchdb 17 | ``` 18 | 19 | Or if it is a remote database: 20 | 21 | ``` 22 | add-cors-to-couchdb http://me.iriscouch.com -u myusername -p mypassword 23 | ``` 24 | 25 | ##### Ubuntu - special instructions 26 | 27 | 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: 28 | 29 | ``` 30 | sudo apt-get install nodejs-legacy 31 | ``` 32 | 33 | #### What it does 34 | 35 | This script will simply add some generic CORS configuration to your CouchDB. You could also do it yourself trivially using `curl`: 36 | 37 | ```bash 38 | HOST=http://adminname:password@localhost:5984 # or whatever you got 39 | 40 | curl -X PUT $HOST/_config/httpd/enable_cors -d '"true"' 41 | curl -X PUT $HOST/_config/cors/origins -d '"*"' 42 | curl -X PUT $HOST/_config/cors/credentials -d '"true"' 43 | curl -X PUT $HOST/_config/cors/methods -d '"GET, PUT, POST, HEAD, DELETE"' 44 | curl -X PUT $HOST/_config/cors/headers -d '"accept, authorization, content-type, origin, referer, x-csrf-token"' 45 | ``` 46 | 47 | You can always change the configuration later by simply going to [http://localhost:5984/_utils/config.html](http://localhost:5984/_utils/config.html) and updating the values. However, these default options are good for getting up and running. 48 | 49 | #### CouchDB 2.0+ instructions 50 | 51 | This modules automatically detects CouchDB 2.0 and should do the right thing. But in case 52 | you need to configure CORS on a per-node basis, do: 53 | 54 | ```bash 55 | curl -X GET $HOST/_membership 56 | ``` 57 | 58 | to see the list of available nodes, then do e.g.: 59 | 60 | ```bash 61 | curl -X PUT $HOST/_node/node1@127.0.0.1/_config/httpd/enable_cors -d '"true"' 62 | curl -X PUT $HOST/_node/node1@127.0.0.1/_config/cors/origins -d '"*"' 63 | curl -X PUT $HOST/_node/node1@127.0.0.1/_config/cors/credentials -d '"true"' 64 | curl -X PUT $HOST/_node/node1@127.0.0.1/_config/cors/methods -d '"GET, PUT, POST, HEAD, DELETE"' 65 | curl -X PUT $HOST/_node/node1@127.0.0.1/_config/cors/headers -d '"accept, authorization, content-type, origin, referer, x-csrf-token"' 66 | ``` 67 | -------------------------------------------------------------------------------- /test.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # run wget https://raw.github.com/lehmannro/assert.sh/v1.1/assert.sh 4 | # to get this 5 | 6 | . assert.sh 7 | 8 | # CouchDB 1 9 | 10 | assert "./bin.js http://127.0.0.1:3000" "success" 11 | assert "curl http://127.0.0.1:3000/_config/cors/credentials" '"true"' 12 | assert "curl http://127.0.0.1:3000/_config/cors/origins" '"*"' 13 | 14 | # CouchDB 2 15 | 16 | assert "./bin.js http://127.0.0.1:3001" "success" 17 | assert "curl http://127.0.0.1:3001/_node/node1@127.0.0.1/_config/cors/credentials" '"true"' 18 | assert "curl http://127.0.0.1:3001/_node/node1@127.0.0.1/_config/cors/origins" '"*"' 19 | 20 | assert_end suite --------------------------------------------------------------------------------