You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

79 lines
1.6 KiB
Markdown

11 years ago
couchmagick
===========
Run ImageMagicks `convert` on CouchDB documents.
Installation
------------
via npm:
```bash
npm install couchmagick -g
```
Daemon Configuration
--------------------
Add couchmagick to `os_daemons` config section:
11 years ago
```ini
[os_daemons]
couchmagick = couchmagick
```
Now CouchDB takes care of the couchmagick process.
```ini
[couchmagick]
; Optional username and password
username = mein-user
password = secure
; Number of simultanous processes. Default is 4
processes = 8
; Timeout in ms. Default is 10000
timeout = 1000
; Batch size. Default is 100
limit = 1000
```
Imagemagick Configuration
-------------------------
Add a `couchmagick` property to a design document. couchmagick will process all
databases which have such a design document.
```json
{
"_id": "_design/my-couchmagick-config",
"_rev": "1-a653b27246b01cf9204fa9f5dee7cc64",
"couchmagick": {
"filter": "function(doc) { return doc.type === 'post'; }",
"versions": {
"thumbnail": {
"filter": "function(doc, name) { return doc.display && doc.display.indexOf('overview') > -1; }",
"format": "jpg",
"id": "{id}/thumbnail",
"name": "{basename}-thumbnail.jpg",
"args": [
"-",
"-resize", "x100",
"-quality", "75",
"-colorspace", "sRGB",
"-strip",
"jpg:-"
]
}
}
}
}
11 years ago
```
See [couchmagick-stream](https://github.com/null2/couchmagick-stream) for available options;
11 years ago
Contributing
------------
Lint your code via `npm run jshint`.
License
-------
Copyright (c) 2012-2013 Johannes J. Schmidt, null2 GmbH
Licensed under the MIT license.