Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jo/couchdb-secure

Write couchdb security object from file or directory.
https://github.com/jo/couchdb-secure

Last synced: about 1 month ago
JSON representation

Write couchdb security object from file or directory.

Awesome Lists containing this project

README

        

# CouchDB Secure
Write couchdb security object from file or directory.

## API

```js
secure(url, source[, options], callback)
```

* `url` - CouchDB database URL
* `source` - Can be a Couchapp Directory Tree, JSON file or CommonJS/Node module. Please see [couchdb-compile](https://github.com/jo/couchdb-compile) for in depth information about source handling.
* `callback` - called when done with a `response` object describing the status of all operations.

### Example

```js
var secure = require('couchdb-secure')
secure('http://localhost:5984/mydb', 'couchdb/security.json', function(error, response) {
// here we go
})
```

## CLI

```sh
couchdb-secure URL [SOURCE]
```

When `SOURCE` is omitted, the current directory will be used.

### Example
```sh
couchdb-secure http://localhost:5984/mydb couchdb/security.json
```

## Tests
```sh
npm test
```